Generate new docs.

andreasbm · Nov 2, 2019 · 5002307 · 5002307
1 parent 918435d
commit 5002307
Show file tree

Hide file tree

Showing 26 changed files with 299 additions and 299 deletions.
diff --git 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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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)