Home > @uniformdev/design-system

design-system package

Classes

ClassDescription
LinkNode

Enumerations

EnumerationDescription
DateTimePickerVariant

Functions

FunctionDescription
AddButton({ buttonText, onClick, shortcut, macShortcut, ...props })Add button component
AddListButton({ buttonText, onButtonClick, disabled, icon, variant, theme, ...buttonProps })Uniform Add List Button Component
addPathSegmentToPathname(path, pathSegment)Joins different variants of parent relative url with path segment. Path can be "", "/" and "/foo/bar"
AsideAndSectionLayout({ sidebar, children, isStickyAside, })
Avatar({ src, label, children, size, as, labelWithoutPortal, ...props })A component to render rounded avatars of a user or an app.
AvatarGroup({ max, children, getTruncatedLabel, truncatedProps, ...props })Renders avatars in a group with the ability to truncate the list. This component works best when the <Avatar> component are direct children.
Banner({ type, onDismiss, children, isAnimated, ...props })Uniform Banner Component
buttonRippleEffect(props)
ButtonWithMenu({ onButtonClick, buttonText, icon, disabled, children, placement, size, menuContainerCssClasses, portal, maxMenuHeight, tooltip, shortcut, buttonType, ...buttonProps })
Calendar({ value, timeZone, minValue, maxValue, onChange, styles: stylesProp, autoFocus, isDisabled, isInvalid, isReadOnly, withTodayButton, isDateUnavailable, ...props })A Calendar Grid which allows the user to navigate and select a date.
Callout({ type, compact, title, children, className, testId, })Uniform Callout Component
Caption({ children, testId, dynamicSize, ...props })Component that provides caption text to input fields
Card({ title, menuItems, children, titleWithMarginBottom, disabled, tag: Tag, menuButtonTestId, ...props })
CardContainer({ bgColor, padding, withLastColumn, children, ...props })Uniform Card Container
CardTitle({ title, titleWithMarginBottom, children })
Chip({ icon, iconColor, text, size, theme, variant, chipAction, isDisabled, as, ...props })Chips are used in a variety of ways To represent tokens, where the value of the chip will be replaced with something dynamically. To represent tags or important metadata about an object To represent a different object, as a reference
Container({ tag, backgroundColor, border, rounded, padding, margin, children, ...props })
convertComboBoxGroupsToSelectableGroups(args)Converts combo box options that can contain optgroups Into a set of group-less options where the optgroup becomes a selectable option, and selecting it selects all of its children.
Counter({ count, bgColor, icon, iconColor, size, ...props })
cq(size)Container Query Helper Function
CreateTeamIntegrationTile({ title, buttonText, onClick, asDeepLink, ...props })
DashedBox({ bgColor, textAlign, boxHeight, children, ...props })Uniform Dashed Box Component
DateTimePicker({ id, label, triggerIcon, value, minVisible, maxVisible, variant, caption, placeholder, belowTimeInputSlot, showLabel, errorMessage, warningMessage, disabled, onChange, offset, testId, placement, portal, compact, ...props })<p>Date Time Picker This is a Calendar, Time input and TimeZone selector housed in a popup. You can use it to pick a date as well as a time, or you can also change it to only pick a date.</p><p>Subcomponents can manipulate the value directly by using the <code>useDateTimePickerContext()</code> hook.</p>
DateTimePickerSummary({ value, placeholder, })
debounce(fn, ms)
Details({ summary, children, isOpenByDefault, isOpen, isIndented, isCompact, onChange, ...props })
DismissibleChipAction({ onDismiss, ...props })Dismissible chip action should be used with the Chip component
DrawerContent({ children, buttonGroup, noPadding, ...props })
DrawerProvider({ children })Provides the context to the Drawer and DrawerRenderer components.
DrawerRenderer({ stackId, position, width, minWidth, maxWidth, leftAligned, withoutFluidWidth, ...otherProps })Renders a stack of drawers in a different location than their original position in the component tree. Uses React Portal under the hood. DrawerProvider - Must be rendered inside a <code><DrawerProvider></code>.
EditTeamIntegrationTile({ id, icon, name, onEdit, isPublic, canEdit, })Uniform Edit Team Integration Tile
ErrorMessage({ message, testId, truncated, ...otherProps })Component that provides error messaging to input fields
extractParameterProps(props)A function that extracts all common props and element props
FieldMessage({ helperMessage, warningMessage, errorMessage, infoMessage, errorTestId, helperMessageTestId, })
FlexiCard({ heading, children, width, height, maxHeight, ...props })
FlexiCardTitle({ icon, heading, ...props })Flexi Card Title Component recommended to be used within the FlexiCard component
getButtonSize(size)
getButtonStyles({ size, ...props })
getComboBoxSelectedSelectableGroups(selectedValues)Finds all selected values in a combo box where there are multiple selectable groups (and selecting a group should select all of its virtual children)
getDrawerAttributes({ providerId, stackId, id, })
getFormattedShortcut(shortcut)<p>Gets a formatted version of a shortcut for display.</p><p>i.e. converts "mod+alt+n" to "['⌘', '⌥', 'N']" on macs, or ['^', 'Alt', 'N'] on windows.</p>
getParentPath(path, noRootSlash)
getPathSegment(path)
Heading({ level, as, withMarginBottom, children, ...hAttributes })Component that sets the heading tag
HexModalBackground({ ...props })
HorizontalRhythm({ align, justify, tag, gap, children, ref, ...props })
IconsProvider({ children })Provider to the Icon component
Image_2({ alt, src, srcSet, className, imgClassName, variant, width, height, errorFallbackSrc, ...imgAttribs })
ImageBroken({ width, height, ...props })
InfoMessage({ message, testId, icon, ...props })Component that provides info messaging to input fields
input(whiteSpaceWrap)
InputComboBox(props)InputComboBox
InputCreatableComboBox(props)InputCreatableComboBox Like ComboBox, but allows for creating new options
InputInlineSelect({ classNameContainer, options, value, onChange, disabled, ...props })Input Inline Select
IntegrationComingSoon({ name, icon, id, onUpVoteClick, timing, ...props })Uniform Integration Coming Soon Component
IntegrationLoadingTile({ count })Uniform Integration Loading Tile
IntegrationModalHeader({ icon, name, menu, children })Uniform Integration Modal Header
IntegrationModalIcon({ icon, name, ...imgProps })Uniform Integration Modal Icon
IntegrationTile({ id, icon, name, requiedEntitlement, onAddIntegration, isPublic, isInstalled, authorIcon, ...btnProps })
isSecureURL(value)
isValidUrl(urlString, options)
JsonEditor({ defaultValue, onChange, jsonSchema, height, readOnly })
KeyValueInput({ value, onChange, label, newItemDefault, keyLabel, valueLabel, iconLabel, keyInfoPopover, valueInfoPopover, iconInfoPopover, disabled, errors, onFocusChange, showIconColumn, renderIconSelector, independentKeyValue, })A component to render a sortable key-value input
Label({ children, className, testId, ...props })
LabelLeadingIcon({ icon, iconColor, children, isActive, isLocked, title, ...props })
LabelsQuickFilter({ buttonText, addButtonText, items, selectedIds, onSelect, onDeselect, disabled, testId, totalResults, onCreateLabel, withoutPortal, maxContainerSize, onOpen, onClose, menuPlacement, menuGetAnchorRect, menuUpdatePosition, maxCount, })A reusable quick filter component for selecting labels with swatch colors. Supports flat labels and grouped labels with nested menus.
Legend({ children })
LimitsBar({ current, max, popoverContent, barColor, ...props })Uniform Limits Bar Component
LinkList({ title, children, ...props })
LoadingCardSkeleton()
LoadingIcon({ height, width, ...props })Loading Icon
LoadingIndicator({ size, color, ...props })Loading Indicator
LoadingOverlay({ isActive, statusMessage, zIndex, loaderSize, overlayBackgroundColor, isTopAligned, isPaused, children, position, })Loading Overlay. NOTE: the container/parent element must have a non-static <code>position</code> value for the overlay to work properly.
MenuGroup({ title, children })
MenuItemEmptyIcon()Indents a menu item as if it had an icon when it does not Use this to align menu items without icons with those that have icons in a mixed menu. Intended to be passed as the <code>icon</code> prop to a MenuItem.
MenuItemIcon({ icon, size })Renders an icon for a menu item. Optional micro wrapper around an Icon component configured to match the menu item icon style.
MenuItemSeparator({ ...props })
mq(size, bound)Media Query Helper Function
MultilineChip({ children, onClick, ...props })A chip specifically designed to fit as a chipped element in an multi-line capable content field. Unlike a regular chip, this one can go onto multiple lines with word wrap, and uses inline behaviours.
ObjectGridItem({ header, cover, rightSlot, menuItems, isSelected, children, menuTestId, ...props })<p>A card-style grid item for displaying an object with cover media, heading, subtitle, and optional context menu.</p><p>When an <code>onClick</code> handler is provided, the entire card becomes clickable with hover styles. Menu and right-slot interactions use <code>stopPropagation</code> to prevent triggering the card click. Wrap items with ObjectGridContainer for responsive grid layout.</p>
ObjectGridItemCardCover(props)Low-level cover media for a grid card — renders either a lazy-loaded image or an icon with a ghost background. Typically used via ObjectGridItemCover() rather than directly.
ObjectGridItemCover({ coverSlotLeft, coverSlotRight, coverSlotBottomLeft, coverSlotBottomRight, ...props })Grid item cover with corner overlay slots for badges, checkboxes, or status indicators. Wraps ObjectGridItemCardCover() and positions slot content at each corner.
ObjectGridItemCoverButton({ id, isSelected, onSelection, selectedText, coverSlotBottomRight, ...props })Clickable variant of ObjectGridItemCover() that acts as a selection toggle. When selected, a chip with <code>selectedText</code> appears in the bottom-right corner. Click events are stopped from propagating to parent elements.
ObjectGridItemHeading({ heading, beforeHeadingSlot, afterHeadingSlot, tooltip, ...props })<p>Heading component designed for use inside ObjectGridItem()'s <code>header</code> slot.</p><p>Automatically detects when the heading text is truncated (via a <code>ResizeObserver</code>) and shows the <code>tooltip</code> on hover so users can still read the full title. Click events on <code>beforeHeadingSlot</code> and <code>afterHeadingSlot</code> are stopped from propagating to the parent grid item.</p>
ObjectGridItemIconWithTooltip({ tooltipTitle, placement, icon, iconColor, ...props })Small icon with a tooltip, designed for the <code>rightSlot</code> of ObjectGridItem(). Useful for showing contextual indicators (e.g. entry type, locale) without taking up text space.
ObjectGridItemLoadingSkeleton()Animated skeleton placeholder for ObjectGridItem(), displayed while data is loading. Renders a simulated cover image and two text lines matching the visual dimensions of a real grid card so the layout doesn't shift on load.
ObjectItemLoadingSkeleton({ showCover, renderAs, })Animated skeleton placeholder for ObjectListItem(), displayed while data is loading. Matches the visual dimensions of a real list item so the layout doesn't shift on load.
ObjectListItem({ minContainerQueryWidth, ...props })<p>A horizontal list item for displaying an object with header, cover, right slot, and optional context menu.</p><p>Uses container queries so the layout adapts to its parent width rather than the viewport. Wrap items with ObjectListItemContainer() to get proper list semantics and dividers.</p>
ObjectListItemContainer({ children, gap, ...props })Vertical container that wraps ObjectListItem() elements with <code>role="list"</code> semantics and renders a top-border divider between each item.
ObjectListItemCover({ imageUrl, noImageText, icon, ...props })Thumbnail cover image for use inside ObjectListItem()'s <code>cover</code> slot. Renders a fixed-size (80×45) container with a lazy-loaded image, or a text placeholder when no <code>imageUrl</code> is available.
ObjectListItemHeading({ heading, beforeHeadingSlot, afterHeadingSlot, headingTestId, ...props })<p>Heading component designed for use inside ObjectListItem()'s <code>header</code> slot.</p><p>Renders a responsive heading row that stacks vertically on narrow containers and switches to a horizontal layout at wider widths (controlled by a container query).</p>
ObjectListSubText({ children, ...props })
PageHeaderSection({ title, desc, children, linkText, level, linkProps, linkManagerComponent, ...htmlProps })
Pagination({ limit, offset, total, onPageChange, })
Paragraph({ className, htmlContent, children, ...pAttributes })Component for generic paragraph tags
ParameterActionButton({ children, themeType, tooltip, tooltipProps, renderAs, disabled, ...props })
ParameterDrawerHeader({ title, iconBeforeTitle, children })
ParameterImagePreview({ imageSrc })
ParameterLabel({ id, asSpan, children, testId, ...props })
ParameterLabels({ disabled, ...props })A parameter input component for selecting multiple labels with swatch colors. Supports grouped labels with nested menus.
ParameterLabelsInner(props)
ParameterMultiSelect({ disabled, ...props })
ParameterMultiSelectInner(props)
ParameterNameAndPublicIdInput({ id, onBlur, autoFocus, onNameChange, onPublicIdChange, nameIdError, publicIdError, readOnly, hasInitialPublicIdField, label, warnOverLength, nameIdField, nameCaption, namePlaceholderText, publicIdFieldName, publicIdCaption, publicIdPlaceholderText, values, })
ParameterOverrideMarker(props)
ParameterRichText({ label, labelLeadingIcon, hiddenLabel, id, errorMessage, caption, errorTestId, captionTestId, menuItems, children, ...innerProps })
ParameterRichTextInner({ value, editorFooter, children, customNodes, editorWrapperClassName, ...richTextProps })
ParameterShell({ label, labelLeadingIcon, labelTrailingIcon, hiddenLabel, id, errorMessage, warningMessage, infoMessage, caption, errorTestId, captionTestId, menuItems, actionItems, hasOverriddenValue, onResetOverriddenValue, title, children, isParameterGroup, menuWithoutPortal, ...props })Uniform Parameter shell component
ParameterShellPlaceholder({ children })
Popover({ iconColor, icon, iconSize, buttonText, ariaLabel, placement, testId, trigger, children, onInit, variant, maxWidth, gutter, portal, open: controlledOpen, onOpenChange: controlledOnOpenChange, className, style, tabIndex, id, disabled, })
PopoverBody({ variant, maxWidth, children, ...otherProps })A styled popover body component with design system styles. Used to create custom popover-like behavior.
popTopLayerDialog(dialog)Remove a dialog element from the stack. Safe to call even if the dialog is not currently in the stack (no-op in that case).
prefersReducedMotion(cssProp)Prefers Reduced Motion Helper Function
ProgressBar({ current, max, theme, variant, ...props })
ProgressList({ inProgressId, items, autoEllipsis, ...htmlProps })Component that sets the base structure for scrollable content in a max height container
ProgressListItem({ children, status, error, errorLevel, autoEllipsis, })
pushTopLayerDialog(dialog)Push a dialog element onto the stack. Intended to be called by <code>Modal</code> immediately after <code>showModal()</code> so the dialog can become the active toast portal target.
QuickFilter({ iconLeft, collapsedIcon, buttonText, testId, ariaLabel, children, size, disabled, selectedItems, onSearchTermChanged, addButtonText, onItemRemoved, totalResults, maxMenuHeight, maxCount, containerCss, resultsComponent, hasNoResultsMessage, searchPlaceholderText, maxContainerSize, onOpen, onClose, menuPlacement, menuGetAnchorRect, menuUpdatePosition, onSearchEnterKeyDown, })
replaceUnderscoreInString(title)
ResolveIcon({ icon, name, styleType, ...props })Uniform Resolve Icon Component
ResponsiveTableContainer({ children })
RichTextToolbarIcon({ icon })
ScrollableList({ label, children, ...props })Component that sets the base structure for scrollable content in a max height container
ScrollableListInputItem({ label, icon, active, disableShadow, children, labelTestId, ...props })
ScrollableListItem({ buttonText, icon, active, disableShadow, ...props })Component used within <ScrollableList /> for adding interactive button components with predefined styles
SearchableMenu(props)Searchable menu allows searching through its menu items
SegmentedControl({ name, options, value, onChange, disabled, orientation, size, hideOptionText, iconSize, currentBackgroundColor, noCheckmark: _noCheckmark, ...props })A control with multiple segments. Can be used as a replacement of radio buttons.
Skeleton({ width, height, inline, circle, children, ...otherProps })A loading skeleton
SliderLabels({ ticks, currentValue, containerWidth })SliderLabels component that intelligently shows/hides labels based on available space
Spinner({ width, label, isPaused, })
StackedModalHeader({ children, onBack, icon })
StackedModalStep({ children, buttonGroup })<p>Defines a single step inside a <code>StackedModal</code>.</p><p>Renders a scrollable content area and an optional bottom button group. The <code>header</code> prop is read by the parent <code>StackedModal</code> and displayed in the modal header row with a matching slide animation.</p>
StatusBullet({ status, hideText, size, message, compact, ...props })
subscribeTopLayerDialog(listener)Subscribe to changes to the topmost open dialog. The listener is invoked immediately with the current top (or <code>null</code> if no dialog is open) so subscribers don't need a separate initial read.
SuccessMessage({ message, testId, ...props })Component that provides success messaging to input fields
supports(cssProp)Media Query Helper Function
Swatch({ size, variant, tooltip, testId, })
SwatchComboBox({ labelTitle, caption, isMulti, ...props })
SwatchComboBoxLabelStyles()SwatchComboBoxLabelStyles provides custom styles for react-select's multiValue and multiValueLabel. Dynamically applies color based on each option's color property.
SwatchLabel({ variant, size, label, rightSlot, tooltip, leftSlot, })A colored label component that uses the same color variants as Swatch.
SwatchLabelRemoveButton({ onRemove, size, })
SwatchLabelTooltip({ parentTitle, title, description, })A tooltip component that displays a swatch label with a parent title and a description.
TabButton({ children, id, ...props })
TabButtonGroup({ children, ...props })
TabContent({ children, tabId, id, keepMounted, ...props })
Tabs({ children, onSelectedIdChange, useHashForState, selectedId, manual, orientation, className, style, })
TakeoverDrawerRenderer(props)A specialized drawer renderer that takes over the full stack. DrawerProvider - Must be rendered inside a <code><DrawerProvider></code>.
Theme({ disableReset, disableGlobalReset })Uniform CSS Variables, font provider and optional reset stylesheet
Tile({ children, disabled, isSelected, orientation, ...props })
TileContainer({ bgColor, containerPadding, gap, gridTemplateColumns, children, withoutGrouping, ...props })Uniform Tile Container Component
TileText({ as, children, ...props })
ToastContainer({ limit, autoCloseDelay })Renders the global toast viewport. Intended to be mounted exactly once near the root of the app (typically in <code>_app.tsx</code>).
Tooltip({ children, title, placement, visible, withoutPortal, timeout, gutter, ...popupProps })Displays contextual information when hovering or focusing an element.
TwoColumnLayout({ bgColor, invertLayout, supportingContent, children, })
UniformBadge({ theme, ...props })Uniform Badge Logo
UniformLogo({ theme, ...props })Uniform Logo
UniformLogoLarge({ ...props })
useBreakpoint()Returns the name of the current breakpoint. Built on top of https://github.com/streamich/react-use/blob/master/docs/createBreakpoint.md
useButtonStyles({ size, ...props })
useCloseCurrentDrawer()
useCurrentDrawer()
useCurrentTab()Returns the current tabs context with <code>value</code> and <code>setValue</code>. Must be used inside <code><Tabs></code>.
useDateTimePickerContext()Use this context for slots within the date time picker in order to manipulate the current value
useDrawer()
useIconContext()
useImageLoadFallback({ src, srcSet, errorFallbackSrc, logContext, })Manage <code>src</code>/<code>srcSet</code> for an image with optional fallback behavior. If the image fails to load and <code>errorFallbackSrc</code> is provided, we switch to it once and clear <code>srcSet</code>.
useModalPortalContainer()
useOutsideClick(containerRef, handler)
useParameterShell()
usePopoverComponentContext()Hook to get the current popover context. Useful for closing the popover with a nested button or interactive element.
useRichTextToolbarState({ config })
useShortcut({ disabled, handler, shortcut, macShortcut, doNotPreventDefault, activeWhenEditing, useKey, })
useStackedModal()Hook to access the stacked modal navigation context. Provides the current step, total steps, navigation direction, and functions to navigate between steps.
VerticalRhythm({ align, justify, tag, gap, children, ref, ...props })
WarningMessage({ message, testId, ...props })Component that provides warning messaging to input fields

