@backstage/ui

Home > @backstage/ui

Components used by Backstage plugins and apps

Functions

Function	Description
CellProfile(props)
Column(props)
Header(props)	A component that renders a toolbar.
HeaderPage(props)	A component that renders a header page.
Icon(props)
IconProvider(props)
marginPropDefs(spacingValues)
paddingPropDefs(spacingValues)
Row({ id, columns, children, href, ...otherProps })
Skeleton(props)
Tab(props)	A component that renders a tab.
Table(props)
TableBody(props)
TableHeader({ columns, children, })
TablePagination(props)	Pagination controls for Table components with page navigation and size selection.
TabList(props)	A component that renders a list of tabs.
TabPanel(props)	A component that renders the content of a tab.
Tabs(props)	A component that renders a list of tabs.
TooltipTrigger(props)
useBreakpoint()
useIcons()
useTable(config)	Hook for managing table state including pagination and future features like sorting. Supports both controlled and uncontrolled modes using offset/pageSize pattern (Backstage style).

Interfaces

Interface	Description
AvatarProps
BoxProps
ButtonIconProps	Properties for ButtonIcon
ButtonLinkProps	Properties for ButtonLink
ButtonProps	Properties for Button
CardBodyProps	Props for the CardBody component.
CardFooterProps	Props for the CardFooter component.
CardHeaderProps	Props for the CardHeader component.
CardProps	Props for the Card component.
CellProfileProps
CellProps
CheckboxProps
ComponentDefinition	Base type for the component styles structure
ContainerProps
FieldLabelProps
FlexProps
GridItemProps
GridProps
HeaderMenuItem	Represents an option item in the header dropdown menu.
HeaderPageBreadcrumb	Represents a breadcrumb item in the header.
HeaderPageProps	Props for the main HeaderPage component.
HeaderProps	Props for the main Header component.
HeaderTab	Represents a tab item in the header navigation.
IconContextProps
IconProviderProps
LinkProps
MenuComboboxProps
RadioGroupProps
RadioProps
SearchFieldProps
SelectProps
SkeletonProps
SpaceProps
SwitchProps
TablePaginationProps
TabListProps	Props for the TabList component.
TabPanelProps	Props for the TabPanel component.
TabProps	Props for the Tab component.
TabsProps	Props for the Tabs component.
TextFieldProps
TooltipProps
UseTableConfig
UseTablePagination
UseTablePaginationConfig
UseTableResult
UtilityProps

Variables

Variable	Description
Avatar
Box
boxPropDefs
breakpoints
Button
ButtonIcon
ButtonLink
Card	Card component.
Cell
Checkbox
Collapsible	Collapsible is a component that allows you to collapse and expand content. It is a wrapper around the CollapsiblePrimitive component from base-ui-components.
componentDefinitions	Component definitions for the Backstage UI library
Container
displayPropDefs
FieldLabel
Flex
flexPropDefs
gapPropDefs
Grid
gridItemPropDefs
gridPropDefs
heightPropDefs
IconContext
icons
Link
Menu
positionPropDefs
Radio
RadioGroup
ScrollArea
SearchField
Select
Switch
Text_2
TextField
Tooltip
widthPropDefs

Type Aliases

Type Alias	Description
AlignItems
ArbitraryStylingPropDef
BooleanPropDef
Border
BorderRadius
BoxOwnProps
Breakpoint
ClassNamesMap	Base type for the component styles structure
Columns
ComponentClassNames	Helper type to extract class names for a component
ComponentDefinitionName	Type utilities for extracting information from the component styles
DataAttributesMap	Base type for the component styles structure
DataAttributeValues	Base type for the component styles structure
Display
DisplayProps
EnumOrStringPropDef
EnumPropDef
FlexDirection
FlexOwnProps
FlexWrap
GapProps
GetPropDefType
GetPropDefTypes
GridItemOwnProps
GridOwnProps
HeightProps
IconMap
IconNames
IconProps
JustifyContent
MarginProps
MenuComboboxOption
MenuComponent
NonStylingPropDef
PaddingProps
PositionProps
PropDef
ReactNodePropDef
RegularPropDef
Responsive
ResponsivePropDef
Space
StringPropDef
StylingPropDef
TabMatchStrategy	Strategies for matching the current route to determine which tab should be active.
TextColors
TextColorStatus
TextOwnProps
TextProps
TextVariants
TextWeights
WidthProps