Skip to content

Commit

Permalink
docs: update docs
Browse files Browse the repository at this point in the history
  • Loading branch information
@mlmoravek
mlmoravek committed Dec 6, 2024
1 parent 205166e commit 0cbe16f
Show file tree
Hide file tree
Showing 6 changed files with 46 additions and 64 deletions.
4 changes: 2 additions & 2 deletions packages/docs/components/Datepicker.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -43,6 +43,7 @@
| creator | Date creator function, default is `new Date()` | (() =&gt; Date) | - | <div><small>From <b>config</b>:</small></div><code style='white-space: nowrap; padding: 0;'>datepicker: {<br>&nbsp;&nbsp;creator: undefined<br>}</code> |
| customValidity | Custom HTML 5 validation error to set on the form control | string \| ((currentValue: Date \| [] \| Date[] \| [Date, Date] \| null , state: ValidityState) =&gt; string) \| undefined | - | <code style='white-space: nowrap; padding: 0;'>""</code> |
| dayNames | Set custom day names, else use names based on locale | string[] | - | <div><small>From <b>config</b>:</small></div><code style='white-space: nowrap; padding: 0;'>datepicker: {<br>&nbsp;&nbsp;dayNames: undefined<br>}</code> |
| desktopModal | Dropdown content is shown into a modal on desktop | boolean | - | <div><small>From <b>config</b>:</small></div><code style='white-space: nowrap; padding: 0;'>datepicker: {<br>&nbsp;&nbsp;desktopModal: false<br>}</code> |
| disabled | Same as native disabled | boolean | - | <code style='white-space: nowrap; padding: 0;'>false</code> |
| events | Events to display on picker | DatepickerEvent[] | - | |
| expanded | Makes input full width when inside a grouped or addon field | boolean | - | <code style='white-space: nowrap; padding: 0;'>false</code> |
Expand All @@ -61,7 +62,7 @@
| maxDate | Max date to select | Date | - | |
| minDate | Min date to select | Date | - | |
| mobileBreakpoint | Mobile breakpoint as `max-width` value | string | - | <div><small>From <b>config</b>:</small></div><code style='white-space: nowrap; padding: 0;'>datepicker: {<br>&nbsp;&nbsp;mobileBreakpoint: undefined<br>}</code> |
| mobileModal | Enable dropdown mobile modal | boolean | - | <div><small>From <b>config</b>:</small></div><code style='white-space: nowrap; padding: 0;'>datepicker: {<br>&nbsp;&nbsp;mobileModal: true<br>}</code> |
| mobileModal | Dropdown content is shown into a modal on mobile | boolean | - | <div><small>From <b>config</b>:</small></div><code style='white-space: nowrap; padding: 0;'>datepicker: {<br>&nbsp;&nbsp;mobileModal: true<br>}</code> |
| mobileNative | Enable mobile native input if mobile agent | boolean | - | <div><small>From <b>config</b>:</small></div><code style='white-space: nowrap; padding: 0;'>datepicker: {<br>&nbsp;&nbsp;mobileNative: false<br>}</code> |
| v-model | The input value state, use v-model to make it two-way binding | [] \| [Date, Date] \| Date \| Date[] | - | |
| monthNames | Set custom month names, else use names based on locale | string[] | - | <div><small>From <b>config</b>:</small></div><code style='white-space: nowrap; padding: 0;'>datepicker: {<br>&nbsp;&nbsp;monthNames: undefined<br>}</code> |
Expand All @@ -81,7 +82,6 @@
| showWeekNumber | Show week numbers | boolean | - | <div><small>From <b>config</b>:</small></div><code style='white-space: nowrap; padding: 0;'>datepicker: {<br>&nbsp;&nbsp;showWeekNumber: false<br>}</code> |
| size | Size of the control input | string | `small`, `medium`, `large` | <div><small>From <b>config</b>:</small></div><code style='white-space: nowrap; padding: 0;'>datepicker: {<br>&nbsp;&nbsp;size: undefined<br>}</code> |
| teleport | Append the component to another part of the DOM.<br/>Set `true` to append the component to the body.<br/>In addition, any CSS selector string or an actual DOM node can be used. | boolean \| object \| string | - | <div><small>From <b>config</b>:</small></div><code style='white-space: nowrap; padding: 0;'>datepicker: {<br>&nbsp;&nbsp;teleport: false<br>}</code> |
| trapFocus | Trap dropdown on focus | boolean | - | <div><small>From <b>config</b>:</small></div><code style='white-space: nowrap; padding: 0;'>datepicker: {<br>&nbsp;&nbsp;trapFocus: true<br>}</code> |
| type | Define picker mode | "date" \| "month" | `date`, `month` | <code style='white-space: nowrap; padding: 0;'>"date"</code> |
| unselectableDates | Define a list of dates which can not be selected | Date[] \| ((date: Date) =&gt; boolean) | - | |
| unselectableDaysOfWeek | Define a list of weeks which can not be selected | number[] | - | <div><small>From <b>config</b>:</small></div><code style='white-space: nowrap; padding: 0;'>datepicker: {<br>&nbsp;&nbsp;unselectableDaysOfWeek: undefined<br>}</code> |
Expand Down
2 changes: 1 addition & 1 deletion packages/docs/components/Taginput.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@
| ------------------ | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| allowDuplicates | Allows adding the same item multiple time | boolean | - | <div><small>From <b>config</b>:</small></div><code style='white-space: nowrap; padding: 0;'>taginput: {<br>&nbsp;&nbsp;allowDuplicates: false<br>}</code> |
| allowNew | Allows adding new items | boolean | - | <div><small>From <b>config</b>:</small></div><code style='white-space: nowrap; padding: 0;'>taginput: {<br>&nbsp;&nbsp;allowNew: false<br>}</code> |
| ariaCloseLabel | Accessibility label for the close button | string | - | <div><small>From <b>config</b>:</small></div><code style='white-space: nowrap; padding: 0;'>taginput: {<br>&nbsp;&nbsp;ariaCloseLabel: undefined<br>}</code> |
| ariaCloseLabel | Accessibility label for the close button | string | - | <div><small>From <b>config</b>:</small></div><code style='white-space: nowrap; padding: 0;'>taginput: {<br>&nbsp;&nbsp;ariaCloseLabel: "Remove"<br>}</code> |
| autocomplete | Native options to use in HTML5 validation | string | - | <div><small>From <b>config</b>:</small></div><code style='white-space: nowrap; padding: 0;'>taginput: {<br>&nbsp;&nbsp;autocomplete: "off"<br>}</code> |
| checkScroll | Makes the component check if list reached scroll start or end and emit scroll events. | boolean | - | <div><small>From <b>config</b>:</small></div><code style='white-space: nowrap; padding: 0;'>taginput: {<br>&nbsp;&nbsp;checkScroll: false<br>}</code> |
| closable | Add close/delete button to the item | boolean | - | <div><small>From <b>config</b>:</small></div><code style='white-space: nowrap; padding: 0;'>taginput: {<br>&nbsp;&nbsp;closable: true<br>}</code> |
Expand Down
Loading

0 comments on commit 0cbe16f

Please sign in to comment.