Interfaces

InterfaceDescription
ActionButtonsProps
AvatarGroupProps
CalloutProps
ComboBoxSelectableGroup
DateTimePickerValue
DrawerItem
DrawerRendererItemProps
DrawerRendererProps
DropdownStyleMenuTriggerProps
IconButtonProps
IconProps
ImageProps
InputKeywordSearchProps
LoadingIconProps
LoadingOverlayProps
MenuProps
PopoverStore
ProgressBarProps
SelectableMenuItemProps
UseShortcutResult

Variables

VariableDescription
accessibleHidden
actionBarVisibilityStyles
AVATAR_SIZE_2XL
AVATAR_SIZE_2XSCanonical width tokens for each <code>Avatar</code> <code>size</code> (single source of truth for rem values).
AVATAR_SIZE_3XLLargest step (6rem ≈ 96px when root font size is 16px).
AVATAR_SIZE_LG
AVATAR_SIZE_MD
AVATAR_SIZE_SM
AVATAR_SIZE_XL
AVATAR_SIZE_XS
avatarImageStyles
avatarSize2xlStyles
avatarSize2xsStyles
avatarSize3xlStyles
avatarSizeLgStyles
avatarSizeMdStyles
avatarSizeSmStyles
avatarSizeXlStyles
avatarSizeXsStyles
avatarStyles
BetaDecorator
borderTopIcon
breakpointsObject of breakpoints and the pixel values
button
ButtonUniform Button Component
buttonAccentAltDark
buttonAccentAltDarkOutline
buttonDestructive
buttonDisabled
buttonGhost
buttonGhostDestructive
buttonGhostUnimportant
buttonPrimary
buttonPrimaryInvert
buttonSecondary
buttonSecondaryInvert
buttonSoftAccentPrimary
buttonSoftAlt
buttonSoftDestructive
buttonSoftPrimary
buttonSoftTertiary
buttonTertiary
buttonTertiaryOutline
buttonUnimportant
canvasAlertIcon
cardIcon
chatIcon
CheckboxWithInfo
CurrentDrawerContext
customIcons
DebouncedInputKeywordSearchWrapper for InputKeywordSearch that debounces the onSearchTextChanged callback to avoid triggering any business logic on every keystroke.
DescriptionListA component to render a key-value list (uses <dl />, <dt /> and <dd /> under the hood).
DragHandle
DrawerA drawer component that opens from the right side of its parent. When used without an external <code><DrawerProvider></code>, creates its own provider and renderer internally. For shared drawer stacks, wrap with <code><DrawerProvider></code> and use a <code><DrawerRenderer></code>.
DropdownStyleMenuTriggerRenders a dropdown menu style menu trigger button. Marked with <code>markNativeButton</code> so the design system's <code>Menu</code> knows to opt into Base UI's native-button code path even though the React element type is a function component.
fadeInfadeIn animation - fade in an element from 0 to 1 opacity
fadeInBottomfadeInBottom animation - fades in an element from the Y axis by 10px
fadeInLtr
fadeInRtl
fadeInTopfadeInTop animation - fades in an element from the Y axis by -10px
fadeOutBottomfadeOutBottom animation - fades out an element from the Y axis by 10px
Fieldset
FilterChipCompact button used to toggle a filter on/off, optionally rendered as a dropdown trigger. Spreads <code>...props</code> first then sets <code>type</code> last with a fallback to <code>"button"</code> so wrappers like Base UI's <code>Menu.Trigger</code> (which can forward <code>type: undefined</code> via <code>cloneElement</code>) cannot accidentally turn it into a submit button inside a <code><form></code>. Marked with <code>markNativeButton</code> so <code>Menu</code> knows the rendered DOM is a real <code><button></code> and can pass <code>nativeButton={true}</code> to Base UI.
fullWidthScreenIcon
growSubtlegrowSubtle animation - increases the size of an element from scale(1) - scale(1.15) and back down to scale(1) using transform: scale(1)
IconComponent that renders icons IconsProvider - Wrap a parent component with <code><IconsProvider></code> for string-based icon names.
IconButton
imageTextIcon
infoFilledIcon
InputInput Component
inputError
InputKeywordSearchComponent used for keyword search functionality
inputSelect
InputSelectInput Select Component
InputTimeTime input with segmented control
InputToggleComponent that creates a checkbox or radio input field
jsonIcon
labelText
LinkUniform Link Component
LinkButton
LinkTile
LinkWithRefUniform LinkWithRef Component We recommend using this link <code>next/link</code>
MenuComponent used for creating clickable menus
MenuButton<p>Bare <code><button type="button"></code> styled wrapper used as a Menu trigger.</p><p>The <code>type</code> attribute is set after <code>...props</code> with a fallback so wrappers such as Base UI's <code>Menu.Trigger</code> (which can forward <code>type: undefined</code> via <code>cloneElement</code>) cannot accidentally turn this into a submit button when placed inside a <code><form></code>. Marked with <code>markNativeButton</code> so the design system's <code>Menu</code> component knows to opt into Base UI's native-button code path.</p>
MenuItemMenuItem Component used along side <Menu /> component
MenuItemInnerMenuItem Component for headless use outside <Menu /> component Use only if adapting Uniform menu item appearance to a non-Base UI menu. This is required because Base UI does not let you use MenuItem outside of a Menu component.
MenuSelectSelect-style Menu trigger that renders the current value with a chevron. Marked as a native-button trigger for the same reason as <code>MenuThreeDots</code>.
MenuThreeDotsThree-dot ("more options") Menu trigger. Marked as a native-button trigger so <code>Menu</code> reports <code>nativeButton={true}</code> to Base UI even though it is a function component (Base UI inspects the React element's outer <code>type</code>).
ModalA modal component to open a dialog with a backdrop that covers the whole page.
ModalDialog
ModalPortalContextContext for passing a portal container element to child popover/menu components rendered inside a Modal. This ensures floating elements render into the dialog instead of document.body, preventing clipping by the modal's overflow.
numberInput
ObjectGridContainerCSS Grid container for laying out ObjectGridItem() elements in a responsive grid. Supports forwarding a ref to the underlying <code><div></code>.
ParameterGroup
ParameterImage
ParameterImageInnerParameterShell - Must be rendered inside a <code><ParameterShell></code> component.
ParameterInput
ParameterInputInnerParameterShell - Must be rendered inside a <code><ParameterShell></code> component.
ParameterLink
ParameterLinkInnerParameterShell - Must be rendered inside a <code><ParameterShell></code> component.
ParameterMenuButton
ParameterNumberSliderParameter wrapper for numeric sliders
ParameterNumberSliderInnerParameterShell - Must be rendered inside a <code><ParameterShell></code> component.
ParameterSelect
ParameterSelectInnerParameterShell - Must be rendered inside a <code><ParameterShell></code> component.
ParameterSelectSliderParameter wrapper for option-based sliders
ParameterSelectSliderInnerParameterShell - Must be rendered inside a <code><ParameterShell></code> component.
ParameterShellContext
ParameterTextarea
ParameterTextareaInnerParameterShell - Must be rendered inside a <code><ParameterShell></code> component.
ParameterToggle
ParameterToggleInnerParameterShell - Must be rendered inside a <code><ParameterShell></code> component.
queryStringIcon
rectangleRoundedIcon
richTextToolbarButton
richTextToolbarButtonActive
ripple
scrollbarStylesCustom scrollbar styles
SelectableMenuItem<p>A MenuItem that displays a selected state via a leading check icon.</p><p>The component forwards refs to the underlying menu item DOM node so that Base UI's <code>SubmenuTrigger</code> (which clones its <code>render</code> element and attaches a ref for positioning/focus management) works correctly when a SelectableMenuItem is used as a submenu trigger.</p>
settings
settingsIcon
skeletonLoading
slideInRtl
slideInTtb
SliderSlider component that supports both numeric values and predefined options
spin
StackedModal<p>A modal component that supports multi-step content with sliding transitions. Each child should be a <code>StackedModalStep</code> component that defines its own header, content, and button group.</p><p>Use the <code>useStackedModal</code> hook inside step content to navigate between steps.</p>
structurePanelIcon
swatchColorsSwatch color CSS custom properties Exports CSS variables for all swatch variants that can be used in other components. Each variant has --swatch--border variables.
swatchVariantSwatch variant styles as plain objects. Works with both Emotion's css prop and react-select's styles API.
SwitchUniform Switch Input Component
TableUniform's Table component
TableBody
TableCellData
TableCellHead
TableFoot
TableHead
TableRow
TAKEOVER_STACK_ID
TextareaTextarea Component
textInput
toastImperative API for showing toasts from anywhere in the app. Mirrors the historical react-toastify surface (<code>toast</code>, <code>.success</code>, <code>.error</code>, <code>.info</code>, <code>.warning</code>, <code>.loading</code>, <code>.dismiss</code>, <code>.update</code>, <code>.done</code>, <code>.promise</code>) so the ~200 existing call sites continue to work unchanged. Internally delegates to the singleton Base UI <code>toastManager</code> mounted by <code><ToastContainer /></code>.
uniformAiIcon
uniformComponentIcon
uniformComponentPatternIcon
uniformCompositionPatternIcon
uniformConditionalValuesIcon
uniformContentTypeIcon
uniformEntryIcon
uniformEntryPatternIcon
uniformLocaleDisabledIcon
uniformLocaleIcon
uniformStatusDraftIcon
uniformStatusModifiedIcon
uniformStatusPublishedIcon
uniformUsageStatusIcon
utilityColorsUniform utility colors exports the following css variables: --utility-caution-icon: #facc15; --utility-caution-title: #854d0e; --utility-caution-container: #fefce8; --utility-danger-icon: #f87171; --utility-danger-title: #991b1b; --utility-danger-container: #fef2f2; --utility-info-icon: #60a5fa; --utility-info-title: #1e40af; --utility-info-container: #eff6ff; --utility-note-icon: var(--gray-400); --utility-note-title: var(--gray-800); --utility-note-container: var(--gray-50); --utility-success-icon: #4ade80; --utility-success-title: #166534; --utility-success-container: #f0fdfa;
warningIcon
yesNoIcon
zigZag
zigZagThick

Type Aliases

Type AliasDescription
AddButtonProps
AddListButtonProps
AddListButtonThemeProps
AsideAndSectionLayout
AvatarProps
BannerProps
BannerType
BoxHeightProps
BreakpointSizeBreakpoint label values
BreakpointsMap
ButtonProps
ButtonSizePropsButton sizes that are available to use with our brand
ButtonSoftThemeProps
ButtonThemePropsButton themes that are available to use with our brand
ButtonWithMenuPropsButtonWithMenuProps combines the ActionButtonsProps with React HTMLButtonElement attributes
CalendarCellCss
CalendarProps
CalendarStylesOptional style overrides for calendar sub-elements.
CalloutTypeCallout button types available to use with our brand
CaptionProps
CardContainerBgColorProps
CardContainerProps
CardProps
CardTitleProps
CheckboxWithInforProps
ChildFunction
ChipProps
ChipTheme
ComboBoxGroupBase
ComboBoxSelectableItem
ComboBoxSelectableOption
ContainerProps
ConvertComboBoxGroupsToSelectableGroupsOptions
CounterBgColors
CounterIconColors
CounterProps
CreateTeamIntegrationTileProps
DashedBoxProps
DateTimePickerProps
DebouncedInputKeywordSearchProps
DescriptionListProps
DetailsProps
DraggableHandleProps
DrawerContentProps
DrawerContextValue
DrawerProps
DrawersRegistryRecord
EditTeamIntegrationTileProps
ErrorMessageProps
FieldMessageProps
FieldsetProps
GroupedOption
HeadingProps
IconColorsets fill color of the svg icon 'default'
IconNameA list of available icon names that can be used with the Uniform brand
IconTypesets the type of icon to use from the available list
InfoMessageProps
InputComboBoxOptionDefault type of option for the combo box. Note: you can use any type of object you want. If it has a <code>label</code> and <code>value</code> property, it will auto wire those. If you want to use different properties, you can use the <code>getOptionLabel</code> and <code>getOptionValue</code> props.
InputComboBoxProps
InputCreatableComboBoxProps
InputInlineSelectOption
InputInlineSelectProps
InputProps
InputSelectProps
InputTimeProps
InputToggleProps
IntegrationComingSoonProps
IntegrationLoadingTileProps
IntegrationModalHeaderProps
IntegrationModalIconProps
IntegrationTileProps
IsoDateStringA string in the ISO 8601 date format: YYYY-MM-DD
IsoDateTimeStringA string in the ISO 8601 datetime format
IsoTimeStringA string in the ISO 8601 time format: hh:mm
JsonEditorProps
KeyValueInputProps
KeyValueItem
LabelLeadingIconProps
LabelOptionExtended option type that supports label-specific properties
LabelProps
LabelsQuickFilterItemRepresents a label item that can be displayed in the quick filter
LabelsQuickFilterProps
LegendProps
LevelPropsAvailable heading weights e.g. 1 - 6
LimitsBarProps
LinkButtonProps
LinkColorProps
LinkListProps
LinkManagerWithRefType
LinkProps
LinkTileWithRefProps
MenuButtonProp
MenuGroupProps
MenuItemProps
MenuItemTextThemePropsbase - default red - red text accent-alt - AI color (accent-alt-dark). DOES NOT change the text - only the icon color!
MenuThreeDotsProps
ModalDialogProps
ModalProps
MultilineChipProps
ObjectGridContainerPropsProps for ObjectGridContainer.
ObjectGridItemCardCoverPropsProps for ObjectGridItemCardCover(). Pass **either** an <code>icon</code> or an <code>imageUrl</code> — the component renders the appropriate variant.
ObjectGridItemCoverButtonPropsProps for ObjectGridItemCoverButton(). The <code>coverSlotBottomRight</code> is reserved for the selection chip and cannot be overridden.
ObjectGridItemCoverPropsProps for ObjectGridItemCover(). Extends ObjectGridItemCardCoverProps with overlay slots at each corner.
ObjectGridItemIconWithTooltipPropsProps for ObjectGridItemIconWithTooltip().
ObjectGridItemPropsProps for ObjectGridItem().
ObjectGridItemTitlePropsProps for ObjectGridItemHeading().
ObjectItemLoadingSkeletonPropsProps for ObjectItemLoadingSkeleton().
ObjectListItemCoverPropsProps for ObjectListItemCover().
ObjectListItemHeadingPropsProps for ObjectListItemHeading().
ObjectListItemProps<p>Props for ObjectListItem().</p><p>Supports two layout modes via <code>renderAs</code>: - <code>"single"</code> (default) — header and right slot vertically centered on one line. - <code>"multi"</code> — header aligned to top with additional <code>children</code> rendered below it.</p>
PageHeaderSectionProps
ParagraphProps
ParameterActionButtonProps
ParameterDrawerHeaderProps
ParameterGroupProps
ParameterImageProps
ParameterInputProps
ParameterLabelProps
ParameterLinkProps
ParameterMenuButtonProps
ParameterMultiSelectOption
ParameterMultiSelectProps
ParameterNameAndPublicIdInputProps
ParameterNumberSliderProps
ParameterRichTextInnerProps
ParameterRichTextProps
ParameterSelectProps
ParameterSelectSliderProps
ParameterShellProps
ParameterTextareaProps
ParameterToggleProps
PopoverBodyProps
PopoverProps
ProgressListItem
ProgressListItemProps
ProgressListProps
QuickFilterSelectedItem
RegisterDrawerProps
ResolveIconProps
RhythmProps
RichTextParamValue
ScrollableItemProps
ScrollableListContainerProps
ScrollableListItemProps
ScrollableListProps
SearchableMenuProps
SegmentedControlOption
SegmentedControlProps
SerializedLinkNode
ShortcutReference
SkeletonProps
SliderLabelsProps
SliderOption
SliderProps
StackedModalProps
StackedModalStepPropsProps for a single step within a <code>StackedModal</code>.
StatusBulletProps
StatusTypeProps
StepTransitionStateThe semantic transition state for a single step, derived from the navigation context.
SuccessMessageProps
SwatchLabelProps
SwatchProps
SwatchSize
SwatchVariant
SwitchProps
TabButtonGroupProps
TabButtonProps
TabContentProps
TableBodyProps
TableCellDataProps
TableCellHeadProps
TableFootProps
TableHeadProps
TableProps
TableRowProps
TabsProps
TextAlignProps
TextareaProps
ThemeProps@todo: line 144 onwards will be brought into a title, paragraph, list and link components
TickMark
TileContainerProps
TileProps
TileTitleProps
ToastContainerProps
ToastDataThe shape consumers can store on a toast via the <code>data</code> field. Recognised by the default <code><ToastList></code> renderer to render either a progress bar or an inline Undo affordance, while keeping the imperative <code>toast.*</code> API unchanged for the rest of the codebase.
ToastIdIdentifier returned by <code>toast.*</code> calls. Kept as <code>string | number</code> for backwards compatibility with the previous react-toastify <code>Id</code> type that several consumers store in <code>useRef<number | string></code>. Internally the underlying Base UI manager always uses <code>string</code>.
ToastOptionsPer-call options accepted by every <code>toast.*</code> method. The shape mirrors the legacy react-toastify options the design system used to forward.
ToastPromiseOptionsPromise-toast options accepted by <code>toast.promise</code>. Each handler may be a static description string or a function that receives the resolved value / rejection error and returns a description. All three keys are optional to mirror react-toastify's behaviour where any unset state simply rendered an empty toast (or none at all when the promise settled fast enough).
ToastUpdatePatch shape accepted by <code>toast.update</code>. A subset of Base UI's <code>ToastManagerUpdateOptions<ToastData></code> that consumers actually use.
TooltipProps
TwoColumnLayoutProps
UniformLogoProps
UseShortcutOptions
WarningMessageProps