@backstage/plugin-home

Home > @backstage/plugin-home

A Backstage plugin that helps you build a home page

Classes

Class	Description
VisitsStorageApi	This is an implementation of VisitsApi that relies on a StorageApi. Beware that filtering and ordering are done in memory therefore it is prudent to keep limit to a reasonable size.
VisitsWebStorageApi	This is a reference implementation of VisitsApi using WebStorage.

Functions

Function	Description
ComponentAccordion(props)
ComponentTab(props)
ComponentTabs(props)
CustomHomepageGrid(props)	A component that allows customizing components in home grid layout.
FeaturedDocsCard(props)	A component to display specific Featured Docs.
HeaderWorldClock(props)	A component to display a configurable list of clocks for various time zones.
HomePageCompanyLogo(props)	A component to display a company logo for the user.
HomepageCompositionRoot(props)
HomePageRandomJoke(props)
HomePageRecentlyVisited(props)	Display recently visited pages for the homepage
HomePageStarredEntities(props)	A component to display a list of starred entities for the user.
HomePageToolkit(props)	A component to display a list of tools for the user.
HomePageTopVisited(props)	Display top visited pages for the homepage
isOperator(s)	Type guard for operators.
QuickStartCard(props)	A component to display Quick Start information.
SettingsModal(props)
TemplateBackstageLogo(props)
TemplateBackstageLogoIcon()
VisitListener({ children, toEntityRef, visitName, })	Component responsible for listening to location changes and calling the visitsApi to save visits.
WelcomeTitle({ language, variant, })	A component to display a playful greeting for the user.

Interfaces

Interface	Description
VisitsApi	Visits API public contract.

Variables

Variable	Description
createCardExtension
homePlugin
visitsApiRef

Type Aliases

Type Alias	Description
Breakpoint	Breakpoint options for
CardConfig
CardExtensionProps
CardLayout
CardSettings
ClockConfig
ComponentParts
ComponentRenderer
CustomHomepageGridProps	Props customizing the component.
FeaturedDocsCardProps	Props customizing the component.
LayoutConfiguration	Layout configuration that can be passed to the custom home page.
Operators	The operators that can be used in filter.
QuickStartCardProps	Props customizing the component.
RendererProps
StarredEntitiesProps	Props for the StarredEntities component
Tool
ToolkitContentProps	Props for Toolkit Content component.
Visit	Model for a visit entity.
VisitedByTypeKind
VisitedByTypeProps
VisitsApiQueryParams	This data structure represents the parameters associated with search queries for visits.
VisitsApiSaveParams	This data structure represents the parameters associated with saving visits.
VisitsStorageApiOptions
VisitsWebStorageApiOptions
WelcomeTitleLanguageProps