diff --git a/src/lib/banner/README.md b/src/lib/banner/README.md index 14e274b..dd3fa98 100644 --- a/src/lib/banner/README.md +++ b/src/lib/banner/README.md @@ -15,6 +15,17 @@ Display a non-interruptive message and related optional actions. | `role` | `role` | `AriaRole` | "banner" | Role of the banner. | +[![-----------------------------------------------------](https://raw.githubusercontent.com/andreasbm/readme/master/assets/lines/colored.png)](#slots) + +## ➤ Slots + +| Name | Description | +|----------|--------------------------------------------------| +| | Default content. | +| `action` | Action content (you can have multiple slots named action). | +| `icon` | Icon content. | + + [![-----------------------------------------------------](https://raw.githubusercontent.com/andreasbm/readme/master/assets/lines/colored.png)](#css-custom-properties) ## ➤ CSS Custom Properties @@ -28,17 +39,6 @@ Display a non-interruptive message and related optional actions. | `--banner-icon-margin` | Margin of the icon slot | | `--banner-padding` | Padding | - -[![-----------------------------------------------------](https://raw.githubusercontent.com/andreasbm/readme/master/assets/lines/colored.png)](#slots) - -## ➤ Slots - -| Name | Description | -|----------|--------------------------------------------------| -| | Default content. | -| `action` | Action content (you can have multiple slots named action). | -| `icon` | Icon content. | - [![-----------------------------------------------------](https://raw.githubusercontent.com/andreasbm/readme/master/assets/lines/colored.png)](#usage) diff --git a/src/lib/button/README.md b/src/lib/button/README.md index 83aa8ce..fc5d942 100644 --- a/src/lib/button/README.md +++ b/src/lib/button/README.md @@ -12,18 +12,27 @@ Allow users to take actions, and make choices, with a single tap. | Property | Attribute | Type | Default | Description | |------------|------------|------------------------|----------|--------------------------------------------------| -| `disabled` | `disabled` | `boolean` | | Disables the element. | -| `fab` | `fab` | `boolean` | | Makes the button round and squared. | -| `flat` | `flat` | `boolean` | | Makes the button flat. | -| `inverted` | `inverted` | `boolean` | | Inverts the colors of the button. | +| `disabled` | `disabled` | `boolean` | false | Disables the element. | +| `fab` | `fab` | `boolean` | false | Makes the button round and squared. | +| `flat` | `flat` | `boolean` | false | Makes the button flat. | +| `inverted` | `inverted` | `boolean` | false | Inverts the colors of the button. | | `name` | `name` | `string \| undefined` | | Name of the native form element. | -| `noRipple` | `noRipple` | `boolean` | | Deactivates the ripple. | -| `outlined` | `outlined` | `boolean` | | Makes the button outlined. | -| `readonly` | `readonly` | `boolean` | | Makes the element readonly (disabled but tabbable) | -| `required` | `required` | `boolean` | | Makes the element required in a form context. | +| `noRipple` | `noRipple` | `boolean` | false | Deactivates the ripple. | +| `outlined` | `outlined` | `boolean` | false | Makes the button outlined. | +| `readonly` | `readonly` | `boolean` | false | Makes the element readonly (disabled but tabbable) | +| `required` | `required` | `boolean` | false | Makes the element required in a form context. | | `role` | `role` | `AriaRole` | "button" | Role of the button. | | `type` | `type` | `"button" \| "submit"` | "submit" | Type of the button. | -| `value` | `value` | `string` | | Value of the form element. | +| `value` | `value` | `string` | "" | Value of the form element. | + + +[![-----------------------------------------------------](https://raw.githubusercontent.com/andreasbm/readme/master/assets/lines/colored.png)](#slots) + +## ➤ Slots + +| Name | Description | +|------|------------------| +| | Default content. | [![-----------------------------------------------------](https://raw.githubusercontent.com/andreasbm/readme/master/assets/lines/colored.png)](#css-custom-properties) @@ -52,15 +61,6 @@ Allow users to take actions, and make choices, with a single tap. | `--button-shadow-color-hover` | Shadow color when :hover or :focus | | `--button-transition` | Transition | - -[![-----------------------------------------------------](https://raw.githubusercontent.com/andreasbm/readme/master/assets/lines/colored.png)](#slots) - -## ➤ Slots - -| Name | Description | -|------|------------------| -| | Default content. | - [![-----------------------------------------------------](https://raw.githubusercontent.com/andreasbm/readme/master/assets/lines/colored.png)](#usage) diff --git a/src/lib/card/README.md b/src/lib/card/README.md index ff498fd..a1997a1 100644 --- a/src/lib/card/README.md +++ b/src/lib/card/README.md @@ -10,9 +10,18 @@ Group related content and action. ## ➤ Properties -| Property | Attribute | Type | Description | -|-------------|-------------|-----------|---------------------------| -| `hoverable` | `hoverable` | `boolean` | Makes the card hoverable. | +| Property | Attribute | Type | Default | Description | +|-------------|-------------|-----------|---------|---------------------------| +| `hoverable` | `hoverable` | `boolean` | false | Makes the card hoverable. | + + +[![-----------------------------------------------------](https://raw.githubusercontent.com/andreasbm/readme/master/assets/lines/colored.png)](#slots) + +## ➤ Slots + +| Name | Description | +|------|------------------| +| | Default content. | [![-----------------------------------------------------](https://raw.githubusercontent.com/andreasbm/readme/master/assets/lines/colored.png)](#css-custom-properties) @@ -29,15 +38,6 @@ Group related content and action. | `--card-padding` | Padding | | `--card-transition` | Transition | - -[![-----------------------------------------------------](https://raw.githubusercontent.com/andreasbm/readme/master/assets/lines/colored.png)](#slots) - -## ➤ Slots - -| Name | Description | -|------|------------------| -| | Default content. | - [![-----------------------------------------------------](https://raw.githubusercontent.com/andreasbm/readme/master/assets/lines/colored.png)](#usage) diff --git a/src/lib/checkbox/README.md b/src/lib/checkbox/README.md index 82c742b..22561d9 100644 --- a/src/lib/checkbox/README.md +++ b/src/lib/checkbox/README.md @@ -13,14 +13,14 @@ Turn an option on or off. | Property | Attribute | Type | Default | Description | |-----------------|-----------------|-----------------------|------------|--------------------------------------------------| | `ariaChecked` | `aria-checked` | `string` | | Aria checked attribute. | -| `checked` | `checked` | `boolean` | | Checks the switch. | -| `disabled` | `disabled` | `boolean` | | Disables the element. | -| `indeterminate` | `indeterminate` | `boolean` | | Indeterminate checkbox state. | +| `checked` | `checked` | `boolean` | false | Checks the switch. | +| `disabled` | `disabled` | `boolean` | false | Disables the element. | +| `indeterminate` | `indeterminate` | `boolean` | false | Indeterminate checkbox state. | | `name` | `name` | `string \| undefined` | | Name of the native form element. | -| `readonly` | `readonly` | `boolean` | | Makes the element readonly (disabled but tabbable) | -| `required` | `required` | `boolean` | | Makes the element required in a form context. | +| `readonly` | `readonly` | `boolean` | false | Makes the element readonly (disabled but tabbable) | +| `required` | `required` | `boolean` | false | Makes the element required in a form context. | | `role` | `role` | `AriaRole` | "checkbox" | Role of the switch. | -| `value` | `value` | `string` | | Value of the form element. | +| `value` | `value` | `string` | "" | Value of the form element. | [![-----------------------------------------------------](https://raw.githubusercontent.com/andreasbm/readme/master/assets/lines/colored.png)](#events) diff --git a/src/lib/dialog/README.md b/src/lib/dialog/README.md index b39cca5..565ec00 100644 --- a/src/lib/dialog/README.md +++ b/src/lib/dialog/README.md @@ -12,16 +12,16 @@ Highly interruptive messages. | Property | Attribute | Type | Default | Description | |--------------------|--------------------|---------------------------|----------|--------------------------------------------------| -| `backdrop` | `backdrop` | `boolean` | | Whether the backdrop is visible or not. | -| `blockScrolling` | `blockScrolling` | `boolean` | | Whether the overlay blocks the scrolling on the scroll container. | -| `disableFocusTrap` | `disableFocusTrap` | `boolean` | | Whether the focus trap be disabled. | +| `backdrop` | `backdrop` | `boolean` | false | Whether the backdrop is visible or not. | +| `blockScrolling` | `blockScrolling` | `boolean` | false | Whether the overlay blocks the scrolling on the scroll container. | +| `disableFocusTrap` | `disableFocusTrap` | `boolean` | false | Whether the focus trap be disabled. | | `duration` | `duration` | `number` | 200 | The duration of the animations. | -| `fixed` | `fixed` | `boolean` | | Whether the overlay is fixed or not. | -| `open` | `open` | `boolean` | | Whether the overlay is open or not. | -| `persistent` | `persistent` | `boolean` | | Whether the overlay is persistent or not. When the overlay is persistent, ESCAPE and backdrop clicks won't close it. | +| `fixed` | `fixed` | `boolean` | false | Whether the overlay is fixed or not. | +| `open` | `open` | `boolean` | false | Whether the overlay is open or not. | +| `persistent` | `persistent` | `boolean` | false | Whether the overlay is persistent or not. When the overlay is persistent, ESCAPE and backdrop clicks won't close it. | | `role` | `role` | `AriaRole` | "dialog" | Role of the dialog. | | `scrollContainer` | `scrollContainer` | `EventTarget` | | The container the overlay lives in. | -| `scrollable` | `scrollable` | `boolean` | | Makes the dialog scrollable. | +| `scrollable` | `scrollable` | `boolean` | false | Makes the dialog scrollable. | | `size` | `size` | `DialogSize \| undefined` | | Size of the dialog. | @@ -35,6 +35,18 @@ Highly interruptive messages. | `didshow` | Dispatches after the overlay has been shown. | +[![-----------------------------------------------------](https://raw.githubusercontent.com/andreasbm/readme/master/assets/lines/colored.png)](#slots) + +## ➤ Slots + +| Name | Description | +|-----------|------------------| +| | Default content. | +| `content` | Body content. | +| `footer` | Footer content. | +| `header` | Header content. | + + [![-----------------------------------------------------](https://raw.githubusercontent.com/andreasbm/readme/master/assets/lines/colored.png)](#css-custom-properties) ## ➤ CSS Custom Properties @@ -67,18 +79,6 @@ Highly interruptive messages. | `--dialog-width-m` | Medium width | | `--dialog-width-s` | Small width | - -[![-----------------------------------------------------](https://raw.githubusercontent.com/andreasbm/readme/master/assets/lines/colored.png)](#slots) - -## ➤ Slots - -| Name | Description | -|-----------|------------------| -| | Default content. | -| `content` | Body content. | -| `footer` | Footer content. | -| `header` | Header content. | - [![-----------------------------------------------------](https://raw.githubusercontent.com/andreasbm/readme/master/assets/lines/colored.png)](#usage) diff --git a/src/lib/divider/README.md b/src/lib/divider/README.md index eae425c..92734bb 100644 --- a/src/lib/divider/README.md +++ b/src/lib/divider/README.md @@ -13,7 +13,7 @@ Thin line that groups content in lists and layouts. | Property | Attribute | Type | Default | Description | |------------|------------|------------|-------------|-----------------------------| | `role` | `role` | `AriaRole` | "separator" | Role of the backdrop. | -| `vertical` | `vertical` | `boolean` | | Makes the divider vertical. | +| `vertical` | `vertical` | `boolean` | false | Makes the divider vertical. | [![-----------------------------------------------------](https://raw.githubusercontent.com/andreasbm/readme/master/assets/lines/colored.png)](#css-custom-properties) diff --git a/src/lib/expansion/README.md b/src/lib/expansion/README.md index 2b1952b..e10159d 100644 --- a/src/lib/expansion/README.md +++ b/src/lib/expansion/README.md @@ -13,16 +13,16 @@ Provide an expandable details-summary view. | Property | Attribute | Type | Default | Description | |---------------|----------------|-----------------------|---------------|--------------------------------------------------| | `ariaChecked` | `aria-checked` | `string` | | Aria expanded attribute. | -| `checked` | `checked` | `boolean` | | Opens the expansion. | -| `disabled` | `disabled` | `boolean` | | Disables the element. | +| `checked` | `checked` | `boolean` | false | Opens the expansion. | +| `disabled` | `disabled` | `boolean` | false | Disables the element. | | `duration` | `duration` | `number` | 250 | The duration of the animations. | | `icon` | `icon` | `string \| undefined` | "expand_more" | Icon name. | | `name` | `name` | `string \| undefined` | | Name of the native form element. | -| `noRipple` | `noRipple` | `boolean` | | Deactivates the ripple. | -| `readonly` | `readonly` | `boolean` | | Makes the element readonly (disabled but tabbable) | -| `required` | `required` | `boolean` | | Makes the element required in a form context. | +| `noRipple` | `noRipple` | `boolean` | false | Deactivates the ripple. | +| `readonly` | `readonly` | `boolean` | false | Makes the element readonly (disabled but tabbable) | +| `required` | `required` | `boolean` | false | Makes the element required in a form context. | | `role` | `role` | `AriaRole` | "radio" | Role of the radio behavior. | -| `value` | `value` | `string` | | Value of the form element. | +| `value` | `value` | `string` | "" | Value of the form element. | [![-----------------------------------------------------](https://raw.githubusercontent.com/andreasbm/readme/master/assets/lines/colored.png)](#events) @@ -34,6 +34,18 @@ Provide an expandable details-summary view. | `change` | Dispatched when the checked property changes due to a user interaction. | +[![-----------------------------------------------------](https://raw.githubusercontent.com/andreasbm/readme/master/assets/lines/colored.png)](#slots) + +## ➤ Slots + +| Name | Description | +|---------------|----------------------------------------| +| | Default content. | +| `description` | Description to the left on the header. | +| `indicator` | Content to the right on the header. | +| `title` | Title to the left on the header. | + + [![-----------------------------------------------------](https://raw.githubusercontent.com/andreasbm/readme/master/assets/lines/colored.png)](#css-custom-properties) ## ➤ CSS Custom Properties @@ -56,18 +68,6 @@ Provide an expandable details-summary view. | `--expansion-margin-open` | Margin when open | | `--expansion-transition` | Transition | - -[![-----------------------------------------------------](https://raw.githubusercontent.com/andreasbm/readme/master/assets/lines/colored.png)](#slots) - -## ➤ Slots - -| Name | Description | -|---------------|----------------------------------------| -| | Default content. | -| `description` | Description to the left on the header. | -| `indicator` | Content to the right on the header. | -| `title` | Title to the left on the header. | - [![-----------------------------------------------------](https://raw.githubusercontent.com/andreasbm/readme/master/assets/lines/colored.png)](#usage) diff --git a/src/lib/icon/README.md b/src/lib/icon/README.md index 98b6129..4ec5e13 100644 --- a/src/lib/icon/README.md +++ b/src/lib/icon/README.md @@ -15,6 +15,15 @@ Symbols for common actions and items. | `role` | `role` | `AriaRole` | "presentation" | Roles of the icon. | +[![-----------------------------------------------------](https://raw.githubusercontent.com/andreasbm/readme/master/assets/lines/colored.png)](#slots) + +## ➤ Slots + +| Name | Description | +|------|-------------------| +| | Name of the icon. | + + [![-----------------------------------------------------](https://raw.githubusercontent.com/andreasbm/readme/master/assets/lines/colored.png)](#css-custom-properties) ## ➤ CSS Custom Properties @@ -24,15 +33,6 @@ Symbols for common actions and items. | `--icon-font` | Font family | | `--icon-size` | Width and height | - -[![-----------------------------------------------------](https://raw.githubusercontent.com/andreasbm/readme/master/assets/lines/colored.png)](#slots) - -## ➤ Slots - -| Name | Description | -|------|-------------------| -| | Name of the icon. | - [![-----------------------------------------------------](https://raw.githubusercontent.com/andreasbm/readme/master/assets/lines/colored.png)](#usage) diff --git a/src/lib/label/README.md b/src/lib/label/README.md index 1ffa6dd..ee17436 100644 --- a/src/lib/label/README.md +++ b/src/lib/label/README.md @@ -10,11 +10,20 @@ Make form elements more accessible. ## ➤ Properties -| Property | Attribute | Type | Description | -|------------|------------|-----------------------|--------------------------------------------------| -| `for` | `for` | `string \| undefined` | Query of the form element click events are re-fired upon. | -| `nowrap` | `nowrap` | `boolean` | Caps the label element with ellipsis if overflowing. | -| `required` | `required` | `boolean` | Styles the label as required. | +| Property | Attribute | Type | Default | Description | +|------------|------------|-----------------------|---------|--------------------------------------------------| +| `for` | `for` | `string \| undefined` | | Query of the form element click events are re-fired upon. | +| `nowrap` | `nowrap` | `boolean` | false | Caps the label element with ellipsis if overflowing. | +| `required` | `required` | `boolean` | false | Styles the label as required. | + + +[![-----------------------------------------------------](https://raw.githubusercontent.com/andreasbm/readme/master/assets/lines/colored.png)](#slots) + +## ➤ Slots + +| Name | Description | +|------|--------------------------------------------------| +| | Default content. If the first element is a form element, clicks on the entire label will be re-fired upon that element. | [![-----------------------------------------------------](https://raw.githubusercontent.com/andreasbm/readme/master/assets/lines/colored.png)](#css-custom-properties) @@ -29,15 +38,6 @@ Make form elements more accessible. | `--label-line-height` | Line height | | `--label-required-color` | Color of the required astrix | - -[![-----------------------------------------------------](https://raw.githubusercontent.com/andreasbm/readme/master/assets/lines/colored.png)](#slots) - -## ➤ Slots - -| Name | Description | -|------|--------------------------------------------------| -| | Default content. If the first element is a form element, clicks on the entire label will be re-fired upon that element. | - [![-----------------------------------------------------](https://raw.githubusercontent.com/andreasbm/readme/master/assets/lines/colored.png)](#usage) diff --git a/src/lib/list-item/README.md b/src/lib/list-item/README.md index 9a23ae8..4d51735 100644 --- a/src/lib/list-item/README.md +++ b/src/lib/list-item/README.md @@ -12,15 +12,26 @@ Display an item in a list. | Property | Attribute | Type | Default | Description | |-------------|-------------|------------------------|------------|--------------------------------------------------| -| `clickable` | `clickable` | `boolean` | | Makes the element clickable. | -| `disabled` | `disabled` | `boolean` | | Disables the element. | +| `clickable` | `clickable` | `boolean` | false | Makes the element clickable. | +| `disabled` | `disabled` | `boolean` | false | Disables the element. | | `name` | `name` | `string \| undefined` | | Name of the native form element. | -| `noRipple` | `noRipple` | `boolean` | | Deactivates the ripple. | -| `readonly` | `readonly` | `boolean` | | Makes the element readonly (disabled but tabbable) | -| `required` | `required` | `boolean` | | Makes the element required in a form context. | +| `noRipple` | `noRipple` | `boolean` | false | Deactivates the ripple. | +| `readonly` | `readonly` | `boolean` | false | Makes the element readonly (disabled but tabbable) | +| `required` | `required` | `boolean` | false | Makes the element required in a form context. | | `role` | `role` | `AriaRole` | "listitem" | Role of the list item. | | `type` | `type` | `"button" \| "submit"` | "submit" | Type of the button. | -| `value` | `value` | `string` | | Value of the form element. | +| `value` | `value` | `string` | "" | Value of the form element. | + + +[![-----------------------------------------------------](https://raw.githubusercontent.com/andreasbm/readme/master/assets/lines/colored.png)](#slots) + +## ➤ Slots + +| Name | Description | +|----------|------------------| +| | Default content. | +| `after` | Right content. | +| `before` | Left content. | [![-----------------------------------------------------](https://raw.githubusercontent.com/andreasbm/readme/master/assets/lines/colored.png)](#css-custom-properties) @@ -48,17 +59,6 @@ Display an item in a list. | `--list-item-padding` | Padding | | `--list-item-transition` | Transition | - -[![-----------------------------------------------------](https://raw.githubusercontent.com/andreasbm/readme/master/assets/lines/colored.png)](#slots) - -## ➤ Slots - -| Name | Description | -|----------|------------------| -| | Default content. | -| `after` | Right content. | -| `before` | Left content. | - [![-----------------------------------------------------](https://raw.githubusercontent.com/andreasbm/readme/master/assets/lines/colored.png)](#usage) diff --git a/src/lib/nav/README.md b/src/lib/nav/README.md index 4e1c083..7196991 100644 --- a/src/lib/nav/README.md +++ b/src/lib/nav/README.md @@ -12,9 +12,20 @@ Provide access to destinations in your app. | Property | Attribute | Type | Default | Description | |----------|-----------|------------|--------------|---------------------------------------| -| `fixed` | `fixed` | `boolean` | | Fixes the nav to the top of the page. | +| `fixed` | `fixed` | `boolean` | false | Fixes the nav to the top of the page. | | `role` | `role` | `AriaRole` | "navigation" | Role of the nav. | -| `shadow` | `shadow` | `boolean` | | Gives the nav a shadow. | +| `shadow` | `shadow` | `boolean` | false | Gives the nav a shadow. | + + +[![-----------------------------------------------------](https://raw.githubusercontent.com/andreasbm/readme/master/assets/lines/colored.png)](#slots) + +## ➤ Slots + +| Name | Description | +|---------|----------------------------------| +| `left` | Content positioned to the left. | +| `right` | Content positioned to the right. | +| `title` | Title. | [![-----------------------------------------------------](https://raw.githubusercontent.com/andreasbm/readme/master/assets/lines/colored.png)](#css-custom-properties) @@ -33,17 +44,6 @@ Provide access to destinations in your app. | `--nav-title-margin` | Margin of the title slot | | `--nav-transition` | Transition | - -[![-----------------------------------------------------](https://raw.githubusercontent.com/andreasbm/readme/master/assets/lines/colored.png)](#slots) - -## ➤ Slots - -| Name | Description | -|---------|----------------------------------| -| `left` | Content positioned to the left. | -| `right` | Content positioned to the right. | -| `title` | Title. | - [![-----------------------------------------------------](https://raw.githubusercontent.com/andreasbm/readme/master/assets/lines/colored.png)](#usage) diff --git a/src/lib/popover-card/README.md b/src/lib/popover-card/README.md index 16c2f80..4548ee3 100644 --- a/src/lib/popover-card/README.md +++ b/src/lib/popover-card/README.md @@ -6,6 +6,15 @@ Give popovers a contextual flair. +[![-----------------------------------------------------](https://raw.githubusercontent.com/andreasbm/readme/master/assets/lines/colored.png)](#slots) + +## ➤ Slots + +| Name | Description | +|------|------------------| +| | Default content. | + + [![-----------------------------------------------------](https://raw.githubusercontent.com/andreasbm/readme/master/assets/lines/colored.png)](#css-custom-properties) ## ➤ CSS Custom Properties @@ -17,15 +26,6 @@ Give popovers a contextual flair. | `--popover-card-arrow-width` | Width of the arrow | | `--popover-card-elevation` | Box shadow | - -[![-----------------------------------------------------](https://raw.githubusercontent.com/andreasbm/readme/master/assets/lines/colored.png)](#slots) - -## ➤ Slots - -| Name | Description | -|------|------------------| -| | Default content. | - [![-----------------------------------------------------](https://raw.githubusercontent.com/andreasbm/readme/master/assets/lines/colored.png)](#usage) diff --git a/src/lib/progress-bar/README.md b/src/lib/progress-bar/README.md index 6ef8565..3ef2a97 100644 --- a/src/lib/progress-bar/README.md +++ b/src/lib/progress-bar/README.md @@ -12,14 +12,14 @@ Fills a bar from 0% to 100%. | Property | Attribute | Type | Default | Description | |-------------|-------------|----------------|---------------|--------------------------------| -| `buffer` | `buffer` | `number` | | Buffer progress value. | +| `buffer` | `buffer` | `number` | 0 | Buffer progress value. | | `bufferMax` | `bufferMax` | `number` | 1 | Max buffer progress value. | -| `bufferMin` | `bufferMin` | `number` | | Min buffer progress value. | +| `bufferMin` | `bufferMin` | `number` | 0 | Min buffer progress value. | | `max` | `max` | `number` | 1 | Max progress value. | -| `min` | `min` | `number` | | Min progress value. | +| `min` | `min` | `number` | 0 | Min progress value. | | `mode` | `mode` | `ProgressMode` | | Animation mode. | | `role` | `role` | `AriaRole` | "progressbar" | Role of the progress behavior. | -| `value` | `value` | `number` | | Progress value. | +| `value` | `value` | `number` | 0 | Progress value. | [![-----------------------------------------------------](https://raw.githubusercontent.com/andreasbm/readme/master/assets/lines/colored.png)](#css-custom-properties) diff --git a/src/lib/progress-spinner/README.md b/src/lib/progress-spinner/README.md index e337929..cb9879d 100644 --- a/src/lib/progress-spinner/README.md +++ b/src/lib/progress-spinner/README.md @@ -12,14 +12,14 @@ Fills a circle from 0% to 100%. | Property | Attribute | Type | Default | Description | |-------------|-------------|----------------|---------------|--------------------------------| -| `buffer` | `buffer` | `number` | | Buffer progress value. | +| `buffer` | `buffer` | `number` | 0 | Buffer progress value. | | `bufferMax` | `bufferMax` | `number` | 1 | Max buffer progress value. | -| `bufferMin` | `bufferMin` | `number` | | Min buffer progress value. | +| `bufferMin` | `bufferMin` | `number` | 0 | Min buffer progress value. | | `max` | `max` | `number` | 1 | Max progress value. | -| `min` | `min` | `number` | | Min progress value. | +| `min` | `min` | `number` | 0 | Min progress value. | | `mode` | `mode` | `ProgressMode` | | Animation mode. | | `role` | `role` | `AriaRole` | "progressbar" | Role of the progress behavior. | -| `value` | `value` | `number` | | Progress value. | +| `value` | `value` | `number` | 0 | Progress value. | [![-----------------------------------------------------](https://raw.githubusercontent.com/andreasbm/readme/master/assets/lines/colored.png)](#css-custom-properties) diff --git a/src/lib/radio/README.md b/src/lib/radio/README.md index d1bc695..919b460 100644 --- a/src/lib/radio/README.md +++ b/src/lib/radio/README.md @@ -13,13 +13,13 @@ Select one option from a set. | Property | Attribute | Type | Default | Description | |---------------|----------------|-----------------------|---------|--------------------------------------------------| | `ariaChecked` | `aria-checked` | `string` | | Aria checked attribute. | -| `checked` | `checked` | `boolean` | | Checks the switch. | -| `disabled` | `disabled` | `boolean` | | Disables the element. | +| `checked` | `checked` | `boolean` | false | Checks the switch. | +| `disabled` | `disabled` | `boolean` | false | Disables the element. | | `name` | `name` | `string \| undefined` | | Name of the native form element. | -| `readonly` | `readonly` | `boolean` | | Makes the element readonly (disabled but tabbable) | -| `required` | `required` | `boolean` | | Makes the element required in a form context. | +| `readonly` | `readonly` | `boolean` | false | Makes the element readonly (disabled but tabbable) | +| `required` | `required` | `boolean` | false | Makes the element required in a form context. | | `role` | `role` | `AriaRole` | "radio" | Role of the radio behavior. | -| `value` | `value` | `string` | | Value of the form element. | +| `value` | `value` | `string` | "" | Value of the form element. | [![-----------------------------------------------------](https://raw.githubusercontent.com/andreasbm/readme/master/assets/lines/colored.png)](#events) diff --git a/src/lib/ripple/README.md b/src/lib/ripple/README.md index afb12c6..e5db285 100644 --- a/src/lib/ripple/README.md +++ b/src/lib/ripple/README.md @@ -12,16 +12,16 @@ Indicate touch actions. | Property | Attribute | Type | Default | Description | |-------------------|-------------------|---------------|----------------|------------------------------------------------| -| `autoRelease` | `autoRelease` | `boolean` | | Releases the ripple after it has been spawned. | -| `centered` | `centered` | `boolean` | | Makes ripple appear from the center. | -| `disabled` | `disabled` | `boolean` | | Disables the ripple. | -| `focusable` | `focusable` | `boolean` | | Allows focusin to spawn a ripple. | +| `autoRelease` | `autoRelease` | `boolean` | false | Releases the ripple after it has been spawned. | +| `centered` | `centered` | `boolean` | false | Makes ripple appear from the center. | +| `disabled` | `disabled` | `boolean` | false | Disables the ripple. | +| `focusable` | `focusable` | `boolean` | false | Allows focusin to spawn a ripple. | | `initialDuration` | `initialDuration` | `number` | 350 | Initial animation duration. | -| `overlay` | `overlay` | `boolean` | | Overlays the ripple. | +| `overlay` | `overlay` | `boolean` | false | Overlays the ripple. | | `releaseDuration` | `releaseDuration` | `number` | 500 | Fade out animation duration. | | `role` | `role` | `AriaRole` | "presentation" | Role of the ripple. | | `target` | `target` | `EventTarget` | | Target for the spawn ripple events. | -| `unbounded` | `unbounded` | `boolean` | | Makes the ripple visible outside the bounds. | +| `unbounded` | `unbounded` | `boolean` | false | Makes the ripple visible outside the bounds. | | `x` | | `number` | **required** | | | `y` | | `number` | **required** | | diff --git a/src/lib/select/README.md b/src/lib/select/README.md index 194af0d..e26930a 100644 --- a/src/lib/select/README.md +++ b/src/lib/select/README.md @@ -13,13 +13,13 @@ Select one or more values from a set of options. | Property | Attribute | Type | Default | Description | |-----------------|-----------------|------------------------------|----------|--------------------------------------------------| | `autocomplete` | `autocomplete` | `"on" \| "off" \| undefined` | | Whether autocomplete is on or off. | -| `disabled` | `disabled` | `boolean` | | Disables the element. | -| `filled` | `filled` | `boolean` | | Fills the input with a solid color. | +| `disabled` | `disabled` | `boolean` | false | Disables the element. | +| `filled` | `filled` | `boolean` | false | Fills the input with a solid color. | | `label` | `label` | `string \| undefined` | | Label text. | | `name` | `name` | `string \| undefined` | | Name of the native form element. | -| `outlined` | `outlined` | `boolean` | | Makes the input outlined. | -| `readonly` | `readonly` | `boolean` | | Makes the element readonly (disabled but tabbable) | -| `required` | `required` | `boolean` | | Makes the element required in a form context. | +| `outlined` | `outlined` | `boolean` | false | Makes the input outlined. | +| `readonly` | `readonly` | `boolean` | false | Makes the element readonly (disabled but tabbable) | +| `required` | `required` | `boolean` | false | Makes the element required in a form context. | | `role` | `role` | `AriaRole` | "select" | Role of the select. | | `value` | `value` | `string` | | Value of the form element. | | `valueAsNumber` | `valueAsNumber` | `number` | | Value of the slider. | @@ -36,6 +36,17 @@ Select one or more values from a set of options. | `submit` | Dispatched when the enter key is hit while pressing ctrl or the meta-key. | +[![-----------------------------------------------------](https://raw.githubusercontent.com/andreasbm/readme/master/assets/lines/colored.png)](#slots) + +## ➤ Slots + +| Name | Description | +|----------|----------------------------| +| |