Skip to content

Commit

Permalink
docs: update freshness
Browse files Browse the repository at this point in the history
PiperOrigin-RevId: 582496450
  • Loading branch information
asyncLiz authored and copybara-github committed Nov 15, 2023
1 parent 7cd657b commit 5ce1ab8
Show file tree
Hide file tree
Showing 4 changed files with 65 additions and 64 deletions.
42 changes: 21 additions & 21 deletions docs/components/button.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ dirname: button

<!--*
# Document freshness: For more information, see go/fresh-source.
freshness: { owner: 'lizmitchell' reviewed: '2023-01-26' }
freshness: { owner: 'lizmitchell' reviewed: '2023-11-10' }
tag: 'docType:reference'
*-->

Expand Down Expand Up @@ -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.<br>_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` |

<!-- mdformat on(autogenerated might break rendering in catalog) -->

Expand All @@ -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.<br>_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` |

<!-- mdformat on(autogenerated might break rendering in catalog) -->

Expand All @@ -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.<br>_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` |

<!-- mdformat on(autogenerated might break rendering in catalog) -->

Expand All @@ -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.<br>_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` |

<!-- mdformat on(autogenerated might break rendering in catalog) -->

Expand All @@ -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.<br>_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` |

<!-- mdformat on(autogenerated might break rendering in catalog) -->

Expand Down
19 changes: 11 additions & 8 deletions docs/components/checkbox.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,11 @@ dirname: checkbox

<!--*
# Document freshness: For more information, see go/fresh-source.
freshness: { owner: 'emarquez' reviewed: '2023-05-03' }
freshness: {
owner: 'emarquez'
owner: 'lizmitchell'
reviewed: '2023-11-10'
}
tag: 'docType:reference'
*-->

Expand Down Expand Up @@ -164,7 +168,6 @@ Token | Default value

## API


### MdCheckbox <code>&lt;md-checkbox&gt;</code>

#### Properties
Expand All @@ -178,12 +181,12 @@ Property | Attribute | Type | Default | Description
`indeterminate` | `indeterminate` | `boolean` | `false` | Whether or not the checkbox is indeterminate.<br>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.<br>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.<br>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` |

<!-- mdformat on(autogenerated might break rendering in catalog) -->

Expand Down
6 changes: 3 additions & 3 deletions docs/components/elevation.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

<!--*
# Document freshness: For more information, see go/fresh-source.
freshness: { owner: 'lizmitchell' reviewed: '2023-04-10' }
freshness: { owner: 'lizmitchell' reviewed: '2023-11-10' }
tag: 'docType:reference'
*-->

Expand All @@ -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.")

Expand Down
62 changes: 30 additions & 32 deletions docs/components/icon-button.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ dirname: iconbutton

<!--*
# Document freshness: For more information, see go/fresh-source.
freshness: { owner: 'dfreedm' reviewed: '2023-04-03' }
freshness: { owner: 'lizmitchell' reviewed: '2023-09-11' }
tag: 'docType:reference'
*-->

Expand Down Expand Up @@ -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
<div>
<md-icon-button toggle>
Expand Down Expand Up @@ -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)<!-- {.external} -->
attribute to buttons whose labels need a more descriptive label.
attribute to icon buttons whose labels need a more descriptive label.

```html
<md-icon-button aria-label="Search for Contact">
Expand All @@ -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
<md-icon-button toggle
Expand All @@ -194,13 +198,8 @@ descriptive label when selected.

## Icon Button

Use
[icon buttons](https://m3.material.io/components/icon-buttons/guidelines)<!-- {.external} -->
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.

<!-- no-catalog-start -->

Expand Down Expand Up @@ -429,7 +428,6 @@ Token | Default value

## API


### MdIconButton <code>&lt;md-icon-button&gt;</code>

#### Properties
Expand All @@ -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` |

<!-- mdformat on(autogenerated might break rendering in catalog) -->

Expand All @@ -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` |

<!-- mdformat on(autogenerated might break rendering in catalog) -->

Expand All @@ -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` |

<!-- mdformat on(autogenerated might break rendering in catalog) -->

Expand All @@ -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` |

<!-- mdformat on(autogenerated might break rendering in catalog) -->

Expand Down

0 comments on commit 5ce1ab8

Please sign in to comment.