Skip to content
Kimenpre-v1documentation home
Color scheme
Menu

Start building with Kimen.

Standards-first ki-* elements, two themes and a guarded catalog for agent-written UI. Install it, pick your path, find your component.

Two steps to a working element

  1. Install

    pnpm add @kimen/elements @kimen/tokens

    While Kimen is pre-v1, build it from the repository. This command will work once the packages publish.

  2. Import and use

    import { defineCustomElement } from '@kimen/elements/ki-button';
    import '@kimen/tokens/css';
    defineCustomElement();
    // In your markup:
    <ki-button variant="primary">Save</ki-button>

Pick your path

By hand, in any framework

Import the elements you use, load the token stylesheet and write markup. React, Vue and Angular also have typed wrappers.

By agents, through the catalog

Your agent emits a JSON spec. The catalog validates it before rendering the same elements.

Components

Try a component or open its documentation for examples and the API.

Actions

  • Save
    ki-button

    A token-styled action button with native button semantics.

  • ki-button-group

    Group related actions in a spaced row, an attached control or a keyboard toolbar.

  • ki-confirmation

    Ask someone to approve or refuse a specific assistant action.

  • ki-copy-button

    Copy a link, token, identifier or code sample to the clipboard.

  • ki-fab

    A floating action button for the primary action of a screen.

  • ki-fab-menu

    A floating action button with two to six related actions.

  • ki-fab-menu-item

    A command or native link inside a floating action menu.

  • ki-icon-button

    A token-styled, icon-only action button with a mandatory accessible name.

  • ki-menu

    Show grouped row, overflow, or account actions from a named button.

  • ki-menu-group

    A named group of related menu actions.

  • ki-menu-item

    A selectable action within an action menu.

  • ki-suggestion

    Supply a prompt title and optional description in a suggestions group.

  • ki-suggestions

    Offer prompt starters and follow-up suggestions in a conversation.

  • ki-toolbar

    Keep frequent page actions within reach with a floating or docked toolbar.

Forms

  • Weekly digest
    ki-checkbox

    A form-associated checkbox for selecting independent options.

  • ki-checkbox-group

    Group independent checkbox options under one label and form field.

  • ki-chip

    An independent filter, removable picked value, or contextual action.

  • ki-chip-group

    A labelled collection of filter, input or assist chips.

  • ki-code-input

    Collect a one-time verification code in one field with a box for each character.

  • ki-combobox

    Search a list, select one or more options, or add a custom value.

  • ki-date-picker

    Select one date or a range with localized text entry and a keyboard-operable calendar.

  • ki-file-upload

    Collect files, explain rejected selections and show application-reported upload progress.

  • ki-input

    A token-styled single-line text field with native input semantics.

  • ki-number-input

    Enter a number with optional steppers, bounds, a unit, and localized formatting.

  • ki-option

    A declarative data option rendered by its owning ki-select.

  • ki-prompt-input

    Compose assistant messages with a growing draft, file attachments and send or stop controls.

  • ki-radio

    One option in a token-styled radio group.

  • SoloTeam
    ki-radio-group

    A token-styled radio group that owns selection, keyboard coordination and form participation.

  • ki-rating

    Show an average score or ask for a rating on a small scale.

  • ki-search

    A search field with suggestions, recent searches and host-rendered results.

  • ki-search-suggestion

    A suggestion or recent query for ki-search.

  • ki-segment

    An option within a segmented control.

  • ki-segmented-control

    Apply one of two to five options in place.

  • eu-westus-east
    ki-select

    A form-associated select-only combobox for choosing one option from declarative ki-option children.

  • ki-slider

    Choose a value or an interval on a continuous scale.

  • Invite via link
    ki-switch

    A token-styled switch for immediate on/off settings.

  • ki-textarea

    A token-styled multiline text field with native form semantics.

  • ki-time-input

    Enter a time of day in the page language or choose a suggested slot.

Navigation

  • ki-breadcrumb

    Show the page's position in a hierarchy and make its ancestor pages reachable.

  • ki-breadcrumb-item

    Declare one level of a breadcrumb with a plain-text label and an optional destination.

  • ki-indicator

    A non-interactive page-position indicator — one dot per position, exactly one current.

  • ki-link

    Navigate to a page, section, or resource with native link behavior.

  • ki-mobile-nav

    Fixed or floating bottom navigation for three to five phone destinations.

  • ki-mobile-nav-item

    A labeled link with a decorative icon and optional unread count for MobileNav.

  • ki-pagination

    Move through pages of results or append another batch.

  • ki-sidebar

    Grouped navigation for applications with an optional icon rail.

  • ki-sidebar-group

    A labelled list of related sidebar destinations.

  • ki-sidebar-item

    A named destination within Sidebar navigation.

  • ki-step

    Declare a named step in a Stepper.

  • ki-stepper

    Show progress through named, ordered steps.

  • ki-tab

    One selectable tab inside a ki-tabs view switcher.

  • ki-tab-panel

    One content view paired with a ki-tab inside ki-tabs.

  • EmailSecurityEmail preferencesSign-in preferences
    ki-tabs

    A tab group for switching between peer content views.

  • ki-top-nav

    Group primary navigation in a site header or present the current screen in an app bar.

  • ki-tree

    Browse, select or navigate a hierarchy of collapsible branches.

  • ki-tree-item

    A row or a collapsible branch inside a Tree.

