Skip to main content

@backstage/canon

Home > @backstage/canon

Components used by Backstage plugins and apps

Functions

Function

Description

Icon(props)

IconProvider(props)

marginPropDefs(spacingValues)

paddingPropDefs(spacingValues)

useBreakpoint()

useIcons()

Interfaces

Interface

Description

AvatarProps

BoxProps

ButtonProps

Properties for Button

CheckboxProps

ContainerProps

DataTablePaginationProps

DataTableRootProps

DataTableTableProps

FlexProps

GridItemProps

GridProps

HeadingProps

IconButtonProps

Properties for IconButton

IconContextProps

IconProviderProps

LinkProps

SelectProps

SpaceProps

TableCellLinkProps

TableCellProfileProps

TableCellTextProps

TextFieldProps

TextProps

UtilityProps

Variables

Variable

Description

Avatar

Box

boxPropDefs

breakpoints

Button

buttonPropDefs

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.

Container

DataTable

DataTable component for displaying tabular data with pagination

displayPropDefs

Flex

flexPropDefs

gapPropDefs

Grid

gridItemPropDefs

gridPropDefs

Heading

heightPropDefs

IconButton

iconButtonPropDefs

IconContext

icons

Link

Menu

positionPropDefs

ScrollArea

Select

Table

Table component for displaying tabular data

Text_2

TextField

Tooltip

widthPropDefs

Type Aliases

Type Alias

Description

AlignItems

ArbitraryStylingPropDef

AsProps

BooleanPropDef

Border

BorderRadius

BoxOwnProps

Breakpoint

ButtonOwnProps

Columns

Display

DisplayProps

EnumOrStringPropDef

EnumPropDef

FlexDirection

FlexOwnProps

FlexWrap

GapProps

GetPropDefType

GetPropDefTypes

GridItemOwnProps

GridOwnProps

HeightProps

IconButtonOwnProps

IconMap

IconNames

IconProps

JustifyContent

MarginProps

MenuComponent

NonStylingPropDef

PaddingProps

PositionProps

PropDef

ReactNodePropDef

RegularPropDef

Responsive

ResponsivePropDef

Space

StringPropDef

StylingPropDef

WidthProps