Skip to content

Commit

Permalink
docs: update component READMEs (#6337)
Browse files Browse the repository at this point in the history
This PR was automatically generated by the update-doc GitHub action

Co-authored-by: jcfranco <[email protected]>
Co-authored-by: Ben Elan <[email protected]>
  • Loading branch information
3 people authored Jan 25, 2023
1 parent e84fa66 commit 0767821
Showing 1 changed file with 12 additions and 9 deletions.
21 changes: 12 additions & 9 deletions src/components/tree-item/readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,18 +6,21 @@

## Properties

| Property | Attribute | Description | Type | Default |
| ---------- | ---------- | ---------------------------------------------------------------------------------------- | --------- | ------- |
| `disabled` | `disabled` | When `true`, interaction is prevented and the component is displayed with lower opacity. | `boolean` | `false` |
| `expanded` | `expanded` | When `true`, the component is expanded. | `boolean` | `false` |
| `selected` | `selected` | When `true`, the component is selected. | `boolean` | `false` |
| Property | Attribute | Description | Type | Default |
| ------------- | --------------- | -------------------------------------------------------------------------------------------- | ---------------------------- | ----------- |
| `disabled` | `disabled` | When `true`, interaction is prevented and the component is displayed with lower opacity. | `boolean` | `false` |
| `expanded` | `expanded` | When `true`, the component is expanded. | `boolean` | `false` |
| `iconFlipRtl` | `icon-flip-rtl` | When `true`, the icon will be flipped when the element direction is right-to-left (`"rtl"`). | `"both" \| "end" \| "start"` | `undefined` |
| `iconStart` | `icon-start` | Specifies an icon to display at the start of the component. | `string` | `undefined` |
| `selected` | `selected` | When `true`, the component is selected. | `boolean` | `false` |

## Slots

| Slot | Description |
| ------------ | ------------------------------------------------- |
| | A slot for adding text. |
| `"children"` | A slot for adding nested `calcite-tree` elements. |
| Slot | Description |
| --------------- | ----------------------------------------------------------------------------------------------------- |
| | A slot for adding text. |
| `"actions-end"` | A slot for adding actions to the end of the component. It is recommended to use two or fewer actions. |
| `"children"` | A slot for adding nested `calcite-tree` elements. |

## Dependencies

Expand Down

0 comments on commit 0767821

Please sign in to comment.