Reference

Every name each entry point exports, read from its source. Anything not listed is internal and may change in any release. The component pages explain each name; the tables link to them.

Entry point	Import it in
`@adecore/ui`	The page.
`@adecore/ui/settings`	The page, for a settings window.
`@adecore/ui/format`	The page, and any code that writes a number or date a person reads.
`@adecore/ui/testing`	Tests only.
`@adecore/ui/testing/dedupe`	The `preload` of `bun test`, in an app that links a checkout. It exports nothing; see Testing.
`@adecore/ui/theme.css`	The app's CSS, after Tailwind. See Theme.

Exports

`@adecore/ui`

The components, hooks and helpers.

Name	Kind	Source
`ComboboxInputProps`	type	`combobox/parts`
`ComboboxItemProps`	type	`combobox/parts`
`ComboboxPopupProps`	type	`combobox/parts`
`CommandPaletteFooterProps`	type	`command-palette/parts`
`CommandPaletteInputProps`	type	`command-palette/parts`
`CommandPalettePopupProps`	type	`command-palette/parts`
`CommandPaletteRootProps`	type	`command-palette/parts`
`DialogDescriptionProps`	type	`dialog/parts`
`DialogFooterProps`	type	`dialog/parts`
`DialogPopupProps`	type	`dialog/parts`
`DialogTextProps`	type	`dialog/parts`
`DialogTitleProps`	type	`dialog/parts`
`MenuCheckProps`	type	`menu/parts`
`MenuHintProps`	type	`menu/parts`
`MenuLabelProps`	type	`menu/parts`
`MenuPopupProps`	type	`menu/parts`
`MenuRowActionProps`	type	`menu/parts`
`MenuRowProps`	type	`menu/parts`
`MenuRowSubmenuTriggerProps`	type	`menu/parts`
`KeyValueListItemProps`	type	`key-value-list/parts`
`KeyValueListNameProps`	type	`key-value-list/parts`
`KeyValueListRootProps`	type	`key-value-list/parts`
`KeyValueListValueProps`	type	`key-value-list/parts`
`PopoverPopupProps`	type	`popover/parts`
`PopupVariant`	type	`popover/parts`
`PreviewCardPopupProps`	type	`popover/parts`
`TabsCountProps`	type	`tabs/parts`
`TabsListProps`	type	`tabs/parts`
`TabsRootProps`	type	`tabs/parts`
`TabsTabProps`	type	`tabs/parts`
`TabsValue`	type	`tabs/parts`
`TabsVariant`	type	`tabs/parts`
`tabDropIndex`	function	`tabs/use-tab-drag`
`useTabDrag`	hook	`tabs/use-tab-drag`
`TabDrag`	type	`tabs/use-tab-drag`
`TabDragOptions`	type	`tabs/use-tab-drag`
`AccentSwatches`	component	`AccentSwatches`
`AccentSwatchesProps`	type	`AccentSwatches`
`Banner`	component	`Banner`
`BannerProps`	type	`Banner`
`BannerTone`	type	`Banner`
`Button`	component	`Button`
`ButtonProps`	type	`Button`
`ButtonShape`	type	`Button`
`ButtonSize`	type	`Button`
`ButtonVariant`	type	`Button`
`ButtonGroup`	component	`ButtonGroup`
`ButtonGroupProps`	type	`ButtonGroup`
`Checkbox`	component	`Checkbox`
`CheckboxProps`	type	`Checkbox`
`ChoiceCards`	component	`ChoiceCards`
`Choice`	type	`ChoiceCards`
`ChoiceCardsProps`	type	`ChoiceCards`
`CloseButton`	component	`CloseButton`
`CloseButtonProps`	type	`CloseButton`
`ColorSwatch`	component	`ColorSwatch`
`ColorSwatchProps`	type	`ColorSwatch`
`CopyButton`	component	`CopyButton`
`CopyButtonProps`	type	`CopyButton`
`ColorWheelPicker`	component	`ColorWheelPicker`
`ColorWheelPickerProps`	type	`ColorWheelPicker`
`ColumnResizeHandle`	component	`ColumnResizeHandle`
`ColumnResizeHandleProps`	type	`ColumnResizeHandle`
`DisabledReason`	component	`DisabledReason`
`DisabledReasonProps`	type	`DisabledReason`
`DockShell`	component	`DockShell`
`DockShellProps`	type	`DockShell`
`EmptyState`	component	`EmptyState`
`EmptyStateProps`	type	`EmptyState`
`ErrorBoundary`	class	`ErrorBoundary`
`ErrorBoundaryProps`	type	`ErrorBoundary`
`Field`	component	`Field`
`FieldHint`	component	`Field`
`FormError`	component	`Field`
`FieldHintProps`	type	`Field`
`FieldProps`	type	`Field`
`FormErrorProps`	type	`Field`
`FileIcon`	component	`FileIcon`
`FileIconProps`	type	`FileIcon`
`Icon`	component	`Icon`
`IconProps`	type	`Icon`
`IconButton`	component	`IconButton`
`IconButtonProps`	type	`IconButton`
`IconButtonSize`	type	`IconButton`
`IconPicker`	component	`IconPicker`
`IconPickerGroup`	type	`IconPicker`
`IconPickerProps`	type	`IconPicker`
`Input`	component	`Input`
`TextArea`	component	`Input`
`InputProps`	type	`Input`
`TextAreaProps`	type	`Input`
`Kbd`	component	`Kbd`
`KeyCap`	component	`Kbd`
`Keys`	component	`Kbd`
`KbdProps`	type	`Kbd`
`KeyCapProps`	type	`Kbd`
`KeysProps`	type	`Kbd`
`ListRow`	component	`ListRow`
`ListRowProps`	type	`ListRow`
`Meter`	component	`Meter`
`MeterProps`	type	`Meter`
`MiddleTruncate`	component	`MiddleTruncate`
`MiddleTruncateProps`	type	`MiddleTruncate`
`PanelEmpty`	component	`PanelEmpty`
`PanelEmptyProps`	type	`PanelEmpty`
`PanelHeader`	component	`PanelHeader`
`PanelHeaderProps`	type	`PanelHeader`
`Pill`	component	`Pill`
`PillProps`	type	`Pill`
`PromptDialog`	component	`PromptDialog`
`PromptDialogProps`	type	`PromptDialog`
`RelativeTime`	component	`RelativeTime`
`RelativeTimeProps`	type	`RelativeTime`
`ProjectSwitcher`	component	`ProjectSwitcher`
`ProjectSwitcherGroups`	component	`ProjectSwitcher`
`ProjectSwitcherItem`	type	`ProjectSwitcher`
`ProjectSwitcherProps`	type	`ProjectSwitcher`
`ScrollArea`	component	`ScrollArea`
`ScrollAreaProps`	type	`ScrollArea`
`SectionLabel`	component	`SectionLabel`
`SectionLabelProps`	type	`SectionLabel`
`SegmentBar`	component	`SegmentBar`
`SegmentBarPart`	type	`SegmentBar`
`SegmentBarProps`	type	`SegmentBar`
`Segmented`	component	`Segmented`
`SegmentedOption`	type	`Segmented`
`SegmentedProps`	type	`Segmented`
`Select`	component	`Select`
`SelectGroup`	type	`Select`
`SelectItem`	type	`Select`
`SelectProps`	type	`Select`
`Separator`	component	`Separator`
`SeparatorProps`	type	`Separator`
`ShortcutHints`	component	`ShortcutHints`
`Skeleton`	component	`Skeleton`
`SkeletonProps`	type	`Skeleton`
`Slider`	component	`Slider`
`SliderProps`	type	`Slider`
`SlidingColumn`	component	`SlidingColumn`
`SlidingColumnProps`	type	`SlidingColumn`
`Spinner`	component	`Spinner`
`SpinnerProps`	type	`Spinner`
`SplitButton`	component	`SplitButton`
`SplitButtonProps`	type	`SplitButton`
`Stepper`	component	`Stepper`
`StepperProps`	type	`Stepper`
`Surface`	component	`Surface`
`SurfaceProps`	type	`Surface`
`Switch`	component	`Switch`
`SwitchProps`	type	`Switch`
`TextMenu`	component	`TextMenu`
`TextMenuProps`	type	`TextMenu`
`Tile`	component	`Tile`
`TileProps`	type	`Tile`
`Toasts`	component	`Toasts`
`ToastsProps`	type	`Toasts`
`Tooltip`	component	`Tooltip`
`TooltipProps`	type	`Tooltip`
`TooltipSide`	type	`Tooltip`
`UIProvider`	component	`UIProvider`
`UIProviderProps`	type	`UIProvider`
`Waveform`	component	`Waveform`
`WaveformProps`	type	`Waveform`
`Wipe`	component	`Wipe`
`WipeProps`	type	`Wipe`
`ZoomControls`	component	`ZoomControls`
`ZoomControlsProps`	type	`ZoomControls`
`ZoomLabels`	type	`ZoomControls`
`ZoomSelection`	type	`ZoomControls`
`copyText`	function	`clipboard`
`readClipboardText`	function	`clipboard`
`messageOf`	function	`error-message`
`ResetKeys`	type	`error-boundary`
`FILE_TREE_ICONS`	const	`file-icon`
`setFileIconOverride`	function	`file-icon`
`cameThroughPortal`	function	`floating`
`isInFloatingLayer`	function	`floating`
`LoadedComponent`	class	`lazy`
`lazyDialog`	function	`lazy`
`lazyNamed`	function	`lazy`
`onLazyOpenError`	function	`lazy`
`LazyComponent`	type	`lazy`
`LazyBoundary`	component	`LazyBoundary`
`LazyBoundaryProps`	type	`LazyBoundary`
`UI_NAMESPACE`	const	`locales`
`UI_RESOURCES`	const	`locales`
`matchScore`	function	`match`
`isApplePlatform`	function	`platform`
`prefetcher`	const	`prefetch`
`Loader`	type	`prefetch`
`WhenIdle`	type	`prefetch`
`tintStyle`	function	`tint`
`selectAllWithin`	function	`selection`
`selectionWithin`	function	`selection`
`EDIT_SHORTCUTS`	const	`shortcut`
`KEY_SHORTCUTS`	const	`shortcut`
`formatShortcut`	function	`shortcut`
`isModHeld`	function	`shortcut`
`matchesShortcut`	function	`shortcut`
`shortcut`	function	`shortcut`
`shortcutParts`	function	`shortcut`
`KeyLike`	type	`shortcut`
`Shortcut`	type	`shortcut`
`UNDO_MS`	const	`toast-store`
`createToastStore`	const	`toast-store`
`Toast`	type	`toast-store`
`ToastAction`	type	`toast-store`
`ToastDeadline`	type	`toast-store`
`ToastInput`	type	`toast-store`
`ToastKind`	type	`toast-store`
`ToastPatch`	type	`toast-store`
`ToastStore`	type	`toast-store`
`ToastStoreHook`	type	`toast-store`
`useAsyncAction`	hook	`useAsyncAction`
`AsyncAction`	type	`useAsyncAction`
`clampColumnSize`	function	`useColumnResize`
`useColumnResize`	hook	`useColumnResize`
`ColumnEdge`	type	`useColumnResize`
`ColumnResize`	type	`useColumnResize`
`ColumnResizeOptions`	type	`useColumnResize`
`useContentSize`	hook	`useContentSize`
`ContentSize`	type	`useContentSize`
`useMeasuredWidth`	hook	`useMeasuredWidth`
`useNow`	hook	`useNow`
`useTickingText`	hook	`useNow`
`useOverlayScrollbars`	hook	`useOverlayScrollbars`
`OverlayScrollbarsOptions`	type	`useOverlayScrollbars`
`ScrollAreaAxis`	type	`useOverlayScrollbars`
`useFileTree`	hook	`file-tree/use-file-tree`
`FileTreeOptions`	type	`file-tree/use-file-tree`
`FileTreeRootProps`	type	`file-tree/parts`
`FileTreeModel`	type	`index`
`FileTreeVisibleRow`	type	`index`
`FileTreeDragAndDropConfig`	type	`index`
`FileTreeDropContext`	type	`index`
`FileTreeDropResult`	type	`index`
`FoldKeyOf`	type	`file-tree/helpers`
`SortRow`	type	`file-tree/helpers`
`TreeRootProps`	type	`tree/parts`
`TreeRowProps`	type	`tree/parts`
`TreeChevronProps`	type	`tree/parts`
`TreeChevronSlotProps`	type	`tree/parts`
`TreeLabelProps`	type	`tree/parts`
`TreeDecorationProps`	type	`tree/parts`
`TreeControlProps`	type	`tree/parts`
`TreeCheckboxProps`	type	`tree/parts`
`Workspace`	component	`workspace/Workspace`
`WorkspaceProps`	type	`workspace/Workspace`
`WorkspaceRail`	component	`workspace/WorkspaceRail`
`WorkspaceRailSeparator`	component	`workspace/WorkspaceRail`
`WorkspaceRailSpacer`	component	`workspace/WorkspaceRail`
`WorkspaceRailProps`	type	`workspace/WorkspaceRail`
`WorkspaceTopRow`	component	`workspace/WorkspaceTopRow`
`WorkspaceTopRowProps`	type	`workspace/WorkspaceTopRow`
`useTopRowSlot`	hook	`workspace/top-row-slot`
`PaneBar`	component	`workspace/PaneBar`
`PaneBarProps`	type	`workspace/PaneBar`
`WorkspaceLayout`	type	`workspace/context`
`DocumentTab`	component	`workspace/TabStrip`
`TabStrip`	component	`workspace/TabStrip`
`DocumentTabProps`	type	`workspace/TabStrip`
`TabStripProps`	type	`workspace/TabStrip`
`TabStripItem`	type	`workspace/TabStrip`
`SplitView`	component	`workspace/SplitView`
`SplitViewProps`	type	`workspace/SplitView`
`SplitViewInfo`	type	`workspace/SplitView`
`SplitViewBounds`	type	`workspace/SplitView`
`SplitDropTarget`	type	`workspace/SplitView`
`SplitDrag`	type	`workspace/SplitView`
`DropPreview`	component	`workspace/DropPreview`
`DropPreviewProps`	type	`workspace/DropPreview`
`rectDropPreview`	function	`workspace/preview`
`sameDropPreview`	function	`workspace/preview`
`tabDropPreview`	function	`workspace/preview`
`DropPreviewShape`	type	`workspace/preview`
`TabDrop`	type	`workspace/preview`
`createSplitLayout`	function	`workspace/model`
`updateSplitLayout`	function	`workspace/model`
`splitPanes`	function	`workspace/model`
`SplitAxis`	type	`workspace/model`
`SplitSide`	type	`workspace/model`
`SplitPane`	type	`workspace/model`
`SplitBranch`	type	`workspace/model`
`SplitNode`	type	`workspace/model`
`SplitLayout`	type	`workspace/model`
`SplitCommand`	type	`workspace/model`
`tabGapAt`	function	`workspace/geometry`
`SplitRect`	type	`workspace/geometry`
`SplitEdges`	type	`workspace/geometry`
`SplitMinimum`	type	`workspace/geometry`
`CommandPaletteVirtualListProps`	type	`command-palette/virtual`
`CommandPaletteVirtualItemProps`	type	`command-palette/virtual`
`Combobox`	namespace	`combobox/index.parts`
`CommandPalette`	namespace	`command-palette/index.parts`
`ContextMenu`	namespace	`context-menu/index.parts`
`FileTree`	namespace	`file-tree/index.parts`
`Tree`	namespace	`tree/index.parts`
`Dialog`	namespace	`dialog/index.parts`
`KeyValueList`	namespace	`key-value-list/index.parts`
`Menu`	namespace	`menu/index.parts`
`Popover`	namespace	`popover/index.parts`
`PreviewCard`	namespace	`preview-card/index.parts`
`Tabs`	namespace	`tabs/index.parts`

