@backstage/canon

Home > @backstage/canon

Components used by Backstage plugins and apps

Functions

Function	Description
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)
useBreakpoint()
useIcons()

Interfaces

Interface	Description
AvatarProps
BoxProps
ButtonIconProps	Properties for ButtonIcon
ButtonLinkProps	Properties for ButtonLink
ButtonProps	Properties for Button
CheckboxProps
ComponentDefinition	Base type for the component styles structure
ContainerProps
DataTablePaginationProps
DataTableRootProps
DataTableTableProps
FieldLabelProps
FlexProps
GridItemProps
GridProps
HeaderBreadcrumb	Represents a breadcrumb item in the header.
HeaderOption	Represents an option item in the header dropdown menu.
HeaderPageOption	Represents an option item in the header page.
HeaderPageProps	Props for the main HeaderPage component.
HeaderPageTab	Represents a tab item in the header page.
HeaderProps	Props for the main Header component.
HeaderTab	Represents a tab item in the header navigation.
IconContextProps
IconProviderProps
LinkProps
MenuComboboxProps
RadioGroupProps
RadioProps
SearchFieldProps
SelectProps
SpaceProps
SwitchProps
TableCellLinkProps
TableCellProfileProps
TableCellTextProps
TabsRootWithoutOrientation
TextFieldProps
UtilityProps

Variables

Variable	Description
Avatar
Box
boxPropDefs
breakpoints
Button
ButtonIcon
ButtonLink
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 Canon library
Container
DataTable	DataTable component for displaying tabular data with pagination
displayPropDefs
FieldLabel
Flex
flexPropDefs
gapPropDefs
Grid
gridItemPropDefs
gridPropDefs
Heading
heightPropDefs
IconContext
icons
Link
Menu
positionPropDefs
Radio
RadioGroup
ScrollArea
SearchField
Select
Switch
Table	Table component for displaying tabular data
Tabs
Text_2
TextField
Tooltip
widthPropDefs

Type Aliases

Type Alias	Description
AlignItems
ArbitraryStylingPropDef
AsProps
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
HeadingOwnProps
HeadingProps
HeightProps
IconMap
IconNames
IconProps
JustifyContent
MarginProps
MenuComboboxOption
MenuComponent
NonStylingPropDef
PaddingProps
PositionProps
PropDef
ReactNodePropDef
RegularPropDef
Responsive
ResponsivePropDef
Space
StringPropDef
StylingPropDef
TextOwnProps
TextProps
WidthProps