Skip to content

docs: update component READMEs #9928

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
benelan merged 1 commit into from
Aug 1, 2024
Merged

docs: update component READMEs #9928

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
148 changes: 24 additions & 124 deletions packages/calcite-components/src/components.d.ts
View file
Open in desktop

Large diffs are not rendered by default.

16 changes: 8 additions & 8 deletions packages/calcite-components/src/components/accordion-item/readme.md
View file
Open in desktop

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion packages/calcite-components/src/components/action-menu/readme.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@
| `label` *(required)* | `label` | Specifies the text string for the component. | `string` | `undefined` |
| `open` | `open` | When `true`, the component is open. | `boolean` | `false` |
| `overlayPositioning` | `overlay-positioning` | Determines the type of positioning to use for the overlaid content. Using `"absolute"` will work for most cases. The component will be positioned inside of overflowing parent containers and will affect the container's layout. `"fixed"` should be used to escape an overflowing parent container, or when the reference element's `position` CSS property is `"fixed"`. | `"absolute" \| "fixed"` | `"absolute"` |
| `placement` | `placement` | Determines where the component will be positioned relative to the `referenceElement`. | `"auto" \| "top" \| "bottom" \| "left" \| "right" \| "top-start" \| "top-end" \| "bottom-start" \| "bottom-end" \| "left-start" \| "left-end" \| "right-start" \| "right-end" \| "leading" \| "trailing" \| "auto-start" \| "auto-end" \| "leading-start" \| "leading-end" \| "trailing-end" \| "trailing-start"` | `"auto"` |
| `placement` | `placement` | Determines where the component will be positioned relative to the `referenceElement`. | `"auto" \| "top" \| "bottom" \| "right" \| "left" \| "top-start" \| "top-end" \| "bottom-start" \| "bottom-end" \| "right-start" \| "right-end" \| "left-start" \| "left-end" \| "leading" \| "trailing" \| "auto-start" \| "auto-end" \| "leading-start" \| "leading-end" \| "trailing-end" \| "trailing-start"` | `"auto"` |
| `scale` | `scale` | Specifies the size of the component's trigger `calcite-action`. | `"l" \| "m" \| "s"` | `undefined` |

## Events
Expand Down
32 changes: 16 additions & 16 deletions packages/calcite-components/src/components/action/readme.md
View file
Open in desktop

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion packages/calcite-components/src/components/alert/readme.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ For comprehensive guidance on using and implementing `calcite-alert`, refer to t
| -------------------- | --------------------- | --------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------- | ----------- |
| `autoClose` | `auto-close` | When `true`, the component closes automatically. Recommended for passive, non-blocking alerts. | `boolean` | `false` |
| `autoCloseDuration` | `auto-close-duration` | Specifies the duration before the component automatically closes - only use with `autoClose`. | `"fast" \| "medium" \| "slow"` | `"medium"` |
| `icon` | `icon` | When `true`, shows a default recommended icon. Alternatively, pass a Calcite UI Icon name to display a specific icon. | `boolean \| IconName` | `undefined` |
| `icon` | `icon` | When `true`, shows a default recommended icon. Alternatively, pass a Calcite UI Icon name to display a specific icon. | `boolean \| string` | `undefined` |
| `iconFlipRtl` | `icon-flip-rtl` | When `true`, the icon will be flipped when the element direction is right-to-left (`"rtl"`). | `boolean` | `false` |
| `kind` | `kind` | Specifies the kind of the component, which will apply to top border and icon. | `"brand" \| "danger" \| "info" \| "success" \| "warning"` | `"brand"` |
| `label` *(required)* | `label` | Specifies an accessible name for the component. | `string` | `undefined` |
Expand Down
20 changes: 10 additions & 10 deletions packages/calcite-components/src/components/block-section/readme.md
View file
Open in desktop

Large diffs are not rendered by default.

32 changes: 16 additions & 16 deletions packages/calcite-components/src/components/block/readme.md
View file
Open in desktop

Large diffs are not rendered by default.

46 changes: 23 additions & 23 deletions packages/calcite-components/src/components/button/readme.md
View file
Open in desktop

Large diffs are not rendered by default.

28 changes: 14 additions & 14 deletions packages/calcite-components/src/components/chip/readme.md
View file
Open in desktop

Large diffs are not rendered by default.

30 changes: 15 additions & 15 deletions packages/calcite-components/src/components/combobox-item/readme.md
View file
Open in desktop