`@adecore/ui/settings`

The settings dialog and the parts a pane is built from.

Name	Kind	Source
`ConfirmDialog`	component	`settings/ConfirmDialog`
`ConfirmDialogProps`	type	`settings/ConfirmDialog`
`DetailHeader`	component	`settings/DetailHeader`
`DetailHeaderProps`	type	`settings/DetailHeader`
`MasterDetail`	component	`settings/MasterDetail`
`MasterItem`	component	`settings/MasterDetail`
`MasterDetailProps`	type	`settings/MasterDetail`
`MasterItemProps`	type	`settings/MasterDetail`
`SettingsDialog`	component	`settings/SettingsDialog`
`SettingsDialogProps`	type	`settings/SettingsDialog`
`SettingsGroupEntry`	type	`settings/SettingsDialog`
`SettingsSearch`	type	`settings/SettingsDialog`
`SettingsSearchResult`	type	`settings/SettingsDialog`
`SettingsSectionEntry`	type	`settings/SettingsDialog`
`SettingsRow`	component	`settings/SettingsRow`
`TopIcon`	component	`settings/SettingsRow`
`SettingsRowProps`	type	`settings/SettingsRow`
`TopIconProps`	type	`settings/SettingsRow`
`SettingsSection`	component	`settings/SettingsSection`
`SettingsSectionProps`	type	`settings/SettingsSection`
`useSettingsTarget`	hook	`settings/target`

