Skip to content

ui advanced

Everything else the package exports, for when you go beyond its components and hooks, such as your own queries or cache updates. Most projects never need these.

Other functions and constants13
buttonPropsEverything that makes an element a button, as one value: the identity, the two role attributes, and the structural classes.
@evolve-storefront/ui/button
nearestIndexThe index of the item whose start is nearest position, or 0 for no items.
@evolve-storefront/ui/carousel
stepTargetPicks the scroll offset one item away from current, clamped to the track.
@evolve-storefront/ui/carousel
checkBrandContrastCheck a brand stylesheet's color tokens against CONTRAST_PAIRS, in every block that declares them.
@evolve-storefront/ui/contrast
CONTRAST_PAIRSThe color-token pairs a component renders one on the other, with the WCAG AA minimum each must meet: 4.5 for text, 3 for a control's boundary or focus ring.
@evolve-storefront/ui/contrast
iconsThe semantic icon map — the only module here that imports an icon library; everything else renders <Icon name="…" />.
@evolve-storefront/ui/default-icons
subLevelThe level one step below level, clamped at 6 so a derived level can never overflow into an invalid tag.
@evolve-storefront/ui/heading
announceAnnounce a message to assistive technology, with no live region in the tree.
@evolve-storefront/ui/helpers/announce
focusClearanceThe rule behind FocusClearOfOverlays: scroll a focused control that sits inside the root's scroll-padding band, where a sticky header, a fixed bar or a banner covers it, unless the control is in such an overlay itself or the browser is only restoring focus after the window comes back.
@evolve-storefront/ui/helpers/focus-clear-of-overlays
cnClassname helper that merges classNames together.
@evolve-storefront/ui/helpers/styles
iconsThe semantic icon map — the only module here that imports an icon library; everything else renders <Icon name="…" />.
@evolve-storefront/ui/icons
navItemVariantsThe current route reads the identity role, not a rank.
@evolve-storefront/ui/nav-item
keepApartHolds the end that moved at least minDistance away from the other one.
@evolve-storefront/ui/range-slider
Types18
MenuAction
@evolve-storefront/ui/actions-menu
ButtonToneWhat kind of action it is.
@evolve-storefront/ui/button
ButtonVariantHow much the action stands out.
@evolve-storefront/ui/button
CalloutToneWhat kind of thing the callout is saying.
@evolve-storefront/ui/callout
ContrastFailure
@evolve-storefront/ui/contrast
IconComponentThe shape every icon in the map satisfies.
@evolve-storefront/ui/default-icons
IconNameEvery semantic icon name in the set.
@evolve-storefront/ui/default-icons
DropdownMenuPlacementWhere the menu opens relative to its trigger.
@evolve-storefront/ui/dropdown-menu
FormValidationErrorsA { field: string[] } map, e.g.
@evolve-storefront/ui/form
HeadingLevelA semantic heading level, h1–h6.
@evolve-storefront/ui/heading
FocusClearanceEnvThe browser surface the clearance reads, injected so the rule runs without a DOM.
@evolve-storefront/ui/helpers/focus-clear-of-overlays
IconComponentThe shape every icon in the map satisfies.
@evolve-storefront/ui/icons
IconNameEvery semantic icon name in the set.
@evolve-storefront/ui/icons
PaginationLinkRendererRenders one step of the pager as a link.
@evolve-storefront/ui/pagination
PopoverPlacementWhere the popover opens relative to its trigger.
@evolve-storefront/ui/popover
RangeSliderValue
@evolve-storefront/ui/range-slider
SelectPlacementWhere the listbox opens relative to the trigger.
@evolve-storefront/ui/select
StatusBadgeToneThe semantic tones a status can map to.
@evolve-storefront/ui/status-badge

Not listed: 65 props and options types. They appear as the tables on the pages of what they type.