Skip to content
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

docs: update component READMEs #6052

Merged
merged 1 commit into from
Dec 15, 2022
Merged

docs: update component READMEs #6052

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
3 changes: 1 addition & 2 deletions src/components/action-bar/readme.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -65,9 +65,8 @@ Renders a group of `calcite-action`s contained in a `calcite-action-group`. Acti
| ------------------------- | --------------------------- | ------------------------------------------------------------------------------- | ---------------------------- | ------------ |
| `expandDisabled` | `expand-disabled` | When `true`, the expand-toggling behavior is disabled. | `boolean` | `false` |
| `expanded` | `expanded` | When `true`, the component is expanded. | `boolean` | `false` |
| `intlCollapse` | `intl-collapse` | Specifies the label of the collapse icon when the component is expanded. | `string` | `undefined` |
| `intlExpand` | `intl-expand` | Specifies the label of the expand icon when the component is collapsed. | `string` | `undefined` |
| `layout` | `layout` | The layout direction of the actions. | `"horizontal" \| "vertical"` | `"vertical"` |
| `messageOverrides` | `message-overrides` | Use this property to override individual strings used by the component. | `Messages` | `undefined` |
| `overflowActionsDisabled` | `overflow-actions-disabled` | Disables automatically overflowing `calcite-action`s that won't fit into menus. | `boolean` | `false` |
| `position` | `position` | Arranges the component depending on the element's `dir` property. | `"end" \| "start"` | `undefined` |
| `scale` | `scale` | Specifies the size of the expand `calcite-action`. | `"l" \| "m" \| "s"` | `undefined` |
Expand Down
16 changes: 8 additions & 8 deletions src/components/action-group/readme.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,14 +6,14 @@ The `calcite-action-group` is a wrapper for multiple `calcite-action`s and house

## Properties

| Property | Attribute | Description | Type | Default |
| ---------- | ----------- | ------------------------------------------------------ | -------------------------------------- | ------------ |
| `columns` | `columns` | Indicates number of columns. | `1 \| 2 \| 3 \| 4 \| 5 \| 6` | `undefined` |
| `expanded` | `expanded` | When `true`, the component is expanded. | `boolean` | `false` |
| `intlMore` | `intl-more` | Specifies a text string for the `calcite-action-menu`. | `string` | `undefined` |
| `layout` | `layout` | Indicates the layout of the component. | `"grid" \| "horizontal" \| "vertical"` | `"vertical"` |
| `menuOpen` | `menu-open` | When `true`, the `calcite-action-menu` is open. | `boolean` | `false` |
| `scale` | `scale` | Specifies the size of the `calcite-action-menu`. | `"l" \| "m" \| "s"` | `undefined` |
| Property | Attribute | Description | Type | Default |
| ------------------ | ------------------- | ----------------------------------------------------------------------- | -------------------------------------- | ------------ |
| `columns` | `columns` | Indicates number of columns. | `1 \| 2 \| 3 \| 4 \| 5 \| 6` | `undefined` |
| `expanded` | `expanded` | When `true`, the component is expanded. | `boolean` | `false` |
| `layout` | `layout` | Indicates the layout of the component. | `"grid" \| "horizontal" \| "vertical"` | `"vertical"` |
| `menuOpen` | `menu-open` | When `true`, the `calcite-action-menu` is open. | `boolean` | `false` |
| `messageOverrides` | `message-overrides` | Use this property to override individual strings used by the component. | `Messages` | `undefined` |
| `scale` | `scale` | Specifies the size of the `calcite-action-menu`. | `"l" \| "m" \| "s"` | `undefined` |

## Slots

Expand Down
17 changes: 8 additions & 9 deletions src/components/action-pad/readme.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -50,15 +50,14 @@ Renders a group of `calcite-action`s contained in a `calcite-action-group`. Acti

## Properties

