Skip to content

Commit

Permalink
docs: update component READMEs (#5874)
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 <jcfranco@users.noreply.github.com>
  • Loading branch information
@calcite-admin @jcfranco
calcite-admin and jcfranco authored Dec 2, 2022
1 parent 3ed53e7 commit 70098e2
Show file tree
Hide file tree
Showing 6 changed files with 25 additions and 31 deletions.
1 change: 0 additions & 1 deletion src/components/dropdown-item/readme.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,6 @@

| Property | Attribute | Description | Type | Default |
| ------------- | --------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------- | ----------- |
| `active` | `active` | <span style="color:red">**[DEPRECATED]**</span> Use `selected` instead.<br/><br/>When `true`, the component is selected. | `boolean` | `false` |
| `href` | `href` | Specifies the URL of the linked resource, which can be set as an absolute or relative path. Determines if the component will render as an anchor. | `string` | `undefined` |
| `iconEnd` | `icon-end` | Specifies an icon to display at the end of the component. | `string` | `undefined` |
| `iconFlipRtl` | `icon-flip-rtl` | When `true`, the icon will be flipped when the element direction is right-to-left (`"rtl"`). | `"both" \| "end" \| "start"` | `undefined` |
Expand Down
11 changes: 5 additions & 6 deletions src/components/dropdown/readme.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ A `calcite-dropdown` can be used to provide an absolutely positioned set of sele
<calcite-button slot="dropdown-trigger">Open Dropdown</calcite-button>
<calcite-dropdown-group>
<calcite-dropdown-item>Relevance</calcite-dropdown-item>
<calcite-dropdown-item active>Date modified</calcite-dropdown-item>
<calcite-dropdown-item selected>Date modified</calcite-dropdown-item>
<calcite-dropdown-item>Title</calcite-dropdown-item>
</calcite-dropdown-group>
</calcite-dropdown>
Expand All @@ -28,7 +28,7 @@ You can choose to leave the dropdown open when an item is selected with the `dis
<calcite-button id="trigger" slot="dropdown-trigger">Open dropdown</calcite-button>
<calcite-dropdown-group id="group-1" selection-mode="single">
<calcite-dropdown-item id="item-1"> Dropdown Item Content </calcite-dropdown-item>
<calcite-dropdown-item id="item-2" active> Dropdown Item Content </calcite-dropdown-item>
<calcite-dropdown-item id="item-2" selected> Dropdown Item Content </calcite-dropdown-item>
<calcite-dropdown-item id="item-3"> Dropdown Item Content </calcite-dropdown-item>
</calcite-dropdown-group>
</calcite-dropdown>
Expand All @@ -43,17 +43,17 @@ You can combine groups in a single dropdown, with varying selection modes:
<calcite-button slot="dropdown-trigger">Open Dropdown</calcite-button>
<calcite-dropdown-group group-title="Select one">
<calcite-dropdown-item>Apple</calcite-dropdown-item>
<calcite-dropdown-item active>Orange</calcite-dropdown-item>
<calcite-dropdown-item selected>Orange</calcite-dropdown-item>
<calcite-dropdown-item>Grape</calcite-dropdown-item>
</calcite-dropdown-group>
<calcite-dropdown-group group-title="Select multi" selection-mode="multi">
<calcite-dropdown-item>Asparagus</calcite-dropdown-item>
<calcite-dropdown-item active>Potato</calcite-dropdown-item>
<calcite-dropdown-item selected>Potato</calcite-dropdown-item>
<calcite-dropdown-item>Yam</calcite-dropdown-item>
</calcite-dropdown-group>
<calcite-dropdown-group group-title="Select none (useful for actions)" selection-mode="none">
<calcite-dropdown-item>Plant beans</calcite-dropdown-item>
<calcite-dropdown-item active>Add peas</calcite-dropdown-item>
<calcite-dropdown-item selected>Add peas</calcite-dropdown-item>
</calcite-dropdown-group>
</calcite-dropdown>
```
Expand All @@ -62,7 +62,6 @@ You can combine groups in a single dropdown, with varying selection modes:

| Property | Attribute | Description | Type | Default |
| ---------------------- | ------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------- | ---------------------- |
| `active` | `active` | <span style="color:red">**[DEPRECATED]**</span> use `open` instead.<br/><br/>When `true`, displays and positions the component. | `boolean` | `false` |
| `disableCloseOnSelect` | `disable-close-on-select` | When `true`, the component will remain open after a selection is made. If the `selectionMode` of the selected `calcite-dropdown-item`'s containing `calcite-dropdown-group` is `"none"`, the component will always close. | `boolean` | `false` |
| `disabled` | `disabled` | When `true`, interaction is prevented and the component is displayed with lower opacity. | `boolean` | `false` |
| `flipPlacements` | -- | Defines the available placements that can be used when a flip occurs. | `Placement[]` | `undefined` |
Expand Down
16 changes: 7 additions & 9 deletions src/components/radio-group-item/readme.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -4,15 +4,13 @@

## Properties

| Property | Attribute | Description | Type | Default |
| -------------- | --------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------ | ----------- |
| `checked` | `checked` | When `true`, the component is checked. | `boolean` | `false` |
| `icon` | `icon` | <span style="color:red">**[DEPRECATED]**</span> Use either `iconStart` or `iconEnd` but do not combine them with `icon` and `iconPosition`.<br/><br/>Specifies an icon to display. | `string` | `undefined` |
| `iconEnd` | `icon-end` | Specifies an icon to display at the end of the component. | `string` | `undefined` |
| `iconFlipRtl` | `icon-flip-rtl` | When `true`, the icon will be flipped when the element direction is right-to-left (`"rtl"`). | `boolean` | `false` |
| `iconPosition` | `icon-position` | <span style="color:red">**[DEPRECATED]**</span> Use either `iconStart` or `iconEnd` but do not combine them with `icon` and `iconPosition`.<br/><br/>Specifies the placement of the icon. | `"end" \| "start"` | `"start"` |
| `iconStart` | `icon-start` | Specifies an icon to display at the start of the component. | `string` | `undefined` |
| `value` | `value` | The component's value. | `any` | `undefined` |
| Property | Attribute | Description | Type | Default |
| ------------- | --------------- | -------------------------------------------------------------------------------------------- | --------- | ----------- |
| `checked` | `checked` | When `true`, the component is checked. | `boolean` | `false` |
| `iconEnd` | `icon-end` | Specifies an icon to display at the end of the component. | `string` | `undefined` |
| `iconFlipRtl` | `icon-flip-rtl` | When `true`, the icon will be flipped when the element direction is right-to-left (`"rtl"`). | `boolean` | `false` |
| `iconStart` | `icon-start` | Specifies an icon to display at the start of the component. | `string` | `undefined` |
| `value` | `value` | The component's value. | `any` | `undefined` |

## Dependencies

Expand Down
9 changes: 4 additions & 5 deletions src/components/slider/readme.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -59,11 +59,10 @@ If you'd like to allow an upper and lower value selection (two handles), you can

## Events

| Event | Description | Type |
| --------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------- |
| `calciteSliderChange` | Fires when the thumb is released on the component. **Note:** If you need to constantly listen to the drag event, use `calciteSliderInput` instead. | `CustomEvent<void>` |
| `calciteSliderInput` | Fires on all updates to the component. **Note:** Will be fired frequently during drag. If you are performing any expensive operations consider using a debounce or throttle to avoid locking up the main thread. | `CustomEvent<void>` |
| `calciteSliderUpdate` | <span style="color:red">**[DEPRECATED]**</span> use `calciteSliderInput` instead.<br/><br/>Fires on all updates to the component. **Note:** Will be fired frequently during drag. If you are performing any expensive operations consider using a debounce or throttle to avoid locking up the main thread. | `CustomEvent<void>` |
| Event | Description | Type |
| --------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------- |
| `calciteSliderChange` | Fires when the thumb is released on the component. **Note:** If you need to constantly listen to the drag event, use `calciteSliderInput` instead. | `CustomEvent<void>` |
| `calciteSliderInput` | Fires on all updates to the component. **Note:** Will be fired frequently during drag. If you are performing any expensive operations consider using a debounce or throttle to avoid locking up the main thread. | `CustomEvent<void>` |

## Methods

Expand Down
8 changes: 4 additions & 4 deletions src/components/split-button/readme.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -39,10 +39,10 @@ The calcite-split-button control is one that combines a button with a dropdown m

## Events

| Event | Description | Type |
| ---------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------ |
| `calciteSplitButtonPrimaryClick` | Fires when the primary button is clicked. **Note:** The event payload is deprecated, use separate mouse event listeners to get info about click. | `CustomEvent<any>` |
| `calciteSplitButtonSecondaryClick` | Fires when the dropdown menu is clicked. **Note:** The event payload is deprecated, use separate mouse event listeners to get info about click. | `CustomEvent<any>` |
| Event | Description | Type |
| ---------------------------------- | ----------------------------------------- | ------------------- |
| `calciteSplitButtonPrimaryClick` | Fires when the primary button is clicked. | `CustomEvent<void>` |
| `calciteSplitButtonSecondaryClick` | Fires when the dropdown menu is clicked. | `CustomEvent<void>` |

## Slots

Expand Down
11 changes: 5 additions & 6 deletions src/components/tree/readme.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -26,12 +26,11 @@

## Properties

| Property | Attribute | Description | Type | Default |
| --------------- | ---------------- | -------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | ---------- |
| `inputEnabled` | `input-enabled` | <span style="color:red">**[DEPRECATED]**</span> Use `selectionMode="ancestors"` for checkbox input.<br/><br/>Display input | `boolean` | `false` |
| `lines` | `lines` | Displays indentation guide lines. | `boolean` | `false` |
| `scale` | `scale` | Specifies the size of the component. | `"l" \| "m" \| "s"` | `"m"` |
| `selectionMode` | `selection-mode` | Customize how the component's selection works. | `"ancestors" \| "children" \| "multi" \| "multichildren" \| "multiple" \| "none" \| "single"` | `"single"` |
| Property | Attribute | Description | Type | Default |
| --------------- | ---------------- | ---------------------------------------------- | --------------------------------------------------------------------------------------------- | ---------- |
| `lines` | `lines` | Displays indentation guide lines. | `boolean` | `false` |
| `scale` | `scale` | Specifies the size of the component. | `"l" \| "m" \| "s"` | `"m"` |
| `selectionMode` | `selection-mode` | Customize how the component's selection works. | `"ancestors" \| "children" \| "multi" \| "multichildren" \| "multiple" \| "none" \| "single"` | `"single"` |

## Events

Expand Down

0 comments on commit 70098e2

Please sign in to comment.