Skip to content

Commit

Permalink
docs: update component READMEs (#6288)
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 Jan 18, 2023
1 parent 2d76ec7 commit a81d969
Show file tree
Hide file tree
Showing 2 changed files with 25 additions and 23 deletions.
40 changes: 21 additions & 19 deletions src/components/modal/readme.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -55,20 +55,20 @@ modal.beforeClose = beforeClose;

## Properties

| Property | Attribute | Description | Type | Default |
| ---------------------- | ------------------------ | ------------------------------------------------------------------------------------------------ | --------------------------------------------------------- | ------------------------- |
| `beforeClose` | -- | Passes a function to run before the component closes. | `(el: HTMLElement) => Promise<void>` | `() => Promise.resolve()` |
| `closeButtonDisabled` | `close-button-disabled` | When `true`, disables the component's close button. | `boolean` | `false` |
| `docked` | `docked` | When `true`, prevents the component from expanding to the entire screen on mobile devices. | `boolean` | `undefined` |
| `escapeDisabled` | `escape-disabled` | When `true`, disables the default close on escape behavior. | `boolean` | `false` |
| `focusTrapDisabled` | `focus-trap-disabled` | When `true`, prevents focus trapping. | `boolean` | `false` |
| `fullscreen` | `fullscreen` | Sets the component to always be fullscreen (overrides `width`). | `boolean` | `undefined` |
| `kind` | `kind` | Specifies the kind of the component (will apply to top border). | `"brand" \| "danger" \| "info" \| "success" \| "warning"` | `undefined` |
| `messageOverrides` | `message-overrides` | Use this property to override individual strings used by the component. | `ModalMessages` | `undefined` |
| `open` | `open` | When `true`, displays and positions the component. | `boolean` | `false` |
| `outsideCloseDisabled` | `outside-close-disabled` | When `true`, disables the closing of the component when clicked outside. | `boolean` | `false` |
| `scale` | `scale` | Specifies the size of the component. | `"l" \| "m" \| "s"` | `"m"` |
| `width` | `width` | Specifies the width of the component. Can use scale sizes or pass a number (displays in pixels). | `"l" \| "m" \| "s" \| number` | `"m"` |
| Property | Attribute | Description | Type | Default |
| ---------------------- | ------------------------ | ---------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------- | ------------------------- |
| `beforeClose` | -- | Passes a function to run before the component closes. | `(el: HTMLElement) => Promise<void>` | `() => Promise.resolve()` |
| `closeButtonDisabled` | `close-button-disabled` | When `true`, disables the component's close button. | `boolean` | `false` |
| `docked` | `docked` | When `true`, prevents the component from expanding to the entire screen on mobile devices. | `boolean` | `undefined` |
| `escapeDisabled` | `escape-disabled` | When `true`, disables the default close on escape behavior. | `boolean` | `false` |
| `focusTrapDisabled` | `focus-trap-disabled` | When `true`, prevents focus trapping. | `boolean` | `false` |
| `fullscreen` | `fullscreen` | Sets the component to always be fullscreen (overrides `width` and `--calcite-modal-width` / `--calcite-modal-height`). | `boolean` | `undefined` |
| `kind` | `kind` | Specifies the kind of the component (will apply to top border). | `"brand" \| "danger" \| "info" \| "success" \| "warning"` | `undefined` |
| `messageOverrides` | `message-overrides` | Use this property to override individual strings used by the component. | `ModalMessages` | `undefined` |
| `open` | `open` | When `true`, displays and positions the component. | `boolean` | `false` |
| `outsideCloseDisabled` | `outside-close-disabled` | When `true`, disables the closing of the component when clicked outside. | `boolean` | `false` |
| `scale` | `scale` | Specifies the size of the component. | `"l" \| "m" \| "s"` | `"m"` |
| `width` | `width` | Specifies the width of the component. | `"l" \| "m" \| "s"` | `"m"` |

## Events

Expand Down Expand Up @@ -117,11 +117,13 @@ Type: `Promise<void>`

## CSS Custom Properties

| Name | Description |
| ------------------------------------ | ----------------------------------------------------------------------- |
| `--calcite-modal-content-background` | Specifies the background color of content placed in the `content` slot. |
| `--calcite-modal-content-padding` | Specifies the padding of the modal `content` slot. |
| `--calcite-modal-scrim-background` | Specifies the background color of the modal scrim. |
| Name | Description |
| ------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| `--calcite-modal-content-background` | Specifies the background color of content placed in the `content` slot. |
| `--calcite-modal-content-padding` | Specifies the padding of the modal `content` slot. |
| `--calcite-modal-height` | Specifies a height of the modal, using `px`, `em`, `rem`, `vh`, or `%`. Will never exceed the height of the viewport. Will not apply if `fullscreen` if set. |
| `--calcite-modal-scrim-background` | Specifies the background color of the modal scrim. |
| `--calcite-modal-width` | Specifies a width of the modal, using `px`, `em`, `rem`, `vw`, or `%`. Will never exceed the width of the viewport. Will not apply if `fullscreen` if set. |

## Dependencies

Expand Down
8 changes: 4 additions & 4 deletions src/components/tip/readme.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -23,17 +23,17 @@ Renders a close-disabled tip with a heading, thumbnail, info and a link.
| Property | Attribute | Description | Type | Default |
| ------------------ | ------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------ | ---------------------------- | ----------- |
| `closeDisabled` | `close-disabled` | When `true`, the close button is not present on the component. | `boolean` | `false` |
| `dismissed` | `dismissed` | When `true`, the component does not display. | `boolean` | `false` |
| `closed` | `closed` | When `true`, the component does not display. | `boolean` | `false` |
| `heading` | `heading` | The component header text. | `string` | `undefined` |
| `headingLevel` | `heading-level` | Specifies the number at which section headings should start. | `1 \| 2 \| 3 \| 4 \| 5 \| 6` | `undefined` |
| `messageOverrides` | `message-overrides` | Use this property to override individual strings used by the component. | `TipMessages` | `undefined` |
| `selected` | `selected` | When `true`, the component is selected if it has a parent `calcite-tip-manager`. Only one tip can be selected within the `calcite-tip-manager` parent. | `boolean` | `false` |

## Events

| Event | Description | Type |
| ------------------- | -------------------------------------------- | ------------------- |
| `calciteTipDismiss` | Emits when the component has been dismissed. | `CustomEvent<void>` |
| Event | Description | Type |
| ------------------- | ----------------------------------------- | ------------------- |
| `calciteTipDismiss` | Emits when the component has been closed. | `CustomEvent<void>` |

## Slots

Expand Down

0 comments on commit a81d969

Please sign in to comment.