`@adecore/ui/format`

The formatters for numbers, dates and durations, and the format source they read.

Name	Kind	Source
`formatAge`	function	`format/datetime`
`formatClock`	function	`format/datetime`
`formatDateTime`	function	`format/datetime`
`formatDay`	function	`format/datetime`
`formatDayClock`	function	`format/datetime`
`formatDayClockWithYear`	function	`format/datetime`
`formatDayWithYear`	function	`format/datetime`
`formatHour`	function	`format/datetime`
`formatMoment`	function	`format/datetime`
`formatNumericDate`	function	`format/datetime`
`formatWeekday`	function	`format/datetime`
`formatWeekdayClock`	function	`format/datetime`
`formatWeekdayDay`	function	`format/datetime`
`isSameDay`	function	`format/datetime`
`formatAgo`	function	`format/duration`
`formatClockDuration`	function	`format/duration`
`formatCountdown`	function	`format/duration`
`formatDuration`	function	`format/duration`
`formatElapsedShort`	function	`format/duration`
`formatPreciseDuration`	function	`format/duration`
`formatLocale`	function	`format/locale`
`labelCollator`	function	`format/locale`
`nameCollator`	function	`format/locale`
`setFormatSource`	function	`format/locale`
`systemLocale`	function	`format/locale`
`useFormatLocale`	hook	`format/locale`
`FormatSource`	type	`format/locale`
`formatBytes`	function	`format/number`
`formatDecimal`	function	`format/number`
`formatMoney`	function	`format/number`
`formatNumber`	function	`format/number`
`formatNumeral`	function	`format/number`
`formatPercent`	function	`format/number`
`formatRounded`	function	`format/number`
`formatTokens`	function	`format/number`
`formatUsdSignificant`	function	`format/number`
`FORMAT_LANGUAGE`	const	`format/regions`
`FORMAT_REGIONS`	const	`format/regions`
`FORMAT_REGION_CHOICES`	const	`format/regions`
`FORMAT_SYSTEM`	const	`format/regions`
`formatRegionFrom`	function	`format/regions`
`regionName`	function	`format/regions`
`localTimeZone`	function	`format/time-zone`

`@adecore/ui/testing`

Fakes for an app's own tests.

Name	Kind	Source
`fakeFormatSource`	function	`testing/fake-source`
`FakeFormatSource`	type	`testing/fake-source`

Reference ​

Exports ​

@adecore/ui ​

@adecore/ui/settings ​