From 5ce1ab815c69bc58d5b36f05b49e8e42a5016c62 Mon Sep 17 00:00:00 2001 From: Elizabeth Mitchell Date: Tue, 14 Nov 2023 17:59:08 -0800 Subject: [PATCH] docs: update freshness PiperOrigin-RevId: 582496450 --- docs/components/button.md | 42 +++++++++++------------ docs/components/checkbox.md | 19 ++++++----- docs/components/elevation.md | 6 ++-- docs/components/icon-button.md | 62 ++++++++++++++++------------------ 4 files changed, 65 insertions(+), 64 deletions(-) diff --git a/docs/components/button.md b/docs/components/button.md index 76fde234ec..7baa3836c2 100644 --- a/docs/components/button.md +++ b/docs/components/button.md @@ -12,7 +12,7 @@ dirname: button @@ -717,10 +717,10 @@ Property | Attribute | Type | Default | Description `target` | `target` | `string` | `''` | Where to display the linked `href` URL for a link button. Common options include `_blank` to open in a new tab. `trailingIcon` | `trailing-icon` | `boolean` | `false` | Whether to render the icon at the inline end of the label rather than the inline start.
_Note:_ Link buttons cannot have trailing icons. `hasIcon` | `has-icon` | `boolean` | `false` | Whether to display the icon or not. -`type` | `type` | `string` | `'submit'` | -`value` | `value` | `string` | `''` | -`name` | | `string` | `undefined` | -`form` | | `HTMLFormElement` | `undefined` | +`type` | `type` | `string` | `'submit'` | +`value` | `value` | `string` | `''` | +`name` | | `string` | `undefined` | +`form` | | `HTMLFormElement` | `undefined` | @@ -737,10 +737,10 @@ Property | Attribute | Type | Default | Description `target` | `target` | `string` | `''` | Where to display the linked `href` URL for a link button. Common options include `_blank` to open in a new tab. `trailingIcon` | `trailing-icon` | `boolean` | `false` | Whether to render the icon at the inline end of the label rather than the inline start.
_Note:_ Link buttons cannot have trailing icons. `hasIcon` | `has-icon` | `boolean` | `false` | Whether to display the icon or not. -`type` | `type` | `string` | `'submit'` | -`value` | `value` | `string` | `''` | -`name` | | `string` | `undefined` | -`form` | | `HTMLFormElement` | `undefined` | +`type` | `type` | `string` | `'submit'` | +`value` | `value` | `string` | `''` | +`name` | | `string` | `undefined` | +`form` | | `HTMLFormElement` | `undefined` | @@ -757,10 +757,10 @@ Property | Attribute | Type | Default | Description `target` | `target` | `string` | `''` | Where to display the linked `href` URL for a link button. Common options include `_blank` to open in a new tab. `trailingIcon` | `trailing-icon` | `boolean` | `false` | Whether to render the icon at the inline end of the label rather than the inline start.
_Note:_ Link buttons cannot have trailing icons. `hasIcon` | `has-icon` | `boolean` | `false` | Whether to display the icon or not. -`type` | `type` | `string` | `'submit'` | -`value` | `value` | `string` | `''` | -`name` | | `string` | `undefined` | -`form` | | `HTMLFormElement` | `undefined` | +`type` | `type` | `string` | `'submit'` | +`value` | `value` | `string` | `''` | +`name` | | `string` | `undefined` | +`form` | | `HTMLFormElement` | `undefined` | @@ -777,10 +777,10 @@ Property | Attribute | Type | Default | Description `target` | `target` | `string` | `''` | Where to display the linked `href` URL for a link button. Common options include `_blank` to open in a new tab. `trailingIcon` | `trailing-icon` | `boolean` | `false` | Whether to render the icon at the inline end of the label rather than the inline start.
_Note:_ Link buttons cannot have trailing icons. `hasIcon` | `has-icon` | `boolean` | `false` | Whether to display the icon or not. -`type` | `type` | `string` | `'submit'` | -`value` | `value` | `string` | `''` | -`name` | | `string` | `undefined` | -`form` | | `HTMLFormElement` | `undefined` | +`type` | `type` | `string` | `'submit'` | +`value` | `value` | `string` | `''` | +`name` | | `string` | `undefined` | +`form` | | `HTMLFormElement` | `undefined` | @@ -797,10 +797,10 @@ Property | Attribute | Type | Default | Description `target` | `target` | `string` | `''` | Where to display the linked `href` URL for a link button. Common options include `_blank` to open in a new tab. `trailingIcon` | `trailing-icon` | `boolean` | `false` | Whether to render the icon at the inline end of the label rather than the inline start.
_Note:_ Link buttons cannot have trailing icons. `hasIcon` | `has-icon` | `boolean` | `false` | Whether to display the icon or not. -`type` | `type` | `string` | `'submit'` | -`value` | `value` | `string` | `''` | -`name` | | `string` | `undefined` | -`form` | | `HTMLFormElement` | `undefined` | +`type` | `type` | `string` | `'submit'` | +`value` | `value` | `string` | `''` | +`name` | | `string` | `undefined` | +`form` | | `HTMLFormElement` | `undefined` | diff --git a/docs/components/checkbox.md b/docs/components/checkbox.md index 0ed66e222f..7f9de58523 100644 --- a/docs/components/checkbox.md +++ b/docs/components/checkbox.md @@ -10,7 +10,11 @@ dirname: checkbox @@ -164,7 +168,6 @@ Token | Default value ## API - ### MdCheckbox <md-checkbox> #### Properties @@ -178,12 +181,12 @@ Property | Attribute | Type | Default | Description `indeterminate` | `indeterminate` | `boolean` | `false` | Whether or not the checkbox is indeterminate.
https://developer.mozilla.org/en-US/docs/Web/HTML/Element/input/checkbox#indeterminate_state_checkboxes `required` | `required` | `boolean` | `false` | When true, require the checkbox to be selected when participating in form submission.
https://developer.mozilla.org/en-US/docs/Web/HTML/Element/input/checkbox#validation `value` | `value` | `string` | `'on'` | The value of the checkbox that is submitted with a form when selected.
https://developer.mozilla.org/en-US/docs/Web/HTML/Element/input/checkbox#value -`name` | | `string` | `undefined` | -`form` | | `HTMLFormElement` | `undefined` | -`labels` | | `NodeList` | `undefined` | -`validity` | | `ValidityState` | `undefined` | -`validationMessage` | | `string` | `undefined` | -`willValidate` | | `boolean` | `undefined` | +`name` | | `string` | `undefined` | +`form` | | `HTMLFormElement` | `undefined` | +`labels` | | `NodeList` | `undefined` | +`validity` | | `ValidityState` | `undefined` | +`validationMessage` | | `string` | `undefined` | +`willValidate` | | `boolean` | `undefined` | diff --git a/docs/components/elevation.md b/docs/components/elevation.md index 972687c072..1363250165 100644 --- a/docs/components/elevation.md +++ b/docs/components/elevation.md @@ -2,7 +2,7 @@ @@ -27,8 +27,8 @@ UI’s elevation story. ## Usage Elevation can be set from 0 to 5 using the `--md-elevation-level` CSS custom -property. The elevation's container needs width, height, and a relative -position. +property. The elevation will automatically fill the nearest `position: relative` +element's size and shape. ![A rounded square with a drop shadow beneath it.](images/elevation/usage.png "A surface with an elevation shadow.") diff --git a/docs/components/icon-button.md b/docs/components/icon-button.md index 8866a2ddc5..fd172695dc 100644 --- a/docs/components/icon-button.md +++ b/docs/components/icon-button.md @@ -10,7 +10,7 @@ dirname: iconbutton @@ -127,6 +127,10 @@ selected](images/iconbutton/usage-toggle.png "Unselected and Selected Icon Butto Toggle icon buttons allow a single choice to be selected or deselected, such as adding or removing something from favorites. +Add a second icon in the `slot="selected"` slot to change the icon when +selected. Toggle icon buttons can be pre-selected by adding the `selected` +attribute. + ```html
@@ -170,7 +174,7 @@ adding or removing something from favorites. Add an [`aria-label`](https://developer.mozilla.org/en-US/docs/Web/Accessibility/ARIA/Attributes/aria-label) -attribute to buttons whose labels need a more descriptive label. +attribute to icon buttons whose labels need a more descriptive label. ```html @@ -180,8 +184,8 @@ attribute to buttons whose labels need a more descriptive label. ### Toggle -Add a `aria-label-selected` attribute to toggle buttons whose labels need a more -descriptive label when selected. +Add an `aria-label-selected` attribute to toggle buttons whose labels need a +more descriptive label when selected. ```html -to display actions in a compact layout. Icon buttons can represent opening -actions such as opening an overflow menu or search, or represent binary actions -that can be toggled on and off, such as favorite or bookmark. - -Icon buttons can be grouped together or they can stand alone. +Standard icon buttons do not have a background or outline, and have the lowest +emphasis of the icon buttons. @@ -429,7 +428,6 @@ Token | Default value ## API - ### MdIconButton <md-icon-button> #### Properties @@ -445,11 +443,11 @@ Property | Attribute | Type | Default | Description `ariaLabelSelected` | `aria-label-selected` | `string` | `''` | The `aria-label` of the button when the button is toggleable and selected. `toggle` | `toggle` | `boolean` | `false` | When true, the button will toggle between selected and unselected states `selected` | `selected` | `boolean` | `false` | Sets the selected state. When false, displays the default icon. When true, displays the selected icon, or the default icon If no `slot="selected"` icon is provided. -`type` | `type` | `string` | `'submit'` | -`value` | `value` | `string` | `''` | -`name` | | `string` | `undefined` | -`form` | | `HTMLFormElement` | `undefined` | -`labels` | | `NodeList` | `undefined` | +`type` | `type` | `string` | `'submit'` | +`value` | `value` | `string` | `''` | +`name` | | `string` | `undefined` | +`form` | | `HTMLFormElement` | `undefined` | +`labels` | | `NodeList` | `undefined` | @@ -468,11 +466,11 @@ Property | Attribute | Type | Default | Description `ariaLabelSelected` | `aria-label-selected` | `string` | `''` | The `aria-label` of the button when the button is toggleable and selected. `toggle` | `toggle` | `boolean` | `false` | When true, the button will toggle between selected and unselected states `selected` | `selected` | `boolean` | `false` | Sets the selected state. When false, displays the default icon. When true, displays the selected icon, or the default icon If no `slot="selected"` icon is provided. -`type` | `type` | `string` | `'submit'` | -`value` | `value` | `string` | `''` | -`name` | | `string` | `undefined` | -`form` | | `HTMLFormElement` | `undefined` | -`labels` | | `NodeList` | `undefined` | +`type` | `type` | `string` | `'submit'` | +`value` | `value` | `string` | `''` | +`name` | | `string` | `undefined` | +`form` | | `HTMLFormElement` | `undefined` | +`labels` | | `NodeList` | `undefined` | @@ -491,11 +489,11 @@ Property | Attribute | Type | Default | Description `ariaLabelSelected` | `aria-label-selected` | `string` | `''` | The `aria-label` of the button when the button is toggleable and selected. `toggle` | `toggle` | `boolean` | `false` | When true, the button will toggle between selected and unselected states `selected` | `selected` | `boolean` | `false` | Sets the selected state. When false, displays the default icon. When true, displays the selected icon, or the default icon If no `slot="selected"` icon is provided. -`type` | `type` | `string` | `'submit'` | -`value` | `value` | `string` | `''` | -`name` | | `string` | `undefined` | -`form` | | `HTMLFormElement` | `undefined` | -`labels` | | `NodeList` | `undefined` | +`type` | `type` | `string` | `'submit'` | +`value` | `value` | `string` | `''` | +`name` | | `string` | `undefined` | +`form` | | `HTMLFormElement` | `undefined` | +`labels` | | `NodeList` | `undefined` | @@ -514,11 +512,11 @@ Property | Attribute | Type | Default | Description `ariaLabelSelected` | `aria-label-selected` | `string` | `''` | The `aria-label` of the button when the button is toggleable and selected. `toggle` | `toggle` | `boolean` | `false` | When true, the button will toggle between selected and unselected states `selected` | `selected` | `boolean` | `false` | Sets the selected state. When false, displays the default icon. When true, displays the selected icon, or the default icon If no `slot="selected"` icon is provided. -`type` | `type` | `string` | `'submit'` | -`value` | `value` | `string` | `''` | -`name` | | `string` | `undefined` | -`form` | | `HTMLFormElement` | `undefined` | -`labels` | | `NodeList` | `undefined` | +`type` | `type` | `string` | `'submit'` | +`value` | `value` | `string` | `''` | +`name` | | `string` | `undefined` | +`form` | | `HTMLFormElement` | `undefined` | +`labels` | | `NodeList` | `undefined` |