@cognite/aura 1.46768.0 → 1.46840.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@cognite/aura",
-  "version": "1.46768.0",
+  "version": "1.46840.0",
   "license": "MIT",
   "type": "module",
   "sideEffects": [

package/src/components/ui/core/alert/alert.md

@@ -0,0 +1,46 @@
+Use an Alert to communicate contextual, medium-emphasis information inside the current page or task flow.
+Alerts are inline and never block the user the way a modal does.
+
+## When to use
+
+- Providing inline guidance or recommendations in the current task.
+- Calling attention to warnings or issues that need awareness but are not blocking.
+- Offering direct actions that resolve the issue in context.
+
+## When to use something else
+
+- Use field-level validation when the message relates to a single input.
+- Use a [Banner](?path=/docs/primitives-banner--docs) for page-wide state that should stay visible while users continue.
+- Use a [Sonner Toast](?path=/docs/primitives-sonner-toast--docs) for brief confirmation after an action.
+- Use an Alert Dialog when the user must make a choice before continuing.
+
+## Placement
+
+- Align Alerts with surrounding content and do not pin them flush against dividers.
+- Use the `card` style for wrapped content in constrained areas.
+- Use the `strip` style for short messages in wider areas.
+
+## Variants
+
+| Variant   | Use                                                     |
+| :-------- | :------------------------------------------------------ |
+| `default` | Neutral guidance or information                         |
+| `info`    | Helpful context the user should notice                  |
+| `warning` | Issues that need attention but do not block the task    |
+| `error`   | Failures the user needs to resolve to continue the task |
+
+## Dos and don'ts
+
+- **Do** include action buttons only when they directly resolve or dismiss the Alert.
+- **Do** evaluate simpler feedback methods first, such as field-level validation.
+- **Don't** attach unrelated actions.
+
+## Behavior
+
+- Alerts sit inline with the page flow.
+- Dismissal removes or hides the Alert, depending on the variant.
+- Keep the action path clear and minimal.
+
+## Often used with
+
+[Button](?path=/docs/primitives-button--docs) for direct resolution actions.

package/src/components/ui/core/avatar/avatar.md

@@ -0,0 +1,30 @@
+Use an Avatar to visually represent a user, team, or concept and help recognition in collaborative UI.
+
+## When to use
+
+- Showing people in comments, chat, sharing, or collaborator lists.
+- Representing accounts, teams, or organizations.
+- Displaying AI or agent identities in conversational interfaces.
+
+## Content
+
+- Use an image when one is available, with initials as the fallback if it fails to load.
+- Use initials when no image exists.
+- Use an icon for system users, bots, or special entities.
+
+## Colorways and sizes
+
+- Decorative colorways (`decorative-1` to `decorative-7`) carry no semantic meaning.
+- Use the `overflow` colorway for "+N" avatars that summarize hidden members.
+- Choose the size based on context density: `default` for most layouts, `xsm` and `xxsm` for dense lists and tables.
+
+## Behavior
+
+- Avatars are not interactive by default, but can be made interactive when the context needs it.
+- Use overflow patterns in constrained spaces, such as a "+N" Avatar that opens a [Menu](?path=/docs/primitives-dropdown-menu--docs).
+- Avatars can include status badges or dots.
+- Give every Avatar an accessible name with `aria-label`.
+
+## Often used with
+
+[Badge](?path=/docs/primitives-badge--docs), [Tooltip](?path=/docs/primitives-tooltip--docs) for full names, and [Menu](?path=/docs/primitives-dropdown-menu--docs) for overflow.

package/src/components/ui/core/badge/badge.md

@@ -0,0 +1,32 @@
+Use a Badge as a compact label for status, category, or metadata.
+
+## When to use
+
+- Surfacing state at a glance, such as active, draft, or error.
+- Tagging items without taking primary focus from the page.
+
+## When to use something else
+
+- Use an [Alert](?path=/docs/primitives-alert--docs) or inline text when the message needs explanation or recovery steps.
+- Use a [Button](?path=/docs/primitives-button--docs) for a primary action.
+
+## Variants
+
+| Variant                          | Use                                                       |
+| :------------------------------- | :-------------------------------------------------------- |
+| `decorative-1` to `decorative-7` | Categories and tags with no semantic meaning; filled only |
+| `inProgress`                     | Neutral, ongoing status                                   |
+| `success`, `warning`, `error`    | Status that carries meaning                               |
+| `archived`                       | Items that are no longer active                           |
+| `secondary`                      | Counts and low-emphasis metadata                          |
+| `closable`                       | Tags the user can remove                                  |
+
+## Dos and don'ts
+
+- **Do** use semantic variants when the Badge communicates status.
+- **Don't** use decorative variants to communicate status, since they carry no semantic meaning.
+- **Don't** outline decorative variants; they are filled only.
+
+## Often used with
+
+[Avatar](?path=/docs/primitives-avatar--docs), tables and lists, and filter chips.

package/src/components/ui/core/checkbox/checkbox.md

@@ -0,0 +1,37 @@
+Use a Checkbox to let users independently select one or more options.
+Checkboxes can appear standalone or within menus, tree views, tables, or cards.
+
+## When to use
+
+- Multiple independent selections are required, such as column visibility in a table.
+- Enabling or disabling settings where changes do not take immediate effect.
+- Confirming agreement before an action, such as delete verification.
+
+## When to use something else
+
+- Use a [Radio](?path=/docs/primitives-radio-group--docs) when only one option can be selected at a time.
+- Use a [Select](?path=/docs/primitives-select--docs) when options are not displayed simultaneously.
+- Use a [Switch](?path=/docs/primitives-switch--docs) for an immediate on/off toggle.
+
+## Layout
+
+- Groups stack vertically by default; set `orientation="horizontal"` to lay options out in a row.
+- Use the card layout for options that need descriptions.
+
+## Dos and don'ts
+
+- **Do** provide a label for every Checkbox.
+- **Do** use the indeterminate state for partial group selection.
+- **Don't** pre-select Checkboxes automatically.
+- **Don't** use a single Checkbox unless it confirms agreement.
+- **Don't** use card variants for long option lists.
+
+## Behavior
+
+- The Space key toggles the focused Checkbox.
+- The indeterminate state is set programmatically, not by user interaction.
+- Parent and child Checkboxes follow selection cascading rules.
+
+## Often used with
+
+[Label](?path=/docs/primitives-label--docs), helper text for groups, and the card variant for options that need descriptions.

package/src/components/ui/core/switch/switch.md

@@ -0,0 +1,26 @@
+Use a Switch to turn a setting on or off, with the change taking effect immediately.
+
+## When to use
+
+- Toggling a setting that takes immediate effect, such as dark mode or notifications.
+
+## When to use something else
+
+- Use a [Checkbox](?path=/docs/primitives-checkbox--docs) or [Button](?path=/docs/primitives-button--docs) when the change depends on a form and is applied later.
+- Use a [Button](?path=/docs/primitives-button--docs) for one-time or destructive actions.
+- Use a Toggle Group, [Checkbox](?path=/docs/primitives-checkbox--docs), or [Select](?path=/docs/primitives-select--docs) when multiple related toggles need grouping.
+
+## Dos and don'ts
+
+- **Do** give every Switch a clear, descriptive label that explains what it controls.
+- **Don't** embed Switches inside a [Menu](?path=/docs/primitives-dropdown-menu--docs); use menu checkmarks instead.
+- **Don't** use a Switch for destructive actions.
+
+## Behavior
+
+- A Switch responds instantly, without a separate form submission.
+- Connect the label to the Switch with `htmlFor` and `id`, or give the Switch an `aria-label` when there is no visible label.
+
+## Often used with
+
+[Label](?path=/docs/primitives-label--docs) and helper text.