| Property | Attribute | Description | Type | Default |
| ---------------- | ----------------- | ------------------------------------------------------------------------ | -------------------------------------- | ------------ |
| `expandDisabled` | `expand-disabled` | When `true`, the expand-toggling behavior is disabled. | `boolean` | `false` |
| `expanded` | `expanded` | When `true`, the component is expanded. | `boolean` | `false` |
| `intlCollapse` | `intl-collapse` | Specifies the label of the collapse icon when the component is expanded. | `string` | `undefined` |
| `intlExpand` | `intl-expand` | Specifies the label of the expand icon when the component is collapsed. | `string` | `undefined` |
| `layout` | `layout` | Indicates the layout of the component. | `"grid" \| "horizontal" \| "vertical"` | `"vertical"` |
| `position` | `position` | Arranges the component depending on the element's `dir` property. | `"end" \| "start"` | `undefined` |
| `scale` | `scale` | Specifies the size of the expand `calcite-action`. | `"l" \| "m" \| "s"` | `undefined` |
| Property | Attribute | Description | Type | Default |
| ------------------ | ------------------- | ----------------------------------------------------------------------- | -------------------------------------- | ------------ |
| `expandDisabled` | `expand-disabled` | When `true`, the expand-toggling behavior is disabled. | `boolean` | `false` |
| `expanded` | `expanded` | When `true`, the component is expanded. | `boolean` | `false` |
| `layout` | `layout` | Indicates the layout of the component. | `"grid" \| "horizontal" \| "vertical"` | `"vertical"` |
| `messageOverrides` | `message-overrides` | Use this property to override individual strings used by the component. | `Messages` | `undefined` |
| `position` | `position` | Arranges the component depending on the element's `dir` property. | `"end" \| "start"` | `undefined` |
| `scale` | `scale` | Specifies the size of the expand `calcite-action`. | `"l" \| "m" \| "s"` | `undefined` |

## Events

Expand Down
31 changes: 15 additions & 16 deletions src/components/action/readme.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -42,22 +42,21 @@ Renders a `calcite-action` that displays only an icon.

## Properties

| Property | Attribute | Description | Type | Default |
| ------------------- | ---------------- | --------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------ | ---------------- |
| `active` | `active` | When `true`, the component is highlighted. | `boolean` | `false` |
| `alignment` | `alignment` | Specifies the horizontal alignment of button elements with text content. | `"center" \| "end" \| "start"` | `undefined` |
| `appearance` | `appearance` | Specifies the appearance of the component. | `"solid" \| "transparent"` | `"solid"` |
| `compact` | `compact` | When `true`, the side padding of the component is reduced. Compact mode is used internally by components, e.g. `calcite-block-section`. | `boolean` | `false` |
| `disabled` | `disabled` | When `true`, interaction is prevented and the component is displayed with lower opacity. | `boolean` | `false` |
| `icon` | `icon` | Specifies an icon to display. | `string` | `undefined` |
| `indicator` | `indicator` | When `true`, displays a visual indicator. | `boolean` | `false` |
| `intlIndicator` | `intl-indicator` | When `indicator` is `true`, specifies the accessible context of the `indicator`. | `string` | `TEXT.indicator` |
| `intlLoading` | `intl-loading` | Specifies the text label to display while loading. | `string` | `TEXT.loading` |
| `label` | `label` | Specifies the label of the component. If no label is provided, the label inherits what's provided for the `text` prop. | `string` | `undefined` |
| `loading` | `loading` | When `true`, a busy indicator is displayed. | `boolean` | `false` |
| `scale` | `scale` | Specifies the size of the component. | `"l" \| "m" \| "s"` | `"m"` |
| `text` _(required)_ | `text` | Specifies text that accompanies the icon. | `string` | `undefined` |
| `textEnabled` | `text-enabled` | Indicates whether the text is displayed. | `boolean` | `false` |
| Property | Attribute | Description | Type | Default |
| ------------------- | ------------------- | --------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------ | ----------- |
| `active` | `active` | When `true`, the component is highlighted. | `boolean` | `false` |
| `alignment` | `alignment` | Specifies the horizontal alignment of button elements with text content. | `"center" \| "end" \| "start"` | `undefined` |
| `appearance` | `appearance` | Specifies the appearance of the component. | `"solid" \| "transparent"` | `"solid"` |
| `compact` | `compact` | When `true`, the side padding of the component is reduced. Compact mode is used internally by components, e.g. `calcite-block-section`. | `boolean` | `false` |
| `disabled` | `disabled` | When `true`, interaction is prevented and the component is displayed with lower opacity. | `boolean` | `false` |
| `icon` | `icon` | Specifies an icon to display. | `string` | `undefined` |
| `indicator` | `indicator` | When `true`, displays a visual indicator. | `boolean` | `false` |
| `label` | `label` | Specifies the label of the component. If no label is provided, the label inherits what's provided for the `text` prop. | `string` | `undefined` |
| `loading` | `loading` | When `true`, a busy indicator is displayed. | `boolean` | `false` |
| `messageOverrides` | `message-overrides` | Use this property to override individual strings used by the component. | `Messages` | `undefined` |
| `scale` | `scale` | Specifies the size of the component. | `"l" \| "m" \| "s"` | `"m"` |
| `text` _(required)_ | `text` | Specifies text that accompanies the icon. | `string` | `undefined` |
| `textEnabled` | `text-enabled` | Indicates whether the text is displayed. | `boolean` | `false` |

## Methods

Expand Down
Loading