Feedback

  • ki-ai-label

    Identify AI-generated content and let people inspect its provenance.

  • Draft stored.
    ki-alert

    A persistent inline status message with token-backed tone semantics.

  • ki-empty-state

    Explain an empty list, table, search result, or first-run view.

  • ki-note

    Short, static context beside a control or inside a card.

  • ki-progress

    A token-styled, non-interactive progress indicator for known or unknown duration work.

  • ki-reasoning

    Show an assistant's plan or supporting steps in a disclosure.

  • ki-skeleton

    Reserve space for a loading card, list, or assistant reply.

  • ki-spinner

    Indicate indeterminate inline activity with a ring or typing dots.

  • API gateway
    ki-status

    A tiny, non-interactive status dot that marks the state of a nearby item.

  • ki-toast

    A short, transient message about something the person just did, shown without blocking the page.

  • ki-toaster

    The one place toasts appear, stacked in arrival order, the newest shown and the older queued.

  • ki-tool-call

    Inspect the status, duration and payloads of an assistant tool call.

  • ki-tooltip

    A transient, text-only hint with an optional heading.

Layout

  • ki-accordion

    Group related native disclosures.

  • Workspace3 members · eu-west
    ki-card

    Group related content in a card with an optional primary link or action.

  • ki-carousel

    Navigate a swipeable sequence of slides and show the current position.

  • ki-carousel-item

    Provide one slide and optional decorative preview media to a carousel.

  • ki-details

    Reveal supporting content with a native disclosure.

  • ki-dialog

    A centered or fullscreen modal dialog for a decision or focused task.

  • AboveBelow
    ki-divider

    A static, decorative rule that visually separates adjacent content.

  • ki-drawer

    A modal or non-modal sheet for editing in context and showing short actions.

  • ki-grid

    Arrange content on responsive tracks using Kimen spacing steps.

  • ki-popover

    Open non-modal content beside a button.

  • ki-scroller

    A bounded scroll container with a token-resolved indicator instead of platform scrollbar chrome.

  • ki-stack

    Arrange content on one axis using Kimen spacing steps.

Data

  • ki-audio

    Play an audio recording with a seek control, playback speed and a transcript link.

  • ki-avatar

    A static identity visual with a portrait → initials → generic figure fallback chain.

  • ki-avatar-group

    Stacks ki-avatar children as one overlapping row with a visible cap and a "+N" overflow counter.

  • Syncedeu-west
    ki-badge

    A static, non-interactive status pill.

  • ki-citation

    Mark a claim with a numbered reference to its source.

  • ki-code-block

    Display source with syntax highlighting, line controls and a copy button.

  • ki-conversation

    Display and optionally follow a transcript of user messages, replies and system events.

  • ki-counter

    A decorative unread count or presence dot on a trigger.

  • ki-feature-icon

    Place a decorative Lucide glyph on a tinted tile beside a heading.

  • ki-format-date

    Display a localized date or timestamp from an ISO value.

  • ki-format-number

    Display localized numbers, currencies, percentages and units.

  • ki-icon

    Display one imported Lucide glyph by name.

  • ki-image

    An image frame with lazy loading, alternative text, an optional caption, and a fallback.

  • Ana GarcíaMina Kato
    ki-list

    A vertical list of static entries, links, settings controls, or selectable options.

  • ki-list-item

    A configurable row in a static or interactive list.

  • ki-markdown

    Render formatted, streamed Markdown with Kimen typography and URL checks.

  • ki-message

    Present a user turn, an assistant reply or a system event in a transcript.

  • ki-qr

    A machine-scannable QR code, encoded locally and restyled entirely through tokens.

  • ki-relative-time

    Display a localized timestamp relative to the current time.

  • ki-source

    Declare one web reference for a Sources disclosure.

  • ki-sources

    List the evidence behind an answer and cite it from the claims it supports.

  • ki-stat

    Show a key number and its optional change against a reference period.

  • ki-table

    Native data tables with sortable headers, row selection and sticky scrolling.

  • ki-timeline

    Present events in chronological order with a timestamp for each entry.

  • ki-timeline-item

    Show an event, a timestamp and optional details in a timeline.

  • ki-video

    A themed video surface — a calm poster facade with one accessible play control over a slotted native video.