@capra/core 1.5.3 → 1.6.0

package/docs/conventions--docs.md

@@ -0,0 +1,186 @@
+# Conventions
+
+When building and consuming Capra components, we follow specific conventions to maintain a healthy codebase.
+
+### Semantic Properties
+
+Certain properties of Capra components have well-defined, consistent uses.
+
+| Prop         | Purpose                                                                                          | Possible Values                                                |
+| ------------ | ------------------------------------------------------------------------------------------------ | -------------------------------------------------------------- |
+| `appearance` | Change the colors of a component using semantic intent, e.g. a danger `Button` when deleting     | `default`, `info`, `danger`, `warning`, `success`, `highlight` |
+| `color`      | Change the color of a component to a specific color, e.g. a teal `Ribbon`                        | Component-specific                                             |
+| `layout`     | Alter the component's layout, e.g. a horizontal input field with label                           | Component-specific                                             |
+| `size`       | Specify the size of the component                                                                | `xs`, `sm`, `md`, `lg`, `xl`                                   |
+| `variant`    | Specify a different visual treatment for the component, e.g. a dot `Badge` vs. a counter `Badge` | Component-specific                                             |
+
+For props where the possible values are pre-defined, a component may utilize the full set or a subset of the possible values.
+
+### Styling Overrides
+
+Capra components are built according to our design system specifications. They should rarely need to be styled differently than what is provided out-of-the-box. In the event custom styling is required, we provide a consistent escape hatch across all of our components for passing a CSS class name: `FORCE__className`.
+
+In your application, you can apply a style override like this:
+
+```tsx
+import { Text } from '@capra/core';
+import styles from './Component.modules.css';
+
+export function Component(props) {
+  return <Text FORCE__className={styles.text}>Hello world</Text>;
+}
+```
+
+Note that using this prop should be a rarity. Adding styles here is also somewhat brittle. While we do provide this escape hatch, we make no guarantees that the styles applied will apply correctly across version updates, e.g. a style override targeting a specific HTML structure within a Capra component breaks because the component was refactored to use a different HTML structure. The inner workings of Capra components are implementation details and this escape hatch gives one access to those implementation details. Please use it responsibly.
+
+## Client-side Routing
+
+Capra components such as `Link` and `ButtonLink` render links that perform navigation when the user interacts with them. Each component that supports link behavior accepts an `href` prop, which is passed to the underlying `<a>` element.
+
+By default, links perform native browser navigation when they are interacted with. However, Capra supports overriding this behavior using a client-side router of your choice. Set this up once in the root of your app, and any Capra link component will automatically navigate using your router.
+
+Note that external links to different origins will not trigger client side routing, and will use native browser navigation. Additionally, if the link has a target other than `"_self"`, uses the `download` attribute, or the user presses modifier keys such as `Command` or `Alt` to change the default behavior, browser native navigation will occur instead of client side routing.
+
+### `RouterProvider`
+
+The `RouterProvider` component accepts two props: `navigate` and `useHref`. `navigate` should be set to a function received from your router for performing a client side navigation programmatically. `useHref` is an optional prop that converts a router-specific href to a native HTML href, e.g. prepending a base path. The following example shows the general pattern. Framework-specific examples are shown below.
+
+```tsx
+import {RouterProvider} from '@capra/core';
+import {useNavigate, useHref} from 'your-router';
+
+function App() {
+  const navigate = useNavigate();
+
+  return (
+    <RouterProvider navigate={navigate} useHref={useHref}>
+      {/* ... */}
+    </RouterProvider>
+  );
+}
+```
+
+### Router Options
+
+All Capra link components accept a `routerOptions` prop, which is an object that is passed through to the client side router's `navigate` function as the second argument. This can be used to control any router-specific behaviors, such as scrolling, replacing instead of pushing to the history, etc.
+
+```tsx
+<Link href="/login" routerOptions={{replace: true}}>{/* ...*/}</Link>
+```
+
+When using TypeScript, you can configure the `RouterConfig` type globally so that all link components have auto complete and type safety using a type provided by your router.
+
+```tsx
+import type {RouterOptions} from 'your-router';
+
+declare module '@capra/core' {
+  interface RouterConfig {
+    routerOptions: RouterOptions
+  }
+}
+```
+
+### React Router
+
+The [useNavigate](https://reactrouter.com/en/main/hooks/use-navigate) hook from `react-router-dom` returns a `navigate` function you can pass to `RouterProvider`. The [useHref](https://reactrouter.com/en/main/hooks/use-href) hook can also be provided if you're using React Router's `basename` option. Ensure that the component that calls `useNavigate` and renders `RouterProvider` is inside the router component (e.g. `BrowserRouter`) so that it has access to React Router's internal context. The React Router `<Routes>` element should also be defined inside Capra's `<RouterProvider>` so that links inside the rendered routes have access to the router.
+
+```tsx
+import {BrowserRouter, useNavigate, useHref, type NavigateOptions} from 'react-router-dom';
+import {RouterProvider} from '@capra/core';
+
+declare module '@capra/core' {
+  interface RouterConfig {
+    routerOptions: NavigateOptions
+  }
+}
+
+function App() {
+  const navigate = useNavigate();
+
+  return (
+    <RouterProvider navigate={navigate} useHref={useHref}>
+      {/* Your app here... */}
+      <Routes>
+        <Route path="/" element={<HomePage />} />
+        {/* ... */}
+      </Routes>
+    </RouterProvider>
+  );
+}
+
+<BrowserRouter>
+  <App />
+</BrowserRouter>
+```
+
+### Next.js App Router
+
+The [useRouter](https://nextjs.org/docs/app/api-reference/functions/use-router) hook from `next/navigation` returns a router object that can be used to perform navigation. `RouterProvider` should be rendered from a client component at the root of each page or layout that includes Capra links. You can create a new client component for this, or combine it with other top-level providers as described in the [Next.js docs](https://nextjs.org/docs/app/building-your-application/rendering/composition-patterns#using-context-providers).
+
+```tsx
+// app/provider.tsx
+"use client";
+
+import {useRouter} from 'next/navigation';
+import {RouterProvider} from '@capra/core';
+
+declare module '@capra/core' {
+  interface RouterConfig {
+    routerOptions: NonNullable<Parameters<ReturnType<typeof useRouter>['push']>[1]>
+  }
+}
+
+export function ClientProviders({children}) {
+  const router = useRouter();
+
+  return (
+    <RouterProvider navigate={router.push}>
+      {children}
+    </RouterProvider>
+  );
+}
+```
+
+Then, in your page or layout server component, wrap your app in the `ClientProviders` component that you defined.
+
+```tsx
+// app/layout.tsx
+import {ClientProviders} from './provider';
+
+export default function RootLayout({children}) {
+  return (
+    <html>
+      <body>
+        <ClientProviders>{children}</ClientProviders>
+      </body>
+    </html>
+  );
+}
+```
+
+### Next.js Pages Router
+
+The [useRouter](https://nextjs.org/docs/pages/api-reference/functions/use-router) hook from `next/router` returns a router object that can be used to perform navigation. `RouterProvider` should be rendered at the root of each page that includes Capra links, or in `pages/_app.tsx` to add it to all pages.
+
+```tsx
+// pages/_app.tsx
+import type { AppProps } from 'next/app';
+import {useRouter, type NextRouter} from 'next/router';
+import {RouterProvider} from '@capra/core';
+
+declare module '@capra/core' {
+  interface RouterConfig {
+    routerOptions: NonNullable<Parameters<NextRouter['push']>[2]>
+  }
+}
+
+export default function MyApp({Component, pageProps}: AppProps) {
+  const router = useRouter();
+
+  return (
+    <RouterProvider navigate={(href, opts) => router.push(href, undefined, opts)}>
+      <Component {...pageProps} />
+    </RouterProvider>
+  );
+}
+```

package/docs/core-alert--design.md

@@ -0,0 +1,110 @@
+# Core/Alert - Design
+
+Alerts are used to communicate important information to the user.
+
+## Usage
+
+Use an Alert to surface contextual feedback in the page: the outcome of an action (success or failure), a condition that needs attention before the user continues, or information that should stay visible while they keep working in the same view.
+
+Keep alerts scoped to the page or region they refer to. Prefer one alert per region so the message stays easy to scan; when several conditions apply at once, combine them into a single alert when it makes sense.
+
+## Properties
+
+### Appearances
+
+### Info
+
+General information like recommend actions to accelerate a user's workflow, helpful information, or tips.
+
+### Error
+
+Problems that must be resolved before the user can complete a task, such as an error on a form.
+
+### Warning
+
+Notify users of cautionary/temporary information affecting the user's workflow, but does not block a user from
+completing the action or workflow.
+
+### Success
+
+Brings special attention to the user that an action has been completed, or a status has been updated.
+
+### Layout
+
+### Section
+
+Section notifications communicate the status of a section to the user.
+
+### Inline
+
+Inline notifications are low-priority messages about a single element, like a tile or row item.
+
+### Additional properties
+
+### Title
+
+A title is recommended, but optional. Use a title to quickly summarize the purpose of the notification. Keep titles
+short, no more than 60 characters, and avoid repeating the body text.
+
+### Body
+
+The body text is required for all notifications. If the notification is actionable, the text should inform the user
+of the next step.
+
+### Action
+
+Actionable notifications are recommended to help the user resolve the issue.
+
+### Dismiss
+
+Alert banners can include a dismiss button that removes the notice from the page layout. Error banners can not be
+dismissed.
+
+## Layout and spacing
+
+* Alerts span the full width of their container.
+
+## Behavior
+
+* Alerts are static by default; they do not auto-dismiss.
+* If the user triggers an action that resolves the alert condition, remove the alert programmatically.
+* When an alert is injected into the DOM, announce it to screen readers via `aria-live`.
+
+## Content
+
+* Title: sentence case, no trailing punctuation, max 60 characters.
+* Body: one to two sentences. State the problem and the resolution path. Use punctuation.
+* Action label: verb-first, 1-3 words (e.g., "Retry", "View details").
+* Avoid technical jargon in user-facing alert text.
+
+## Best Practices
+
+Do:
+
+* Do use `appearance="danger"` for blocking error states.
+* Do provide an action when the user has a clear path to resolution.
+
+Don't:
+
+* Don't use Alert for transient, auto-dismissing notifications — use Toast.
+* Don't use Alert for individual form field validation errors — use the field's error state.
+* Don't use Alert when the message isn't tied to the current page or task context.
+* Don't stack Alerts in the same region.
+* Don't make `appearance="danger"` Alerts dismissable — the component prevents this automatically.
+
+## Accessibility
+
+* Use `role="alert"` for errors and warnings so they are announced immediately by screen readers.
+* Use `role="status"` for informational and success alerts, which are announced at a lower priority.
+* Don't rely solely on color to convey alert type — the icon and/or title must distinguish the appearance.
+* Ensure the dismiss button has an accessible label (e.g., `aria-label="Dismiss alert"`).
+
+### Keyboard interaction
+
+* Alerts exist in the page's natural tab sequence, their actions reachable via `tab` and `shift`+`tab` keys.
+
+## Related components
+
+* [Toast](?path=/docs/core-toast--design) — For non-blocking, auto-dismissing notifications.
+* [Pill](?path=/docs/core-pill--design) — For inline semantic status indicators without body copy.
+* [Modal](?path=/docs/core-modal--design) — When the error or warning requires an immediate blocking decision.

package/docs/core-alert--usage.md

@@ -0,0 +1,13 @@
+# Core/Alert - Usage
+
+Alerts are used to communicate important information to the user.
+
+| Prop | Type | Required | Default | Description |
+| --- | --- | --- | --- | --- |
+| `layout` | `(typeof layouts)[number]` | No | 'section' | The layout of the alert.<br><br>@default 'section'<br><br><ul><br>  <li>'section' - The alert is displayed in a full width container.</li><br>  <li>'compact' - @deprecated Use 'section' instead. Will be removed in a future version.</li><br>  <li>'inline' - Inline notifications are low-priority messages about a single element, like a tile or row item.</li><br></ul> |
+| `appearance` | `(typeof appearances)[number]` | No | 'info' | The appearance of the alert.<br><br>@default 'info'<br><br><ul><br>  <li>'info' - Informational alerts provide general information or an important property.</li><br>  <li>'warning' - Warning alerts notify users of cautionary information.</li><br>  <li>'danger' - Danger alerts indicate problems that must be resolved.</li><br>  <li>'success' - Success alerts confirm an action has been completed.</li><br></ul> |
+| `title` | `string` | No | `--` | The title of the alert. This is optional. |
+| `children` | `React.ReactNode` | Yes | `--` | The description of the alert. This is required.<br><br>@required |
+| `action` | `{     label: string;     onClick: (e: React.MouseEvent<HTMLButtonElement>) => void;   } \| React.ReactElement` | No | `--` | The configuration of the action button. The object must contain a label displayed on the button and an onClick callback function. This is optional.<br><br>When the object is not provided, the alert will not render the action button. |
+| `onDismiss` | `true \| (() => void)` | No | `--` | Optional function to call when the user dismisses the alert.<br><br>If this is not provided, the alert will not render the dismiss button.<br><br>Alerts with `appearance="danger"` cannot be dismissed and will not render the dismiss button.<br><br>**Integration note:** while the `Alert` will handle its own dismissal, this is non-persistent.<br>Persistent dismissal should be handled by the parent component. |
+| `FORCE__className` | `string` | No | `--` | 🚨 This prop is meant to be an escape hatch. 🚨<br><br>If the desired style cannot be achieved using component props, use this as a last resort. The inner workings of Capra components are implementation details and this escape hatch gives one access to those implementation details. We cannot make any guarantees that styles will applied correctly across version updates. Please use it responsibly.<br><br>Add a CSS class to the component. |

package/docs/core-anchor--design.md

@@ -0,0 +1,39 @@
+# Core/Anchor - Design
+
+## Usage
+
+Anchors are used to navigate users to a different section within the current page.
+
+## Properties
+
+### Label
+
+Labels should be concise and descriptive, m Use title case (e.g., "Dashboard", "Settings"). Labels should ideally be
+less than 12 characters, with a maximum of 32 characters.atching the destination heading.
+
+## Best Practices
+
+Do:
+
+* Do match the label to the section heading the anchor points to.
+* Do use the active state for the current page in a navigation region.
+* Do use the disabled state when navigation is temporarily unavailable.
+
+Don't:
+
+* Don't mark more than one anchor as active in the same navigation context.
+* Don't hide anchors instead of disabling them when a destination exists but is unavailable.
+* Don't use confuse Anchor with Tab.
+
+## Accessibility
+
+### Keyboard interaction
+
+| Key     | Function                                                              |
+| ------- | --------------------------------------------------------------------- |
+| `Tab`   | Moves focus to the anchor when navigating through focusable elements. |
+| `Enter` | Activates the anchor when focused.                                    |
+
+### ARIA attributes
+
+* `aria-current="page"`: Applied when the anchor is active, indicating the current page in navigation.

package/docs/core-anchor--usage.md

@@ -0,0 +1,39 @@
+# Core/Anchor - Usage
+
+| Prop | Type | Required | Default | Description |
+| --- | --- | --- | --- | --- |
+| `children` | `React.ReactNode` | Yes | `--` | The label text to display in the anchor. Anchor labels should be one or two words, using title case (Tab Label). Labels should be less than 12 characters, with a maximum of 32 characters. |
+| `href` | `string` | No | `--` | The href attribute of the anchor. |
+| `isActive` | `boolean` | No | `--` | Whether the anchor is active. |
+| `isDisabled` | `boolean` | No | `--` | Whether the anchor is disabled. |
+| `as` | `As` | No | `--` | The underlying element rendered by the anchor. Defaults to `a`. |
+| `FORCE__className` | `string` | No | `--` | 🚨 This prop is meant to be an escape hatch. 🚨<br><br>If the desired style cannot be achieved using component props, use this as a last resort. The inner workings of Capra components are implementation details and this escape hatch gives one access to those implementation details. We cannot make any guarantees that styles will applied correctly across version updates. Please use it responsibly.<br><br>Add a CSS class to the component. |
+
+## Usage
+
+```tsx
+import { Anchor } from '@cribl/capra-core';
+
+// Basic usage
+<Anchor href="/dashboard">Dashboard</Anchor>
+
+// Active state
+<Anchor href="/settings" isActive>Settings</Anchor>
+
+// Disabled state
+<Anchor href="/admin" isDisabled>Admin</Anchor>
+
+// Polymorphic - render as button
+<Anchor as="button" onClick={handleClick}>Action</Anchor>
+```
+
+## Polymorphic Component
+
+The Anchor component supports the `as` prop, allowing it to be rendered as different HTML elements or custom components. This is particularly useful when integrating with routing libraries like React Router.
+
+```tsx
+import { Link } from 'react-router-dom';
+
+// Using with React Router
+<Anchor as={Link} to="/dashboard">Dashboard</Anchor>
+```

package/docs/core-autocompletefield--design.md

@@ -0,0 +1,91 @@
+# Core/AutocompleteField - Design
+
+AutocompleteField combines a text field with a suggestions list. Consumers can supply static `AutocompleteField.Item` children or an `items` collection with an optional default item renderer. The field allows custom values that are not in the list.
+
+## Anatomy
+
+1. **Text input** — Entry is through a standard text input. The field keeps focus while the list is open so typing and keyboard
+   navigation stay in one place.
+2. **ListBox** — Filtered results appear in a ListBox under the field.
+
+## Properties
+
+### Label
+
+A label is required for input fields and succinctly describes the field’s purpose. If another text element is acting
+as the label, like a section title, ensure the proper aria relationships are linked.
+
+### Placeholder text
+
+<p>
+  Placeholder text is visible until a character is entered.
+</p>
+
+<p>
+  Because the placeholder text disappears, putting instructions or requirements as placeholder text is not
+  accessible. Helper text is the preferred method to convey this information.
+</p>
+
+### Helper text
+
+Helper text is placed below the field and informs the user of any requirements, disclaimers, and errors. Helper text
+is shown persistently but is replaced by error text when an error occurs.
+
+### Layout
+
+There are two layouts available for text fields, vertical and horizontal. Vertical labels are the preferred layout,
+appearing above the field. Horizontal labels appear on the leading side of the field, and should only be used when
+space is limited.
+
+## Layout and spacing
+
+* Input renders identically to [TextField](?path=/docs/core-textfield--design).
+* Suggestions are presented using a ListBox.
+
+## Behavior
+
+### Autocomplete vs. Select
+
+<p>
+  **Autocomplete** is an input box with text hints that users can type freely into. Hints are presented and refined
+  ina selection list as the user types. Freeform entry is allowed.
+</p>
+
+<p>
+  **Select**
+
+   allows selecting options only among a given set of choices.
+</p>
+
+### Filtering
+
+As the user types into the text field options are filtered based on the value.
+
+## Best Practices
+
+Do:
+
+* Do show a "no results" message when the filter returns nothing.
+* Do support keyboard-only navigation of suggestions.
+
+Don't:
+
+* Don't use AutocompleteField for small mutually exclusive sets (about seven or fewer visible options) — use [RadioGroup](?path=/docs/core-radiogroup--design) or Select.
+* Don't use AutocompleteField for plain freeform text with no list validation — use [TextField](?path=/docs/core-textfield--design).
+* Don't require picking from the list while still allowing arbitrary text without explaining that behavior.
+
+## Accessibility
+
+* `role="combobox"` on the input, `aria-expanded` reflects list open state.
+* `aria-controls` references the suggestion list `id`.
+* `aria-activedescendant` references the currently focused suggestion.
+* Suggestion list: `role="listbox"`, each suggestion: `role="option"`.
+
+### Keyboard interaction
+
+* Keyboard interactions follow Select and ListBox.
+
+## Related components
+
+* [TextField](?path=/docs/core-textfield--design) — For freeform text without suggestions.
+* [RadioGroup](?path=/docs/core-radiogroup--design) — For small mutually exclusive option sets.

package/docs/core-autocompletefield--usage.md

@@ -0,0 +1,18 @@
+# Core/AutocompleteField - Usage
+
+AutocompleteField combines a text field with a suggestions list. Consumers can supply static `AutocompleteField.Item` children or an `items` collection with an optional default item renderer. The field allows custom values that are not in the list.
+
+| Prop | Type | Required | Default | Description |
+| --- | --- | --- | --- | --- |
+| `canClear` | `boolean` | No | `--` | Whether to show a clear button for the input. |
+| `children` | `React.ReactNode \| ((     values: T & {       defaultChildren: React.ReactNode \| undefined;     },   ) => React.ReactNode)` | No | `--` | The children to render in the dropdown. |
+| `itemFilter` | `(textValue: string, inputValue: string) => boolean` | No | `--` | A function that filters the items based on the input value. |
+| `onChange` | `(value: string) => void` | No | `--` | A callback function that is called when the input value changes. |
+| `onOpenChange` | `(isOpen: boolean) => void` | No | `--` | A callback function that is called when the dropdown is opened or closed. |
+| `items` | `AutocompleteItem[]` | No | `--` | The items to display in the dropdown. |
+| `value` | `AutocompleteItem['value']` | No | `--` | The value of the input. |
+| `shouldAutoSizeDropdown` | `boolean` | No | `--` | Whether to automatically size the dropdown to the width of the input. Defaults to `true` |
+| `FORCE__className` | `string` | No | `--` | 🚨 This prop is meant to be an escape hatch. 🚨<br><br>If the desired style cannot be achieved using component props, use this as a last resort. The inner workings of Capra components are implementation details and this escape hatch gives one access to those implementation details. We cannot make any guarantees that styles will applied correctly across version updates. Please use it responsibly.<br><br>Add a CSS class to the component. |
+| `helperText` | `string` | No | `--` | Helper text below the field. Replaced by error message when status is error. Use for requirements, disclaimers. |
+| `label` | `string` | No | `--` | Label for the field. Required for accessibility; use aria-label if another element acts as label. |
+| `layout` | `'vertical' \| 'horizontal'` | No | `--` | Label and field layout: vertical (label above) or horizontal (label on leading side). Prefer vertical; use horizontal when space is limited. |

package/docs/core-badge--design.md

@@ -0,0 +1,70 @@
+# Core/Badge - Design
+
+Badges display an indicator/counter on an associated component.
+
+## Properties
+
+### Label
+
+A label is required to indicate the number of notifications.
+
+### Size
+
+Badges come in 3 sizes to support ones, tens, and values above 100.
+
+### Dot
+
+Use a dot to show notifications without a count.
+
+### Appearance
+
+Badges can be colored based on their status. The `attention` appearance is the general purpose color used for numbered badges and does not necessarily communicate severity.
+
+Using color as the only means to communicate status should be avoided (WCAG SC 1.4.1: Use of Color, Level A). Badges that communicate status must be accompanied by supplementary information that clearly communicates the status.
+
+## Behavior
+
+### Corner attachment
+
+Badges are placed in the top-right of the parent component to avoid obscuring the parent content.
+
+### Inline
+
+When used with text labels, badges are placed on the trailing side and vertically aligned to the text's line height.
+
+## Content
+
+### Maximum
+
+The maximum number shown in 99. When there are more than 99 notifications a "+" is appended to the label.
+
+## Best Practices
+
+Do:
+
+* Do cap displayed values at 99 with a "99+" label.
+* Do use the dot variant for simple presence indicators.
+* Do include count context in the parent's accessible label.
+
+Don't:
+
+* Don't use Badge for semantic status text — use Pill.
+* Don't use Badge for labels or tags — use Tag.
+* Don't place Badge on non-interactive decorative elements.
+* Don't use Badge colors as the only method to communicate status.
+
+## Accessibility
+
+* The badge is a nested static element; it is announced as part of its parent.
+* The parent element's accessible label should include the count context (e.g., "Notifications, 5 unread").
+* Use `aria-live="polite"` on the parent for dynamic badge updates.
+
+## Content
+
+* Numeric only.
+* Max displayed value: 99; use "99+" for larger counts.
+
+## Related components
+
+* [Pill](?path=/docs/core-pill--design) — For semantic status labels.
+* [Tag](?path=/docs/core-tag--design) — For removable text chips.

package/docs/core-badge--usage.md

@@ -0,0 +1,13 @@
+# Core/Badge - Usage
+
+Badges display an indicator/counter on an associated component.
+
+| Prop | Type | Required | Default | Description |
+| --- | --- | --- | --- | --- |
+| `variant` | `'counter' \| 'dot'` | No | `--` | The variant of the badge. 'counter' displays a count, 'dot' displays only a dot.<br>@default 'counter' |
+| `appearance` | `'danger' \| 'info' \| 'success' \| 'warning'` | No | 'danger' | Controls the Badge color.<br>@default 'danger' |
+| `count` | `number` | No | 0 | The number to display in the badge. Default is 0. |
+| `showZero` | `boolean` | No | false | Whether to display the badge when the count is zero. Default is false. |
+| `overflowCount` | `number` | No | 99 | The number to display in the badge when the count is greater than the overflow count. Default is 99. |
+| `FORCE__className` | `string` | No | `--` | 🚨 This prop is meant to be an escape hatch. 🚨<br><br>If the desired style cannot be achieved using component props, use this as a last resort. The inner workings of Capra components are implementation details and this escape hatch gives one access to those implementation details. We cannot make any guarantees that styles will applied correctly across version updates. Please use it responsibly.<br><br>Add a CSS class to the component. |
+| `aria-live` | `React.AriaAttributes['aria-live']` | No | `--` | `--` |

package/docs/core-breadcrumbs--design.md

@@ -0,0 +1,65 @@
+# Core/Breadcrumbs - Design
+
+Renders a breadcrumb trail with built-in support for collection behavior, keyboard support, and current-page semantics. Wrap items with {@link Breadcrumb}. The last item should represent the current page (typically without an `href`).
+
+## Usage
+
+Use Breadcrumbs on views that sit deeper than the home or root level so people see where they are in the hierarchy and can jump to ancestors.
+
+Place them above the page title, keep labels aligned with each destination's title, and render every segment except the current page as a link.
+
+## Layout and spacing
+
+* Place above the page heading.
+
+## Behavior
+
+* Current page item is not a link (no click interaction).
+
+## Content
+
+* Use the same label as the page heading for each item.
+* Title case.
+* Keep each label concise (1-3 words).
+
+## Best Practices
+
+Do:
+
+* Do make all items except the last one clickable links.
+* Do mark the current page with `aria-current="page"`.
+
+Don't:
+
+* Don't show breadcrumbs on top-level pages — there is no trail to show.
+* Don't use breadcrumbs when the IA is flat and would produce a single segment.
+* Don't use custom separator text that is read by screen readers.
+
+## Accessibility
+
+* Wrap in a `<nav aria-label="breadcrumb">` element.
+* Current page item uses `aria-current="page"`.
+* Separator characters are `aria-hidden="true"`.
+
+### Keyboard interaction
+
+| Key           | Function                                                                                                                                                                                                |
+| ------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| `Tab`         | Move focus forward along the breadcrumb trail.                                                                                                                                                          |
+| `Shift + Tab` | Move focus back along the breadcrumb trail.                                                                                                                                                             |
+| `Enter`       | Activates the currently focused link. If a dropdown crumb has focus, opens the menu and gives focus to the currently selected option. If a menu item has focus, activates the item and closes the menu. |
+| `Space`       | If a dropdown crumb has focus, opens the menu and gives focus to the currently selected option.                                                                                                         |
+| `Down Arrow`  | If a dropdown crumb has focus, opens the menu and gives focus to the currently selected option. If a menu item has focus, moves focus to the next item.                                                 |
+| `Up Arrow`    | If a menu item has focus, moves focus to the previous item.                                                                                                                                             |
+| `Esc`         | If a dropdown crumb is open, closes the menu and returns focus to the trigger.                                                                                                                          |
+
+* If a dropdown crumb is open: the `tab` and `shift`+`tab` keys do not navigate.
+
+### Labeling
+
+* Breadcrumbs represent a hierarchy and need to announce themselves accordingly. Using `aria-label`, a crumb should identify itself and its parents.
+* Use `aria-current=”page”` to indicate the last page in the breadcrumb order.
+
+## Related components
+
+* [TabNav](?path=/docs/core-tabnav--design) — For in-page section navigation.