-
-
Notifications
You must be signed in to change notification settings - Fork 51
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
docs: add docs for AppDatePickerInput
Signed-off-by: Rong Sen Ng (motss) <wes.ngrongsen@gmail.com>
- Loading branch information
Showing
3 changed files
with
69 additions
and
8 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,65 @@ | ||
# AppDatePickerInput | ||
|
||
![date-picker-inputs-in-different-themes](https://user-images.githubusercontent.com/10607759/158064167-2b06d9ac-1e31-41b8-803e-2a8e3769b8e3.png) | ||
|
||
|
||
|
||
## Properties | ||
|
||
It includes all properties from [AppDatePicker](app-date-picker-properties-url) and some of the properties from [MwcTextfield](mwc-textfield-properties-url). | ||
|
||
| Property | Type | Default | Description | | ||
| --- | --- | --- | --- | | ||
| `clearLabel` | [String] | `Clear` | Text label for the clear icon button. | | ||
|
||
|
||
|
||
## Methods | ||
|
||
This includes all the methods from [MwcTextfield](mwc-textfield-methods-url). | ||
|
||
| Method | Returns | Description | | ||
| --- | --- | --- | | ||
| `closePicker` | | Hide the picker. | | ||
| `reset` | | Reset the textfield's `value`. | | ||
| `showPicker` | | Show the picker. | | ||
|
||
|
||
|
||
## Events | ||
|
||
It includes all the events from [AppDatePicker](app-date-picker-events-url) and all from [MwcMenu](mwc-menu-events-url) except that the event target is `app-date-picker-input`. | ||
|
||
|
||
|
||
## CSS Custom Properties | ||
|
||
It includes all the CSS Custom properties from [AppDatePicker](app-date-picker-css-custom-properties-url) and all from [MwcTextfield](mwc-textfield-css-custom-properties-url). | ||
|
||
| Property | Default | Description | | ||
| --- | --- | --- | | ||
| `--date-picker-input-icon` | `rgba(0, 0, 0, .54)` | Color of the reset icon button. | | ||
|
||
|
||
## CSS Shadow Parts | ||
|
||
It includes all the CSS Shadow Parts from [AppDatePicker](app-date-picker-css-shadow-parts-url). | ||
|
||
|
||
|
||
<!-- References --> | ||
[1970-01-01]: https://en.wikipedia.org/wiki/Epoch_(computing) | ||
[app-date-picker-css-custom-properties-url]: /docs/app-date-picker.md#css-custom-properties | ||
[app-date-picker-events-url]: /docs/app-date-picker.md#events | ||
[app-date-picker-properties-url]: /docs/app-date-picker.md#properties | ||
[app-date-picker-css-shadow-parts-url]: /docs/app-date-picker.md#css-shadow-parts | ||
[mwc-textfield-properties-url]: https://github.com/material-components/material-web/tree/master/packages/textfield#propertiesattributes | ||
[mwc-textfield-methods-url]: https://github.com/material-components/material-web/tree/master/packages/textfield#methods | ||
[mwc-menu-events-url]: https://github.com/material-components/material-web/tree/master/packages/menu#events | ||
[mwc-textfield-css-custom-properties-url]: https://github.com/material-components/material-web/tree/master/packages/textfield#css-custom-properties | ||
|
||
<!-- MDN references --> | ||
[Boolean]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Boolean | ||
[Date]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date | ||
[Number]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number | ||
[String]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters