Skip to content

3lvia/designsystem / skills/elvia-design-system

elvia-design-system

Verified

Reference for UI components and patterns in Elvia's design system ("Elvis"). Covers component- and pattern-specific guidelines for sizing, color tokens for custom UI, types, ordering, labeling, accessibility attributes, CSS setup, and web-component registration. Use when building, reviewing, or fixing UI in an Elvia frontend, even if the request doesn't name Elvia or the CSS classes explicitly (e.g. "add a save button", "make this icon bigger", "add a tooltip").

FileKindSize
README.mdmarkdown726 B
SKILL.mdskill md10.4 KB
references/accordion.mdmarkdown5.9 KB
references/alert.mdmarkdown4.3 KB
references/app-bridge.mdmarkdown3.3 KB
references/autocomplete.mdmarkdown5.5 KB
references/badge.mdmarkdown2.3 KB
references/box.mdmarkdown2.0 KB
references/breadcrumb.mdmarkdown2.9 KB
references/button.mdmarkdown6.0 KB
references/card.mdmarkdown5.6 KB
references/carousel.mdmarkdown4.4 KB
references/checkbox.mdmarkdown4.7 KB
references/chip.mdmarkdown4.1 KB
references/color-tokens.mdmarkdown5.6 KB
references/content-loader.mdmarkdown2.0 KB
references/context-menu.mdmarkdown6.6 KB
references/data-formats.mdmarkdown2.1 KB
references/datepicker-range.mdmarkdown5.4 KB
references/datepicker.mdmarkdown6.0 KB
references/divider.mdmarkdown2.4 KB
references/drag-and-drop.mdmarkdown2.0 KB
references/dropdown.mdmarkdown6.7 KB
references/empty-state.mdmarkdown3.0 KB
references/file-upload.mdmarkdown2.6 KB
references/form-field.mdmarkdown2.7 KB
references/header.mdmarkdown5.8 KB
references/icon.mdmarkdown5.0 KB
references/illustrations.mdmarkdown1.4 KB
references/input.mdmarkdown2.5 KB
references/installation.mdmarkdown2.1 KB
references/link.mdmarkdown3.3 KB
references/list.mdmarkdown2.0 KB
references/modal.mdmarkdown6.1 KB
references/pagination.mdmarkdown4.0 KB
references/popover.mdmarkdown5.3 KB
references/progress-linear.mdmarkdown3.1 KB
references/radio-button.mdmarkdown2.6 KB
references/radio-filter.mdmarkdown2.8 KB
references/search-pattern.mdmarkdown2.7 KB
references/segmented-control.mdmarkdown3.9 KB
references/shadows.mdmarkdown1.3 KB
references/slider.mdmarkdown3.6 KB
references/stepper.mdmarkdown4.7 KB
references/table.mdmarkdown8.4 KB
references/tabs.mdmarkdown3.8 KB
references/tag.mdmarkdown5.0 KB
references/thumbnail.mdmarkdown1.9 KB
references/timepicker.mdmarkdown5.1 KB
references/toast.mdmarkdown3.4 KB
references/toggle.mdmarkdown2.1 KB
references/tooltip.mdmarkdown4.1 KB
references/typography.mdmarkdown3.3 KB
references/utility-classes.mdmarkdown3.9 KB
references/web-components.mdmarkdown2.1 KB

references/modal.md

View on GitHub
- [Modal (`<elvia-modal>`)](#modal-elvia-modal)
  - [Reference](#reference)
  - [Installation](#installation)
  - [Use](#use)
  - [Attributes](#attributes)
    - [heading](#heading)
    - [content](#content)
    - [primaryButton / secondaryButton](#primarybutton--secondarybutton)
    - [isShowing](#isshowing)
    - [onClose](#onclose)
    - [disableClose](#disableclose)
    - [hasCloseButton](#hasclosebutton)
    - [illustration](#illustration)
    - [maxWidth](#maxwidth)
  - [Guidelines](#guidelines)
    - [When to use](#when-to-use)
    - [When not to use](#when-not-to-use)
  - [Accessibility](#accessibility)
  - [Examples](#examples)

# Modal (`<elvia-modal>`)

## Reference

https://design.elvia.io/components/modal

`<elvia-modal>` is a web component.

## Installation

This web component requires the `@elvia/elvis-modal` package. If it is not already installed, follow the
[Installation reference](./installation.md).

## Use

Use a modal when the user must make a short, consequential decision before continuing. The modal traps focus
and blocks interaction with the page behind it.

`heading`, `content`, `illustration`, `primaryButton`, and `secondaryButton` use slots. Closing the modal does
not reset its state (e.g. a form state inside the modal).

```html
<elvia-modal heading="Datagodkjenning" isShowing>
  <div slot="content">Er du sikker på at du vil godkjenne at Google bruker data om deg?</div>
  <button slot="primaryButton" class="e-btn e-btn--primary e-btn--lg" type="button">Godkjenn</button>
  <button slot="secondaryButton" class="e-btn e-btn--secondary e-btn--lg" type="button">Avbryt</button>
</elvia-modal>
```

## Attributes

### heading

String or slot content. Keep it short. A question or the decision at hand, not a sentence.

Example:

```html
<elvia-modal heading="Slett kontrakt" isShowing>
  <div slot="content">Er du sikker på at du vil slette kontrakten?</div>
  <button slot="primaryButton" class="e-btn e-btn--primary e-btn--lg" type="button">Slett kontrakt</button>
  <button slot="secondaryButton" class="e-btn e-btn--secondary e-btn--lg" type="button">Avbryt</button>
</elvia-modal>
```

### content

Required. Slot content (`slot="content"`), not an attribute. Keep it short and scannable. The modal is for
quick decisions, not for reading.

```html
<elvia-modal heading="Slett kontrakt" isShowing>
  <div slot="content">Er du sikker på at du vil slette kontrakten?</div>
</elvia-modal>
```

### primaryButton / secondaryButton

Slot content (`slot="primaryButton"`, `slot="secondaryButton"`). Primary sits to the right on larger screens.
On mobile, the buttons stack with the primary at the bottom. Every action must be wired up by the consumer.
The modal has no built-in submit behavior.

```html
<elvia-modal isShowing>
  <div slot="content">Er du sikker på at du vil slette kontrakten?</div>
  <button slot="primaryButton">Slett kontrakt</button>
  <button slot="secondaryButton">Avbryt</button>
</elvia-modal>
```

### isShowing

Required. Controls whether the modal is rendered.

Example:

```html
<elvia-modal heading="Slett kontrakt" isShowing>
  <div slot="content">Er du sikker på at du vil slette kontrakten?</div>
  <button slot="primaryButton" class="e-btn e-btn--primary e-btn--lg" type="button">Slett kontrakt</button>
  <button slot="secondaryButton" class="e-btn e-btn--secondary e-btn--lg" type="button">Avbryt</button>
</elvia-modal>
```

### onClose

Fires when the modal closes from a backdrop click, Esc, or the close button.

The caller must set `isShowing` to false in the event handler.

```ts
modal.addEventListener('onClose', () => {
  modal.isShowing = false;
});
```

### disableClose

Prevents closing via click outside, Esc, or the close button. Only use it where an in-progress action makes an
accidental close destructive.

### hasCloseButton

Shows a close button in the top-right corner. Reserve for multi-page modals (see [Guidelines](#when-to-use)).
A single-page modal should close via its secondary button.

### illustration

Slot content (`slot="illustration"`). Adding it creates a layout with a fixed height and width, subject to
responsive constraints. Use for onboarding or celebratory moments, not for routine confirmations.

### maxWidth

Overrides the default max width. Only change it if content genuinely needs more room.

## Guidelines

### When to use

- The user must make an active choice before continuing
- A wrong or accidental decision would be critical (destructive actions, irreversible submissions)

### When not to use

- Back-to-back, repeatedly, in the same flow
- Long content the user needs to read carefully
- Anything that isn't a short, scannable decision

## Accessibility

- Focus is trapped inside the modal and moves to the first focusable element on open. To focus a different
  element first, add the `elvisFocusInitial` attribute to it.
- `disableClose` removes the Esc/outside-click escape hatch. Pair it with a visible way out (e.g. a cancel
  button) or keyboard users get stuck.
- Do not add custom keyboard handlers to the modal. It already handles Esc and Tab.

## Examples

**Input:** "Confirmation modal before a user revokes another user's access."

**Output:**

```html
<elvia-modal heading="Fjerne tilgang" isShowing>
  <div slot="content">Er du sikker på at du vil fjerne tilgangen til denne brukeren?</div>
  <button slot="primaryButton" class="e-btn e-btn--primary e-btn--lg" type="button">Fjern tilgang</button>
  <button slot="secondaryButton" class="e-btn e-btn--secondary e-btn--lg" type="button">Avbryt</button>
</elvia-modal>
```

**Input:** "A 4-step onboarding walkthrough for first-time users, with an illustration on each step."

**Output:**

```html
<elvia-modal hasCloseButton isShowing>
  <div slot="illustration">
    <img src="/assets/onboarding-step.svg" alt="" />
  </div>
  <div slot="content">
    <!-- Render one page per onboarding step -->
    <elvia-carousel> ... </elvia-carousel>
  </div>
</elvia-modal>
```

**Input:** "Show the full terms and conditions text in a modal."

**Output:** Not a modal. Use a dedicated terms page instead because the content is too long to be short and
scannable.

```html
<a href="https://www.example.com" class="e-link"> Les vilkårene </a>
```
brainstormingobra/superpowersYou MUST use this before any creative work - creating features, building components, adding functionality, modifying behavior, or planning anything new, in software or out of it (a talk, a business, a renovation).Stars: 322kUpdated Claude CodeCodexVerifiedInstall
brand-guidelinesanthropics/skillsApplies Anthropic's official brand colors and typography to any sort of artifact that may benefit from having Anthropic's look-and-feel. Use it when brand colors or style guidelines, visual formatting, or company design standards apply.Stars: 198kUpdated Claude CodeCodexVerifiedInstall
frontend-designanthropics/skillsGuidance for distinctive, intentional visual design when building new UI or reshaping an existing one. Helps with aesthetic direction, typography, and making choices that don't read as templated defaults.Stars: 198kUpdated Claude CodeCodexVerifiedInstall
mcp-builderanthropics/skillsGuide for creating high-quality MCP (Model Context Protocol) servers that enable LLMs to interact with external services through well-designed tools. Use when building MCP servers to integrate external APIs or services, whether in Python (FastMCP) or Node/TypeScript (MCP SDK).Stars: 198kUpdated Claude CodeCodexVerifiedInstall