@cruglobal/cornerstone-components 0.1.0

package/dist/bundled/skills/cornerstone/references/components/button.md

@@ -0,0 +1,351 @@
+# Button
+
+**Full documentation:** https://cruglobal.github.io/cornerstone-design-system/components/button
+
+```html
+<cs-button>Save</cs-button>
+```
+
+```html
+<cs-button>
+  <cs-icon slot="start" name="settings"></cs-icon>
+  Settings
+  <cs-icon slot="end" name="keyboard_arrow_right"></cs-icon>
+</cs-button>
+```
+
+## Examples
+
+### Variant
+
+Use the `variant` attribute to set the button's [semantic variant](https://cruglobal.github.io/cornerstone-design-system/theming-overview#variants).
+
+```html
+<div class="cs-cluster cs-gap-2xs">
+  <cs-button variant="neutral">Neutral</cs-button>
+  <cs-button variant="brand">Brand</cs-button>
+  <cs-button variant="success">Success</cs-button>
+  <cs-button variant="warning">Warning</cs-button>
+  <cs-button variant="danger">Danger</cs-button>
+</div>
+```
+
+### Appearance
+
+Use the `appearance` attribute to change the button's visual appearance. Pair it with any `variant` for the full matrix.
+
+```html
+<div class="cs-stack">
+  <div class="cs-cluster cs-gap-2xs">
+    <cs-button appearance="accent" variant="neutral">Accent</cs-button>
+    <cs-button appearance="filled-outlined" variant="neutral">Filled-Outlined</cs-button>
+    <cs-button appearance="filled" variant="neutral">Filled</cs-button>
+    <cs-button appearance="outlined" variant="neutral">Outlined</cs-button>
+    <cs-button appearance="plain" variant="neutral">Plain</cs-button>
+  </div>
+  <div class="cs-cluster cs-gap-2xs">
+    <cs-button appearance="accent" variant="brand">Accent</cs-button>
+    <cs-button appearance="filled-outlined" variant="brand">Filled-Outlined</cs-button>
+    <cs-button appearance="filled" variant="brand">Filled</cs-button>
+    <cs-button appearance="outlined" variant="brand">Outlined</cs-button>
+    <cs-button appearance="plain" variant="brand">Plain</cs-button>
+  </div>
+  <div class="cs-cluster cs-gap-2xs">
+    <cs-button appearance="accent" variant="success">Accent</cs-button>
+    <cs-button appearance="filled-outlined" variant="success">Filled-Outlined</cs-button>
+    <cs-button appearance="filled" variant="success">Filled</cs-button>
+    <cs-button appearance="outlined" variant="success">Outlined</cs-button>
+    <cs-button appearance="plain" variant="success">Plain</cs-button>
+  </div>
+  <div class="cs-cluster cs-gap-2xs">
+    <cs-button appearance="accent" variant="warning">Accent</cs-button>
+    <cs-button appearance="filled-outlined" variant="warning">Filled-Outlined</cs-button>
+    <cs-button appearance="filled" variant="warning">Filled</cs-button>
+    <cs-button appearance="outlined" variant="warning">Outlined</cs-button>
+    <cs-button appearance="plain" variant="warning">Plain</cs-button>
+  </div>
+  <div class="cs-cluster cs-gap-2xs">
+    <cs-button appearance="accent" variant="danger">Accent</cs-button>
+    <cs-button appearance="filled-outlined" variant="danger">Filled-Outlined</cs-button>
+    <cs-button appearance="filled" variant="danger">Filled</cs-button>
+    <cs-button appearance="outlined" variant="danger">Outlined</cs-button>
+    <cs-button appearance="plain" variant="danger">Plain</cs-button>
+  </div>
+</div>
+```
+
+### Size
+
+Use the `size` attribute to change a button's size.
+
+```html
+<div class="cs-cluster cs-gap-2xs">
+  <cs-button size="xs">Extra Small</cs-button>
+  <cs-button size="s">Small</cs-button>
+  <cs-button size="m">Medium</cs-button>
+  <cs-button size="l">Large</cs-button>
+  <cs-button size="xl">Extra Large</cs-button>
+</div>
+```
+
+### Pill
+
+Use the `pill` attribute to give buttons rounded edges.
+
+```html
+<cs-button pill>Pill Button</cs-button>
+```
+
+### Link Button
+
+Set the `href` attribute to render the button as an `<a>` under the hood. Provides all the browser's native link behavior (e.g. [[CMD/CTRL/SHIFT]] + [[CLICK]]) plus the `rel`, `target`, and `download` attributes.
+
+```html
+<div class="cs-cluster cs-gap-2xs">
+  <cs-button href="https://example.com/">Link</cs-button>
+  <cs-button href="https://example.com/" target="_blank">New Window</cs-button>
+  <cs-button href="/assets/images/cornerstone-mark.svg" download="cornerstone-mark.svg">Download</cs-button>
+</div>
+```
+
+### Icon Button
+
+When an [icon](https://cruglobal.github.io/cornerstone-design-system/components/icon) is the only thing slotted into the label, the button becomes an icon button. Icon buttons work with any appearance or variant.
+
+```html
+<div class="cs-cluster cs-gap-2xs">
+  <cs-button variant="neutral" appearance="accent"><cs-icon name="home" label="Home"></cs-icon></cs-button>
+  <cs-button variant="neutral" appearance="outlined"><cs-icon name="home" label="Home"></cs-icon></cs-button>
+  <cs-button variant="neutral" appearance="filled"><cs-icon name="home" label="Home"></cs-icon></cs-button>
+  <cs-button variant="neutral" appearance="plain"><cs-icon name="home" label="Home"></cs-icon></cs-button>
+</div>
+```
+
+> **Warning**
+>
+> <strong>Give icon-only buttons a label.</strong><br />
+> With no text to announce, a screen reader has nothing to read. Add `label` to the icon (`<cs-icon name="home" label="Home">`) so the button has an accessible name.
+
+### Start & End Decorations
+
+Use the `start` and `end` slots to add presentational elements like `<cs-icon>` beside the button label.
+
+```html
+<div class="cs-cluster cs-gap-2xs">
+  <cs-button>
+    <cs-icon slot="start" name="settings"></cs-icon>
+    Settings
+  </cs-button>
+
+  <cs-button>
+    <cs-icon slot="end" name="undo"></cs-icon>
+    Refresh
+  </cs-button>
+
+  <cs-button>
+    <cs-icon slot="start" name="link"></cs-icon>
+    <cs-icon slot="end" name="open_in_new"></cs-icon>
+    Open
+  </cs-button>
+</div>
+```
+
+### Caret
+
+Use the `with-caret` attribute to add a dropdown indicator when a button triggers a dropdown, menu, or popover.
+
+```html
+<cs-button with-caret>Options</cs-button>
+```
+
+### Loading
+
+Use the `loading` attribute to put a button in a busy state. Its width stays the same, so adjacent elements don't shift.
+
+```html
+<div class="cs-cluster cs-gap-2xs">
+  <cs-button variant="brand" loading>Brand</cs-button>
+  <cs-button variant="success" loading>Success</cs-button>
+  <cs-button variant="neutral" loading>Neutral</cs-button>
+  <cs-button variant="warning" loading>Warning</cs-button>
+  <cs-button variant="danger" loading>Danger</cs-button>
+</div>
+```
+
+### Disabled
+
+Use the `disabled` attribute to disable a button. It works on link buttons too.
+
+```html
+<div class="cs-stack">
+  <div class="cs-cluster cs-gap-2xs">
+    <cs-button variant="brand" disabled>Brand</cs-button>
+    <cs-button variant="success" disabled>Success</cs-button>
+    <cs-button variant="neutral" disabled>Neutral</cs-button>
+    <cs-button variant="warning" disabled>Warning</cs-button>
+    <cs-button variant="danger" disabled>Danger</cs-button>
+  </div>
+
+  <div class="cs-cluster cs-gap-2xs">
+    <cs-button href="https://example.com/" disabled>Link</cs-button>
+    <cs-button href="https://example.com/" target="_blank" disabled>New Window</cs-button>
+    <cs-button href="/assets/images/cornerstone-mark.svg" download="cornerstone-mark.svg" disabled>Download</cs-button>
+  </div>
+</div>
+```
+
+### Custom Width
+
+Give a button a custom `width` to size it independently of its content — useful for making buttons span their container on smaller screens.
+
+```html
+<cs-button style="width: 100%;">Save</cs-button>
+```
+
+### Customizing
+
+Target the `button` part to restyle a button from the outside. Use a custom class when you're adding a new variation; to retheme an existing one, target its `variant` attribute instead (e.g. `cs-button[variant="brand"]`).
+
+Build the override out of [design tokens](https://cruglobal.github.io/cornerstone-design-system/tokens) rather than literal values, as below — a hue's tint scale gives you coordinated light and dark edges for free, and the radius, border width and spacing all have a step on the scale. Tokens are also what keeps a customization working across themes and colour schemes.
+
+```html
+<cs-button class="pink">Pink Button</cs-button>
+
+<style>
+  cs-button.pink::part(button) {
+    border-radius: var(--cs-border-radius-m);
+    border: solid var(--cs-border-width-m);
+    background: var(--cs-color-pink-40);
+    border-top-color: var(--cs-color-pink-60);
+    border-left-color: var(--cs-color-pink-60);
+    border-bottom-color: var(--cs-color-pink-20);
+    border-right-color: var(--cs-color-pink-20);
+    color: var(--cs-color-pink-95);
+    font-size: var(--cs-font-size-l);
+    box-shadow: var(--cs-shadow-m) var(--cs-color-pink-20);
+    transition: all var(--cs-transition-slow) var(--cs-transition-easing);
+  }
+
+  cs-button.pink::part(button):hover {
+    transform: scale(1.05);
+  }
+
+  /* Swapping the light and dark edges is what makes it read as pressed. */
+  cs-button.pink::part(button):active {
+    border-top-color: var(--cs-color-pink-20);
+    border-right-color: var(--cs-color-pink-60);
+    border-bottom-color: var(--cs-color-pink-60);
+    border-left-color: var(--cs-color-pink-20);
+    transform: translateY(var(--cs-space-3xs));
+  }
+
+  cs-button.pink::part(button):focus-visible {
+    outline: dashed var(--cs-border-width-m) var(--cs-color-pink-60);
+    outline-offset: var(--cs-space-2xs);
+  }
+</style>
+```
+
+## API
+
+### Importing
+
+If you're using the autoloader or a hosted project, components load on demand — no manual import
+needed. To cherry-pick this component, use one of the following snippets.
+
+**npm**
+
+```js
+import '@cruglobal/cornerstone-components/components/button/button.js';
+```
+
+**Self-Hosted**
+
+```js
+import './cornerstone/components/button/button.js';
+```
+
+**React**
+
+```js
+import CsButton from '@cruglobal/cornerstone-components/react/button/index.js';
+```
+
+### Slots
+
+Valid slot names for this component (use exactly these — any other `slot` value is silently ignored and the element falls back to the default slot):
+
+- `(default)` — The button's label.
+- `end` — An element, such as `<cs-icon>`, placed after the label.
+- `start` — An element, such as `<cs-icon>`, placed before the label.
+
+### Attributes & Properties
+
+| Property | Attribute | Description | Type | Default | Reflects |
+| --- | --- | --- | --- | --- | --- |
+| `appearance` | `appearance` | The button's visual appearance. | `'accent' \| 'filled' \| 'outlined' \| 'filled-outlined' \| 'plain'` | `'accent'` | Yes |
+| `disabled` | `disabled` | Disables the button. | `boolean` | `false` | — |
+| `download` | `download` | Tells the browser to download the linked file as this filename. Only used when `href` is present. | `string \| undefined` | — | — |
+| `form` | — | By default, form controls are associated with the nearest containing `<form>` element. This attribute allows you to place the form control outside of a form and associate it with the form that has this `id`. The form must be in the same document or shadow root for this to work. | `HTMLFormElement \| null` | — | — |
+| `formAction` | `formaction` | Used to override the form owner's `action` attribute. | `string` | — | — |
+| `formEnctype` | `formenctype` | Used to override the form owner's `enctype` attribute. | `'application/x-www-form-urlencoded' \| 'multipart/form-data' \| 'text/plain'` | — | — |
+| `formMethod` | `formmethod` | Used to override the form owner's `method` attribute. | `'post' \| 'get'` | — | — |
+| `formNoValidate` | `formnovalidate` | Used to override the form owner's `novalidate` attribute. | `boolean` | — | — |
+| `formTarget` | `formtarget` | Used to override the form owner's `target` attribute. | `'_self' \| '_blank' \| '_parent' \| '_top' \| string` | — | — |
+| `href` | `href` | When set, the underlying button will be rendered as an `<a>` with this `href` instead of a `<button>`. | `string` | — | Yes |
+| `loading` | `loading` | Draws the button in a loading state. | `boolean` | `false` | Yes |
+| `name` | `name` | The name of the button, submitted as a name/value pair with form data, but only when this button is the submitter. This attribute is ignored when `href` is present. | `string \| null` | `null` | Yes |
+| `pill` | `pill` | Draws a pill-style button with rounded edges. | `boolean` | `false` | Yes |
+| `rel` | `rel` | When using `href`, this attribute will map to the underlying link's `rel` attribute. | `string \| undefined` | — | — |
+| `size` | `size` | The button's size. | `'xs' \| 's' \| 'm' \| 'l' \| 'xl'` | `'m'` | Yes |
+| `target` | `target` | Tells the browser where to open the link. Only used when `href` is present. | `'_blank' \| '_parent' \| '_self' \| '_top'` | — | — |
+| `type` | `type` | The type of button. Note that the default value is `button` instead of `submit`, which is opposite of how native `<button>` elements behave. When the type is `submit`, the button will submit the surrounding form. | `'button' \| 'submit' \| 'reset'` | `'button'` | — |
+| `validationTarget` | — | Override this to change where constraint validation popups are anchored. | `undefined \| HTMLElement` | — | — |
+| `validators` | — | Validators are static because they have `observedAttributes`, essentially attributes to "watch" for changes. Whenever these attributes change, we want to be notified and update the validator. | `Validator[]` | `[]` | — |
+| `value` | `value` | The value of the button, submitted as a pair with the button's name as part of the form data, but only when this button is the submitter. This attribute is ignored when `href` is present. | `string` | — | Yes |
+| `variant` | `variant` | The button's theme variant. Defaults to `neutral` if not within another element with a variant. | `'neutral' \| 'brand' \| 'highlight' \| 'information' \| 'success' \| 'warning' \| 'danger'` | `'neutral'` | Yes |
+| `withCaret` | `with-caret` | Draws the button with a caret. Used to indicate that the button triggers a dropdown menu or similar behavior. | `boolean` | `false` | Yes |
+
+### Methods
+
+| Name | Description | Arguments |
+| --- | --- | --- |
+| `blur()` | Removes focus from the button. | — |
+| `click()` | Simulates a click on the button. | — |
+| `focus()` | Sets focus on the button. | `options: FocusOptions` |
+| `formStateRestoreCallback()` | Called when the browser is trying to restore element’s state to state in which case reason is "restore", or when the browser is trying to fulfill autofill on behalf of user in which case reason is "autocomplete". In the case of "restore", state is a string, File, or FormData object previously set as the second argument to setFormValue. | `state: string \| File \| FormData \| null, reason: 'autocomplete' \| 'restore'` |
+| `resetValidity()` | Reset validity is a way of removing manual custom errors and native validation. | — |
+| `setCustomValidity()` | Do not use this when creating a "Validator". This is intended for end users of components. We track manually defined custom errors so we don't clear them on accident in our validators. | `message: string` |
+
+### Events
+
+| Name | Description |
+| --- | --- |
+| `blur` | Emitted when the button loses focus. |
+| `cs-invalid` | Emitted when the form control has been checked for validity and its constraints aren't satisfied. |
+| `focus` | Emitted when the button gains focus. |
+
+### Custom States
+
+| Name | Description | CSS selector |
+| --- | --- | --- |
+| `disabled` | Applied when the button is disabled. | `:state(disabled)` |
+| `icon-button` | Applied when the button contains only a `<cs-icon>` with no other content. | `:state(icon-button)` |
+| `link` | Applied when the button is rendered as a link (i.e. `href` is set). | `:state(link)` |
+| `loading` | Applied when the button is in the loading state. | `:state(loading)` |
+
+### CSS Parts
+
+| Name | Description | CSS selector |
+| --- | --- | --- |
+| `button` | The component's outer wrapper. | `::part(button)` |
+| `caret` | The button's caret icon, a `<cs-icon>` element. | `::part(caret)` |
+| `end` | The container that wraps the `end` slot. | `::part(end)` |
+| `label` | The button's label. | `::part(label)` |
+| `spinner` | The spinner that shows when the button is in the loading state. | `::part(spinner)` |
+| `start` | The container that wraps the `start` slot. | `::part(start)` |
+
+### Dependencies
+
+- `<cs-icon>`
+- `<cs-spinner>`

package/dist/bundled/skills/cornerstone/references/components/callout.md

@@ -0,0 +1,189 @@
+# Callout
+
+**Full documentation:** https://cruglobal.github.io/cornerstone-design-system/components/callout
+
+```html
+<cs-callout>
+  <cs-icon slot="icon" name="info" variant="fill"></cs-icon>
+  This is a standard callout. You can customize its content and even the icon.
+</cs-callout>
+```
+
+## Examples
+
+### Variant
+
+Set the `variant` attribute to match the callout to its message.
+
+```html
+<div class="cs-stack">
+  <cs-callout variant="brand">
+    <cs-icon slot="icon" name="info" variant="fill"></cs-icon>
+    <strong>A new theme is available</strong><br />
+    Try it from Settings whenever you're ready.
+  </cs-callout>
+
+  <cs-callout variant="success">
+    <cs-icon slot="icon" name="check_circle" variant="fill"></cs-icon>
+    <strong>Your changes have been saved</strong><br />
+    You can safely close this tab now.
+  </cs-callout>
+
+  <cs-callout variant="neutral">
+    <cs-icon slot="icon" name="settings"></cs-icon>
+    <strong>Your settings have been updated</strong><br />
+    Changes take effect on your next login.
+  </cs-callout>
+
+  <cs-callout variant="warning">
+    <cs-icon slot="icon" name="warning" variant="fill"></cs-icon>
+    <strong>Your session is about to expire</strong><br />
+    Save your work to avoid losing it.
+  </cs-callout>
+
+  <cs-callout variant="danger">
+    <cs-icon slot="icon" name="error" variant="fill"></cs-icon>
+    <strong>This action can't be undone</strong><br />
+    Deleting a project removes it for everyone on the team.
+  </cs-callout>
+</div>
+```
+
+### Appearance
+
+Use the `appearance` attribute to change the callout's visual style. With no `appearance` set, a callout renders with a quiet fill and border, matching `filled-outlined`.
+
+```html
+<div class="cs-stack">
+  <cs-callout variant="brand" appearance="accent">
+    <cs-icon slot="icon" name="check_box" variant="fill"></cs-icon>
+    This <strong>accent</strong> callout draws the most attention.
+  </cs-callout>
+
+  <cs-callout variant="brand" appearance="filled-outlined">
+    <cs-icon slot="icon" name="format_color_fill"></cs-icon>
+    This callout is both <strong>filled</strong> and <strong>outlined</strong>.
+  </cs-callout>
+
+  <cs-callout variant="brand" appearance="filled">
+    <cs-icon slot="icon" name="format_paint"></cs-icon>
+    This callout is only <strong>filled</strong>.
+  </cs-callout>
+
+  <cs-callout variant="brand" appearance="outlined">
+    <cs-icon slot="icon" name="line_style"></cs-icon>
+    Here's an <strong>outlined</strong> callout.
+  </cs-callout>
+
+  <cs-callout variant="brand" appearance="plain">
+    <cs-icon slot="icon" name="text_fields"></cs-icon>
+    No fill or border on this <strong>plain</strong> callout.
+  </cs-callout>
+</div>
+```
+
+### Size
+
+Use the `size` attribute to change a callout's size.
+
+```html
+<div class="cs-stack">
+  <cs-callout size="xs">
+    <cs-icon slot="icon" name="info" variant="fill"></cs-icon>
+    Extra-small callout for minimal emphasis.
+  </cs-callout>
+
+  <cs-callout size="s">
+    <cs-icon slot="icon" name="info" variant="fill"></cs-icon>
+    Small callout for a bit of emphasis.
+  </cs-callout>
+
+  <cs-callout size="m">
+    <cs-icon slot="icon" name="info" variant="fill"></cs-icon>
+    Medium callout, the default size.
+  </cs-callout>
+
+  <cs-callout size="l">
+    <cs-icon slot="icon" name="info" variant="fill"></cs-icon>
+    Large callout for more emphasis.
+  </cs-callout>
+
+  <cs-callout size="xl">
+    <cs-icon slot="icon" name="info" variant="fill"></cs-icon>
+    Extra-large callout for maximum emphasis.
+  </cs-callout>
+</div>
+```
+
+### Without an Icon
+
+Icons are optional. Omit the `icon` slot for a text-only callout.
+
+```html
+<cs-callout variant="brand">All times are shown in your local timezone.</cs-callout>
+```
+
+### Customizing
+
+Style a callout with regular CSS — `background`, `border`, `border-radius`, `color`, `padding`, and `margin` all work as expected.
+
+```html
+<cs-callout
+  variant="brand"
+  style="
+    background: var(--cs-color-brand-fill-quiet);
+    border-radius: var(--cs-border-radius-pill);
+    border-style: dashed;
+  "
+>
+  <cs-icon slot="icon" name="wand_stars"></cs-icon>
+  A pinch of CSS goes a long way.
+</cs-callout>
+```
+
+## API
+
+### Importing
+
+If you're using the autoloader or a hosted project, components load on demand — no manual import
+needed. To cherry-pick this component, use one of the following snippets.
+
+**npm**
+
+```js
+import '@cruglobal/cornerstone-components/components/callout/callout.js';
+```
+
+**Self-Hosted**
+
+```js
+import './cornerstone/components/callout/callout.js';
+```
+
+**React**
+
+```js
+import CsCallout from '@cruglobal/cornerstone-components/react/callout/index.js';
+```
+
+### Slots
+
+Valid slot names for this component (use exactly these — any other `slot` value is silently ignored and the element falls back to the default slot):
+
+- `(default)` — The callout's main content.
+- `icon` — An icon to show in the callout. Works best with `<cs-icon>`.
+
+### Attributes & Properties
+
+| Property | Attribute | Description | Type | Default | Reflects |
+| --- | --- | --- | --- | --- | --- |
+| `appearance` | `appearance` | The callout's visual appearance. | `'accent' \| 'filled' \| 'outlined' \| 'plain' \| 'filled-outlined'` | — | Yes |
+| `size` | `size` | The callout's size. | `'xs' \| 's' \| 'm' \| 'l' \| 'xl'` | `'m'` | Yes |
+| `variant` | `variant` | The callout's theme variant. Defaults to `brand` if not within another element with a variant. | `'brand' \| 'neutral' \| 'highlight' \| 'information' \| 'success' \| 'warning' \| 'danger'` | `'brand'` | Yes |
+
+### CSS Parts
+
+| Name | Description | CSS selector |
+| --- | --- | --- |
+| `icon` | The container that wraps the optional icon. | `::part(icon)` |
+| `message` | The container that wraps the callout's main content. | `::part(message)` |