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 #5501

Merged
merged 1 commit into from
Oct 18, 2022
Merged

docs: update component READMEs #5501

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
4 changes: 2 additions & 2 deletions src/components/accordion-item/readme.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,9 +8,9 @@ individual `calcite-accordion` item

| Property | Attribute | Description | Type | Default |
| -------------- | --------------- | ---------------------------------------------------------------------------------------------------------------------------- | --------- | ----------- |
| `active` | `active` | <span style="color:red">**[DEPRECATED]**</span> use expanded instead<br/><br/>When true, the component is active. | `boolean` | `false` |
| `active` | `active` | <span style="color:red">**[DEPRECATED]**</span> use `expanded` instead.<br/><br/>When `true`, the component is active. | `boolean` | `false` |
| `description` | `description` | Specifies a description for the component. | `string` | `undefined` |
| `expanded` | `expanded` | When true, item is expanded | `boolean` | `false` |
| `expanded` | `expanded` | When `true`, the component is expanded. | `boolean` | `false` |
| `heading` | `heading` | Specifies heading text for the component. | `string` | `undefined` |
| `icon` | `icon` | <span style="color:red">**[DEPRECATED]**</span> use `iconStart` or `iconEnd` instead.<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` |
Expand Down
14 changes: 7 additions & 7 deletions src/components/accordion/readme.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,13 +18,13 @@

## Properties

| Property | Attribute | Description | Type | Default |
| --------------- | ---------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------- | ----------- |
| `appearance` | `appearance` | Specifies the appearance of the component. | `"default" \| "minimal" \| "solid" \| "transparent"` | `"solid"` |
| `iconPosition` | `icon-position` | Specifies the placement of the icon in the header. | `"end" \| "start"` | `"end"` |
| `iconType` | `icon-type` | Specifies the type of the icon in the header. | `"caret" \| "chevron" \| "plus-minus"` | `"chevron"` |
| `scale` | `scale` | Specifies the size of the component. | `"l" \| "m" \| "s"` | `"m"` |
| `selectionMode` | `selection-mode` | Specifies the selection mode - "multi" (allow any number of open items), "single" (allow one open item), or "single-persist" (allow and require one open item). | `"multi" \| "single" \| "single-persist"` | `"multi"` |
| Property | Attribute | Description | Type | Default |
| --------------- | ---------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------- | ----------- |
| `appearance` | `appearance` | Specifies the appearance of the component. | `"default" \| "minimal" \| "solid" \| "transparent"` | `"solid"` |
| `iconPosition` | `icon-position` | Specifies the placement of the icon in the header. | `"end" \| "start"` | `"end"` |
| `iconType` | `icon-type` | Specifies the type of the icon in the header. | `"caret" \| "chevron" \| "plus-minus"` | `"chevron"` |
| `scale` | `scale` | Specifies the size of the component. | `"l" \| "m" \| "s"` | `"m"` |
| `selectionMode` | `selection-mode` | Specifies the selection mode - `"multi"` (allow any number of open items), `"single"` (allow one open item), or `"single-persist"` (allow and require one open item). | `"multi" \| "single" \| "single-persist"` | `"multi"` |

## Slots

Expand Down
4 changes: 2 additions & 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 @@ -63,8 +63,8 @@ Renders a group of `calcite-action`s contained in a `calcite-action-group`. Acti

| 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` |
| `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"` |
Expand Down
10 changes: 5 additions & 5 deletions src/components/action-group/readme.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,10 +9,10 @@ The `calcite-action-group` is a wrapper for multiple `calcite-action`s and house
| 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` |
| `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` |
| `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` |

## Slots
Expand All @@ -25,9 +25,9 @@ The `calcite-action-group` is a wrapper for multiple `calcite-action`s and house

## CSS Custom Properties

| Name | Description |
| -------------------------------- | -------------------------------------------------------------------------- |
| `--calcite-action-group-columns` | Sets number of grid-template-columns when the `layout` property is "grid". |
| Name | Description |
| -------------------------------- | ---------------------------------------------------------------------------- |
| `--calcite-action-group-columns` | Sets number of grid-template-columns when the `layout` property is `"grid"`. |

## Dependencies

Expand Down
4 changes: 2 additions & 2 deletions src/components/action-menu/readme.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,10 +6,10 @@

| Property | Attribute | Description | Type | Default |
| -------------------- | --------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------- | ------------ |
| `expanded` | `expanded` | When true, the component is expanded. | `boolean` | `false` |
| `expanded` | `expanded` | When `true`, the component is expanded. | `boolean` | `false` |
| `flipPlacements` | -- | Defines the available placements that can be used when a flip occurs. | `Placement[]` | `undefined` |
| `label` _(required)_ | `label` | Specifies the text string for the component. | `string` | `undefined` |
| `open` | `open` | When true, the component is open. | `boolean` | `false` |
| `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`. | `Placement \| VariationPlacement \| AutoPlacement \| DeprecatedPlacement` | `"auto"` |
| `scale` | `scale` | Specifies the size of the component's trigger `calcite-action`. | `"l" \| "m" \| "s"` | `undefined` |
Expand Down
4 changes: 2 additions & 2 deletions src/components/action-pad/readme.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -52,8 +52,8 @@ Renders a group of `calcite-action`s contained in a `calcite-action-group`. Acti

| 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` |
| `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"` |
Expand Down
Loading