Large diffs are not rendered by default.

58 changes: 29 additions & 29 deletions packages/calcite-components/src/components/combobox/readme.md
View file
Open in desktop

Large diffs are not rendered by default.

1 change: 1 addition & 0 deletions packages/calcite-components/src/components/dialog/readme.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -99,6 +99,7 @@ Type: `Promise<void>`
| Name | Description |
| ----------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `--calcite-dialog-border-color` | Specifies the component's border color. |
| `--calcite-dialog-content-space` | Specifies the padding of the component's content. |
| `--calcite-dialog-footer-space` | Specifies the padding of the component's footer. |
| `--calcite-dialog-scrim-background-color` | Specifies the background color of the component's scrim. |
| `--calcite-dialog-size-x` | Specifies the width of the component, using `px`, `em`, `rem`, `vw`, or `%`. Does not exceed the viewport's width - applies when `placement="cover"` is set. |
Expand Down
22 changes: 11 additions & 11 deletions packages/calcite-components/src/components/dropdown-item/readme.md
View file
Open in desktop

Large diffs are not rendered by default.

24 changes: 12 additions & 12 deletions packages/calcite-components/src/components/fab/readme.md
View file
Open in desktop

Large diffs are not rendered by default.

12 changes: 6 additions & 6 deletions packages/calcite-components/src/components/icon/readme.md
View file
Open in desktop

Large diffs are not rendered by default.

10 changes: 6 additions & 4 deletions packages/calcite-components/src/components/input-date-picker/readme.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@ For comprehensive guidance on using and implementing `calcite-input-date-picker`
| `required` | `required` | When `true`, the component must have a value in order for the form to submit. | `boolean` | `false` |
| `scale` | `scale` | Specifies the size of the component. | `"l" \| "m" \| "s"` | `"m"` |
| `status` | `status` | Specifies the status of the input field, which determines message and icons. | `"idle" \| "invalid" \| "valid"` | `"idle"` |
| `validationIcon` | `validation-icon` | Specifies the validation icon to display under the component. | `boolean \| IconName` | `undefined` |
| `validationIcon` | `validation-icon` | Specifies the validation icon to display under the component. | `boolean \| string` | `undefined` |
| `validationMessage` | `validation-message` | Specifies the validation message to display under the component. | `string` | `undefined` |
| `validity` | -- | The current validation state of the component. | `{ valid: boolean; badInput: boolean; customError: boolean; patternMismatch: boolean; rangeOverflow: boolean; rangeUnderflow: boolean; stepMismatch: boolean; tooLong: boolean; tooShort: boolean; typeMismatch: boolean; valueMissing: boolean; }` | `{ valid: false, badInput: false, customError: false, patternMismatch: false, rangeOverflow: false, rangeUnderflow: false, stepMismatch: false, tooLong: false, tooShort: false, typeMismatch: false, valueMissing: false, }` |
| `value` | `value` | Selected date as a string in ISO format (`"yyyy-mm-dd"`). | `string \| string[]` | `""` |
Expand All @@ -54,14 +54,16 @@ Updates the position of the component.

#### Parameters

| Name | Type | Description |
| --------- | --------- | ----------- |
| `delayed` | `boolean` | |
| Name | Type | Description |
| --------- | --------- | -------------------------------------- |
| `delayed` | `boolean` | If true, the repositioning is delayed. |

#### Returns

Type: `Promise<void>`

void

### `setFocus() => Promise<void>`

Sets focus on the component.
Expand Down
2 changes: 1 addition & 1 deletion packages/calcite-components/src/components/input-message/readme.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ For comprehensive guidance on using and implementing `calcite-input-message`, re

| Property | Attribute | Description | Type | Default |
| ------------- | --------------- | -------------------------------------------------------------------------------------------- | -------------------------------- | ----------- |
| `icon` | `icon` | Specifies an icon to display. | `boolean \| IconName` | `undefined` |
| `icon` | `icon` | Specifies an icon to display. | `boolean \| string` | `undefined` |
| `iconFlipRtl` | `icon-flip-rtl` | When `true`, the icon will be flipped when the element direction is right-to-left (`"rtl"`). | `boolean` | `false` |
| `scale` | `scale` | Specifies the size of the component. | `"l" \| "m" \| "s"` | `"m"` |
| `status` | `status` | Specifies the status of the input field, which determines message and icons. | `"idle" \| "invalid" \| "valid"` | `"idle"` |
Expand Down
Loading