Skip to content
Kimenpre-v1documentation home
Color scheme

ki-note

Use a note for a short constraint, tip or consequence. Place it beside the control or passage it explains. Put the consequence first in warnings.

Theme for this example
Color scheme for this example
Only workspace owners can change billing details. Changing the slug breaks existing links. Billing statements remain available for one year.
<ki-note>Only workspace owners can change billing details.</ki-note>
<ki-note tone="warning" size="sm">Changing the slug breaks existing links.</ki-note>
<ki-note icon="false">Billing statements remain available for one year.</ki-note>

Icons and accessibility

The note is static text. It adds no landmark, announcement or tab stop. The icon is decorative. Use words that convey the message by themselves.

Supply a decorative glyph through the icon slot. Set icon="false" in HTML or element.icon = false in JavaScript to hide the icon and reclaim its space.

Use ki-alert for updates that must be announced, Toast for transient confirmations and the field’s help-text for field guidance.

API reference

When to use: Add a short constraint, tip or consequence next to the content it explains. Put the consequence first when warning the reader.

When not to use: For updates that must be announced, use ki-alert. Use Toast for transient confirmations and the field's help-text for field guidance.

Properties & attributes

AttributePropertyTypeDefaultDescription
iconiconbooleantrueShows the decorative icon. Set icon="false" in HTML to hide it.
sizesize"md" | "sm"'md'Uses caption text at sm and body text at md. Unknown values use md.
tonetone"danger" | "info" | "neutral" | "primary" | "success" | "warning"'neutral'Selects the background tint and decorative icon. Unknown values use neutral.

Slots

SlotDescription
(default)Short explanatory text that carries the full meaning.
iconA decorative glyph that replaces the tone's built-in icon.

CSS parts

PartDescription
iconThe decorative icon frame.
messageThe explanatory text.
noteThe surface, including the tint, typography and spacing.

CSS custom properties

The public styling contract of ki-note: reassign these tokens at :root or on a subtree — never override internals.

TokenDescription
--ki-density-space-scaleMultiplies every scaled container padding and gap (card, dialog, alert, list, list item, select listbox, tab panel, tooltip).
--ki-note-backdrop-filterComplete filter behind the note.
--ki-note-bgBackground of a neutral note.
--ki-note-bg-imageOptional image over the note's solid background.
--ki-note-danger-bgBackground of a danger note.
--ki-note-danger-fgText ink of a danger note.
--ki-note-danger-iconDecorative icon ink of a danger note.
--ki-note-fgText ink of a neutral note.
--ki-note-font-familyNote text font family.
--ki-note-font-sizeMedium note text size.
--ki-note-gapSpace between the icon and the text.
--ki-note-iconDecorative icon ink of a neutral note.
--ki-note-icon-offsetMedium icon offset from the first line's block start.
--ki-note-icon-sizeMedium note icon size.
--ki-note-info-bgBackground of an info note.
--ki-note-info-fgText ink of an info note.
--ki-note-info-iconDecorative icon ink of an info note.
--ki-note-line-heightMedium note text line height.
--ki-note-padding-blockMedium note block padding.
--ki-note-padding-inlineMedium note inline padding.
--ki-note-primary-bgBackground of a primary note.
--ki-note-primary-fgText ink of a primary note.
--ki-note-primary-iconDecorative icon ink of a primary note.
--ki-note-radiusNote surface corner radius.
--ki-note-sm-font-sizeSmall note caption size.
--ki-note-sm-icon-offsetSmall icon offset from the first line's block start.
--ki-note-sm-icon-sizeSmall note icon size.
--ki-note-sm-line-heightSmall note caption line height.
--ki-note-sm-padding-blockSmall note block padding.
--ki-note-sm-padding-inlineSmall note inline padding.
--ki-note-success-bgBackground of a success note.
--ki-note-success-fgText ink of a success note.
--ki-note-success-iconDecorative icon ink of a success note.
--ki-note-warning-bgBackground of a warning note.
--ki-note-warning-fgText ink of a warning note.
--ki-note-warning-iconDecorative icon ink of a warning note.

Workshop

Open ki-note in Storybook