@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. |
Interfaces
| Interface | Description |
|---|---|
| VisitsApi | Visits API public contract. |
Variables
| Variable | Description |
|---|---|
| ComponentAccordion | |
| ComponentTab | |
| ComponentTabs | |
| createCardExtension | |
| CustomHomepageGrid | A component that allows customizing components in home grid layout. |
| FeaturedDocsCard | A component to display specific Featured Docs. |
| HeaderWorldClock | A component to display a configurable list of clocks for various time zones. |
| HomePageCompanyLogo | A component to display a company logo for the user. |
| HomepageCompositionRoot | |
| HomePageRandomJoke | |
| HomePageRecentlyVisited | Display recently visited pages for the homepage |
| HomePageStarredEntities | A component to display a list of starred entities for the user. |
| HomePageToolkit | A component to display a list of tools for the user. |
| HomePageTopVisited | Display top visited pages for the homepage |
| homePlugin | |
| isOperator | Type guard for operators. |
| SettingsModal | |
| TemplateBackstageLogo | |
| TemplateBackstageLogoIcon | |
| VisitListener | Component responsible for listening to location changes and calling the visitsApi to save visits. |
| visitsApiRef | |
| WelcomeTitle | A component to display a playful greeting for the user. |
Type Aliases
| Type Alias | Description |
|---|---|
| Breakpoint | Breakpoint options for |
| CardConfig | |
| CardExtensionProps | |
| CardLayout | |
| CardSettings | |
| ClockConfig | |
| ComponentParts | |
| ComponentRenderer | |
| CustomHomepageGridProps | Props customizing the |
| FeaturedDocsCardProps | Props customizing the |
| LayoutConfiguration | Layout configuration that can be passed to the custom home page. |
| Operators | The operators that can be used in filter. |
| RendererProps | |
| StarredEntitiesProps | A component to display a list of starred entities for the user. |
| 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 |