Skip to main content
Neural UIv2.0.0Documentation
View v1 GitHub

Design tokens

Change a visible component property, understand its scope and explore the package’s public tokens.

Change corners in one scope

--neu-radius is a shared foundation token. Compare square corners with 6px corners in Input and a medium Button. Only descendants of each CSS scope receive its override. Different sizes may consume a different radius token.

Use your own namespace for application layout variables; use public --neu-* tokens to customize Neural components.

Change corners in one scope

--neu-radius: 0

--neu-radius: 6px

Apply an override globally

Place the root override after the Core SCSS import in styles.scss. It affects descendants that consume --neu-radius unless a more specific declaration replaces it. A shared token is broader than a single component.

styles.scss
@use '@neural-ui/core/styles' as *;

:root {
  --neu-radius: 6px;
}

Customize a Button background

The colored Button in the first example scopes four public Button tokens: background, foreground, border and hover background. They apply to its solid brand treatment; do not assume the same tokens change every variant.

The background expression falls back to the semantic solid color when a usable component value is absent. Once the component token has a value, changing the semantic fallback does not replace it. Set a valid foreground and hover pair rather than changing background alone.

styles.scss · fragment
/* Fragment: local styles for a solid brand Button. */
.custom-action {
  --neu-button-background: #175d95;
  --neu-button-foreground: #ffffff;
  --neu-button-border: #175d95;
  --neu-button-background-hover: #124c7d;
}

Read the effective value

Foundation tokens describe shared scales such as spacing and radius. Semantic tokens describe roles such as text, surface or primary. Component tokens narrow a role to a control.

The final CSS value depends on mode, preset, scope, specificity and var() fallback resolution. The reference lists a declared default, not a universal computed value. A var(--neu-surface) default changes when the inherited surface changes.

All public tokens

Search by token, owner or description. The table exposes every public token in the installed package; it initially shows 40 rows and the Show all action reveals the rest, displaying the current total. Filtered results are not capped.

Default source identifies where the value is declared. Fallback lists referenced tokens; consumed by identifies recorded consumers, not a guarantee that every visual state uses that token. No private implementation tokens are included.

