diff --git a/.changeset/config.json b/.changeset/config.json index 42b7c627c..01c9940db 100644 --- a/.changeset/config.json +++ b/.changeset/config.json @@ -9,7 +9,6 @@ "updateInternalDependencies": "patch", "ignore": [ "@phase2/outline-core-accordion", - "@phase2/outline-core-alert", "@phase2/outline-core-breadcrumb", "@phase2/outline-core-card", "@phase2/outline-core-container", diff --git a/.changeset/twenty-colts-serve.md b/.changeset/twenty-colts-serve.md new file mode 100644 index 000000000..0e04612ba --- /dev/null +++ b/.changeset/twenty-colts-serve.md @@ -0,0 +1,13 @@ +--- +'@phase2/outline-form': patch +'@phase2/outline-storybook': patch +'@phase2/outline-examples': patch +'@phase2/outline-core-alert': patch +'@phase2/outline-core-link': patch +'@phase2/outline-docs': patch +'@phase2/outline-config': patch +'@phase2/outline-templates': patch +'@phase2/outline-core': patch +--- + +Cleaup and organization. diff --git a/packages/components/outline-core-alert/README.md b/packages/components/outline-core-alert/README.md new file mode 100644 index 000000000..51757992c --- /dev/null +++ b/packages/components/outline-core-alert/README.md @@ -0,0 +1,30 @@ +# outline-core-alert + +The Outline Core Alert component + +## Properties + +| Property | Attribute | Type | Default | Description | +|----------------------|------------------|-----------------------------------------------|---------|-----------------------------------------------| +| `adoptedStylesheets` | | `AdoptedStyleSheets` | | | +| `debug` | | `boolean` | false | | +| `isInteractive` | `is-interactive` | `boolean` | false | This is important context for screen readers. | +| `status` | `status` | `"info" \| "warning" \| "error" \| "success"` | "info" | | + +## Slots + +| Name | Description | +|--------------|------------------------------------------------| +| `default` | The alert contents. | +| `header` | The header in the alert. | +| `icon-end` | The icon to display at the end of the alert. | +| `icon-start` | The icon to display at the start of the alert. | + +## CSS Custom Properties + +| Property | Description | +|----------------------------|--------------------------------------------------| +| `--outline-alert--error` | background: The background color for the error alert. | +| `--outline-alert--info` | background: The background color for the info alert. | +| `--outline-alert--success` | background: The background color for the success alert. | +| `--outline-alert--warning` | background: The background color for the warning alert. | diff --git a/packages/components/outline-core-alert/docs/outline-core-alert.mdx b/packages/components/outline-core-alert/docs/outline-core-alert.mdx index f90579a01..9d4b9b556 100644 --- a/packages/components/outline-core-alert/docs/outline-core-alert.mdx +++ b/packages/components/outline-core-alert/docs/outline-core-alert.mdx @@ -1,5 +1,4 @@ import { Meta } from '@storybook/addon-docs'; - import '@phase2/outline-core-alert'; + Documentation Status: @TODO

This documentation is in need of completion as the component is built out.