Skip to content

Commit

Permalink
docs: remove unnecessary 'optional' phrase
Browse files Browse the repository at this point in the history
  • Loading branch information
@mlmoravek
mlmoravek authored Nov 28, 2023
1 parent 78df3e9 commit cb3280c
Show file tree
Hide file tree
Showing 47 changed files with 122 additions and 115 deletions.
4 changes: 2 additions & 2 deletions packages/docs-next/components/Autocomplete.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -54,7 +54,7 @@ title: Autocomplete
| field | Property of the object (if data is array of objects) to use as display text, and to keep track of selected option | string | - | <code style='white-space: nowrap; padding: 0;'>"value"</code> |
| formatter | Function to format an option to a string for display in the input (as alternative to field prop) | (value: string \| number) =&gt; string \| number | - | |
| groupField | Property of the object (if `data` is array of objects) to use as display text of group | string | - | |
| groupOptions | Property of the object (if `data` is array of objects) to use as key to get items array of each group, optional | string | - | |
| groupOptions | Property of the object (if `data` is array of objects) to use as key to get items array of each group | string | - | |
| icon | Icon to be shown | string | - | <div><small>From <b>config</b>:</small></div><code style='white-space: nowrap; padding: 0;'>autocomplete: {<br>&nbsp;&nbsp;icon: undefined<br>}</code> |
| iconClickable | Makes the icon clickable | boolean | - | <code style='white-space: nowrap; padding: 0;'>false</code> |
| iconPack | Icon pack to use | string | `mdi`, `fa`, `fas and any other custom icon pack` | <div><small>From <b>config</b>:</small></div><code style='white-space: nowrap; padding: 0;'>autocomplete: {<br>&nbsp;&nbsp;iconPack: undefined<br>}</code> |
Expand All @@ -75,7 +75,7 @@ title: Autocomplete
| selectOnClickOutside | Trigger the select event for the first pre-selected option when clicking outside and `keep-first` is enabled | boolean | - | <code style='white-space: nowrap; padding: 0;'>false</code> |
| selectableFooter | Allows the footer in the autocomplete to be selectable | boolean | - | <code style='white-space: nowrap; padding: 0;'>false</code> |
| selectableHeader | Allows the header in the autocomplete to be selectable | boolean | - | <code style='white-space: nowrap; padding: 0;'>false</code> |
| size | Size of the control, optional | string | `small`, `medium`, `large` | <div><small>From <b>config</b>:</small></div><code style='white-space: nowrap; padding: 0;'>autocomplete: {<br>&nbsp;&nbsp;size: undefined<br>}</code> |
| size | Size of the control | string | `small`, `medium`, `large` | <div><small>From <b>config</b>:</small></div><code style='white-space: nowrap; padding: 0;'>autocomplete: {<br>&nbsp;&nbsp;size: undefined<br>}</code> |
| statusIcon | Show status icon using field and variant prop | boolean | - | <div><small>From <b>config</b>:</small></div><code style='white-space: nowrap; padding: 0;'>{<br>&nbsp;&nbsp;statusIcon: true<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\|string\|object | - | <div><small>From <b>config</b>:</small></div><code style='white-space: nowrap; padding: 0;'>autocomplete: {<br>&nbsp;&nbsp;teleport: false<br>}</code> |
| type | Input type | string | - | <code style='white-space: nowrap; padding: 0;'>"text"</code> |
Expand Down
4 changes: 2 additions & 2 deletions packages/docs-next/components/Button.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -52,9 +52,9 @@ title: Button
| outlined | Enable outlined style | boolean | - | <code style='white-space: nowrap; padding: 0;'>false</code> |
| role | Accessibility Role attribute to be passed to the button. | string | - | <div><small>From <b>config</b>:</small></div><code style='white-space: nowrap; padding: 0;'>button: {<br>&nbsp;&nbsp;role: "button"<br>}</code> |
| rounded | Enable rounded style | boolean | - | <div><small>From <b>config</b>:</small></div><code style='white-space: nowrap; padding: 0;'>button: {<br>&nbsp;&nbsp;rounded: false<br>}</code> |
| size | Size of the control, optional | string | `small`, `medium`, `large` | <div><small>From <b>config</b>:</small></div><code style='white-space: nowrap; padding: 0;'>button: {<br>&nbsp;&nbsp;size: undefined<br>}</code> |
| size | Size of the control | string | `small`, `medium`, `large` | <div><small>From <b>config</b>:</small></div><code style='white-space: nowrap; padding: 0;'>button: {<br>&nbsp;&nbsp;size: undefined<br>}</code> |
| tag | Button tag name | string \| Component | `button`, `a`, `input`, `router-link`, `nuxt-link (or other nuxt alias)` | <div><small>From <b>config</b>:</small></div><code style='white-space: nowrap; padding: 0;'>button: {<br>&nbsp;&nbsp;tag: "button"<br>}</code> |
| variant | Color variant of the control, optional | string | `primary`, `info`, `success`, `warning`, `danger`, `and any other custom color` | <div><small>From <b>config</b>:</small></div><code style='white-space: nowrap; padding: 0;'>button: {<br>&nbsp;&nbsp;variant: undefined<br>}</code> |
| variant | Color variant of the control | string | `primary`, `info`, `success`, `warning`, `danger`, `and any other custom color` | <div><small>From <b>config</b>:</small></div><code style='white-space: nowrap; padding: 0;'>button: {<br>&nbsp;&nbsp;variant: undefined<br>}</code> |

### Slots

Expand Down
2 changes: 1 addition & 1 deletion packages/docs-next/components/Checkbox.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -53,7 +53,7 @@ title: Checkbox
| trueValue | Overrides the returned value when it's checked | string\|number\|boolean | - | <code style='white-space: nowrap; padding: 0;'>true</code> |
| useHtml5Validation | Enable html 5 native validation | boolean | - | <div><small>From <b>config</b>:</small></div><code style='white-space: nowrap; padding: 0;'>{<br>&nbsp;&nbsp;useHtml5Validation: true<br>}</code> |
| v-model | | string\|number\|boolean\|array | - | |
| variant | Color of the control, optional | string | `primary`, `info`, `success`, `warning`, `danger`, `and any other custom color` | <div><small>From <b>config</b>:</small></div><code style='white-space: nowrap; padding: 0;'>checkbox: {<br>&nbsp;&nbsp;variant: undefined<br>}</code> |
| variant | Color of the control | string | `primary`, `info`, `success`, `warning`, `danger`, `and any other custom color` | <div><small>From <b>config</b>:</small></div><code style='white-space: nowrap; padding: 0;'>checkbox: {<br>&nbsp;&nbsp;variant: undefined<br>}</code> |

### Events

Expand Down
2 changes: 1 addition & 1 deletion packages/docs-next/components/Datepicker.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -80,7 +80,7 @@ title: Datepicker
| rulesForFirstWeek | Rules for the first week : 1 for the 1st January, 4 for the 4th January | number | - | Default function (see source code) |
| selectableDates | Define a list of dates which can be selected | Date[] \| ((date: Date) =&gt; boolean) | - | Default function (see source code) |
| showWeekNumber | Show weeek 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, optional | 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> |
| 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\|string\|object | - | <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 | string | `date`, `month` | <code style='white-space: nowrap; padding: 0;'>"date"</code> |
Expand Down
2 changes: 1 addition & 1 deletion packages/docs-next/components/Datetimepicker.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -61,7 +61,7 @@ title: Datetimepicker
| position | Dropdown position | string | - | |
| readonly | Same as native input readonly | boolean | - | <code style='white-space: nowrap; padding: 0;'>false</code> |
| rounded | Makes the input rounded | boolean | - | <code style='white-space: nowrap; padding: 0;'>false</code> |
| size | Size of the input control, optional | string | `small`, `medium`, `large` | <div><small>From <b>config</b>:</small></div><code style='white-space: nowrap; padding: 0;'>datetimepicker: {<br>&nbsp;&nbsp;size: undefined<br>}</code> |
| size | Size of the input control | string | `small`, `medium`, `large` | <div><small>From <b>config</b>:</small></div><code style='white-space: nowrap; padding: 0;'>datetimepicker: {<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\|string\|object | - | <div><small>From <b>config</b>:</small></div><code style='white-space: nowrap; padding: 0;'>datetimepicker: {<br>&nbsp;&nbsp;teleport: false<br>}</code> |
| timepicker | Define props for the underlying timepicker component | TimepickerProps | - | |
| useHtml5Validation | Enable html 5 native validation | boolean | - | <div><small>From <b>config</b>:</small></div><code style='white-space: nowrap; padding: 0;'>{<br>&nbsp;&nbsp;useHtml5Validation: true<br>}</code> |
Expand Down
Loading

0 comments on commit cb3280c

Please sign in to comment.