Showing 40 of 262 · 262 total
Token
Description
Category / owner
Declared default / source
Fallback
Consumed by
--neu-accent Shared setting: accent. Check consumers and fallback before changing it. Semantic
semantic
#5ac8fa
Root declaration
—
--neu-alert-danger-bg alert setting: danger · background. Check consumers and fallback before changing it. Component
alert
var(--neu-alert-error-bg)
Root declaration
--neu-alert-error-bg
--neu-alert-danger-border alert setting: danger · border. Check consumers and fallback before changing it. Component
alert
var(--neu-alert-error-border)
Root declaration
--neu-alert-error-border
--neu-alert-danger-text alert setting: danger · text. Check consumers and fallback before changing it. Component
alert
var(--neu-alert-error-text)
Root declaration
--neu-alert-error-text
--neu-alert-dismiss-hover-bg alert setting: dismiss · hover state · background. Check consumers and fallback before changing it. Component
alert
rgb(0 0 0 / 8%)
Root declaration
— chip
--neu-alert-error-bg alert setting: error · background. Check consumers and fallback before changing it. Component
alert
var(--neu-error-bg)
Root declaration
--neu-error-bg alert
--neu-alert-error-border alert setting: error · border. Check consumers and fallback before changing it. Component
alert
rgba(239, 68, 68, 0.2)
Root declaration
— alert
--neu-alert-error-text alert setting: error · text. Check consumers and fallback before changing it. Component
alert
var(--neu-error-text)
Root declaration
--neu-error-text alert
--neu-alert-info-bg alert setting: info · background. Check consumers and fallback before changing it. Component
alert
var(--neu-info-bg)
Root declaration
--neu-info-bg alert
--neu-alert-info-border alert setting: info · border. Check consumers and fallback before changing it. Component
alert
rgba(0, 122, 255, 0.2)
Root declaration
— alert
--neu-alert-info-text alert setting: info · text. Check consumers and fallback before changing it. Component
alert
var(--neu-info-text)
Root declaration
--neu-info-text alert
--neu-alert-success-bg alert setting: success · background. Check consumers and fallback before changing it. Component
alert
var(--neu-success-bg)
Root declaration
--neu-success-bg alert
--neu-alert-success-border alert setting: success · border. Check consumers and fallback before changing it. Component
alert
rgba(16, 185, 129, 0.2)
Root declaration
— alert
--neu-alert-success-text alert setting: success · text. Check consumers and fallback before changing it. Component
alert
var(--neu-success-text)
Root declaration
--neu-success-text alert
--neu-alert-warning-bg alert setting: warning · background. Check consumers and fallback before changing it. Component
alert
var(--neu-warning-bg)
Root declaration
--neu-warning-bg alert
--neu-alert-warning-border alert setting: warning · border. Check consumers and fallback before changing it. Component
alert
rgba(245, 158, 11, 0.2)
Root declaration
— alert
--neu-alert-warning-text alert setting: warning · text. Check consumers and fallback before changing it. Component
alert
var(--neu-warning-text)
Root declaration
--neu-warning-text alert
--neu-autocomplete-option-height autocomplete setting: option · height. Check consumers and fallback before changing it. Component
autocomplete
40px
Root declaration
— autocomplete
--neu-bg Base background color for a page or surface. Semantic
semantic
#f8fafc
Root declaration
— select
--neu-block-ui-bg block-ui setting: background. Check consumers and fallback before changing it. Component
block-ui
rgba(255, 255, 255, 0.6)
Root declaration
— block-ui
--neu-block-ui-radius block-ui setting: corner radius. Check consumers and fallback before changing it. Component
block-ui
var(--neu-radius-lg)
Root declaration
--neu-radius-lg block-ui
--neu-border Shared setting: border. Check consumers and fallback before changing it. Semantic
semantic
rgba(15, 23, 42, 0.08)
Root declaration
— accordion, autocomplete, badge, bottom-sheet, calendar, card, carousel, cascade-select, chip, command-palette, confirm-popup, dashboard-grid, data-view, date-input, divider, dock, empty-state, gallery, inline-editor, input-mask, input-tags, input, kanban, listbox, mega-menu, menu, modal, nav, number-input, pagination, panel, password, pick-list, rich-text-editor, select, sidebar, speed-dial, spinner, split-button, stats-card, stepper, table, tabs, tag, textarea, timeline-grid, timeline, toggle-button-group, tree-select, tree-table, tree, uploader
--neu-border-color Shared setting: border · color. Check consumers and fallback before changing it. Semantic
semantic
var(--neu-border)
Root declaration
--neu-border color-picker, confirm-dialog, context-menu, filter-bar, input-otp, knob, notification-center, popover, splitter, toolbar
--neu-border-focus Shared setting: border · focus. Check consumers and fallback before changing it. Semantic
semantic
var(--neu-primary)
Root declaration
--neu-primary rich-text-editor, textarea
--neu-border-hover Shared setting: border · hover state. Check consumers and fallback before changing it. Semantic
semantic
rgba(15, 23, 42, 0.16)
Root declaration
— autocomplete, card, chip, date-input, input, modal, pagination, pick-list, radio, select, Shared styles, table, uploader
--neu-border-subtle Shared setting: border · subtle. Check consumers and fallback before changing it. Semantic
semantic
var(--neu-border)
Root declaration
--neu-border cascade-select
--neu-button-background Background of the solid brand Button treatment. Component
button
var(--neu-primary-solid)
component-fallback
--neu-primary-solid button
--neu-button-background-hover Hover/active background of the solid brand Button treatment. Component
button
var(--neu-primary-solid-hover)
component-fallback
--neu-primary-solid-hover button
--neu-button-border Border color paired with the solid brand Button background. Component
button
var(--neu-primary-solid)
component-fallback
--neu-primary-solid button
--neu-button-foreground Text and icon color paired with the solid brand Button background. Component
button
var(--neu-primary-solid-fg)
component-fallback
--neu-primary-solid-fg button
--neu-cmd-bg cmd setting: background. Check consumers and fallback before changing it. Component
cmd
var(--neu-surface)
Root declaration
--neu-surface
--neu-cmd-highlight cmd setting: highlight. Check consumers and fallback before changing it. Component
cmd
var(--neu-primary-50)
Root declaration
--neu-primary-50
--neu-cmd-radius cmd setting: corner radius. Check consumers and fallback before changing it. Component
cmd
var(--neu-radius-xl)
Root declaration
--neu-radius-xl
--neu-cmd-shadow cmd setting: shadow. Check consumers and fallback before changing it. Component
cmd
var(--neu-shadow-lg)
Root declaration
--neu-shadow-lg command-palette
--neu-code-block-accent code-block setting: accent. Check consumers and fallback before changing it. Component
code-block
#9ab8ff
Root declaration
— code-block
--neu-code-block-bar-bg code-block setting: bar · background. Check consumers and fallback before changing it. Component
code-block
#16161e
Root declaration
— code-block
--neu-code-block-bg code-block setting: background. Check consumers and fallback before changing it. Component
code-block
#1a1b26
Root declaration
— code-block
--neu-code-block-border code-block setting: border. Check consumers and fallback before changing it. Component
code-block
rgba(255, 255, 255, 0.14)
Root declaration
— code-block
--neu-code-block-copy-bg code-block setting: copy · background. Check consumers and fallback before changing it. Component
code-block
rgba(255, 255, 255, 0.12)
Root declaration
— code-block
--neu-code-block-copy-border code-block setting: copy · border. Check consumers and fallback before changing it. Component
code-block
rgba(255, 255, 255, 0.22)
Root declaration
— code-block