|
| 1 | +## API Report File for "@red-hat-developer-hub/backstage-plugin-quickstart" |
| 2 | + |
| 3 | +> Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/). |
| 4 | +
|
| 5 | +```ts |
| 6 | +import { BackstagePlugin } from '@backstage/core-plugin-api'; |
| 7 | +import { CSSProperties } from 'react'; |
| 8 | +import { JSX as JSX_2 } from 'react/jsx-runtime'; |
| 9 | +import { PropsWithChildren } from 'react'; |
| 10 | +import { TranslationRef } from '@backstage/frontend-plugin-api'; |
| 11 | +import { TranslationResource } from '@backstage/frontend-plugin-api'; |
| 12 | + |
| 13 | +// @public |
| 14 | +export type DrawerPartialState = { |
| 15 | + id: string; |
| 16 | + isDrawerOpen: boolean; |
| 17 | + drawerWidth: number; |
| 18 | + setDrawerWidth: (width: number) => void; |
| 19 | + closeDrawer: () => void; |
| 20 | +}; |
| 21 | + |
| 22 | +// @public |
| 23 | +export type DrawerStateExposerProps = { |
| 24 | + onStateChange: (state: DrawerPartialState) => void; |
| 25 | +}; |
| 26 | + |
| 27 | +// @public |
| 28 | +export const filterQuickstartItemsByRole: ( |
| 29 | + items: QuickstartItemData[], |
| 30 | + userRole: string, |
| 31 | +) => QuickstartItemData[]; |
| 32 | + |
| 33 | +// @public |
| 34 | +export const QuickstartButton: ( |
| 35 | + input: QuickstartButtonProps, |
| 36 | +) => JSX_2.Element | null; |
| 37 | + |
| 38 | +// @public |
| 39 | +export interface QuickstartButtonProps { |
| 40 | + onClick?: () => void; |
| 41 | + style?: CSSProperties; |
| 42 | + title?: string; |
| 43 | +} |
| 44 | + |
| 45 | +// @public |
| 46 | +export const QuickstartDrawerContent: () => JSX_2.Element | null; |
| 47 | + |
| 48 | +// @public |
| 49 | +export interface QuickstartDrawerContextType { |
| 50 | + closeDrawer: () => void; |
| 51 | + drawerWidth: number; |
| 52 | + isDrawerOpen: boolean; |
| 53 | + openDrawer: () => void; |
| 54 | + roleLoading: boolean; |
| 55 | + setDrawerWidth: React.Dispatch<React.SetStateAction<number>>; |
| 56 | + toggleDrawer: () => void; |
| 57 | + userRole: UserRole | null; |
| 58 | +} |
| 59 | + |
| 60 | +// @public |
| 61 | +export const QuickstartDrawerProvider: ( |
| 62 | + input: PropsWithChildren, |
| 63 | +) => JSX_2.Element; |
| 64 | + |
| 65 | +// @public |
| 66 | +export const QuickstartDrawerStateExposer: ( |
| 67 | + input: DrawerStateExposerProps, |
| 68 | +) => null; |
| 69 | + |
| 70 | +// @public |
| 71 | +export interface QuickstartItemCtaData { |
| 72 | + link: string; |
| 73 | + text: string; |
| 74 | + textKey?: string; |
| 75 | +} |
| 76 | + |
| 77 | +// @public |
| 78 | +export interface QuickstartItemData { |
| 79 | + cta?: QuickstartItemCtaData; |
| 80 | + description: string; |
| 81 | + descriptionKey?: string; |
| 82 | + icon?: string; |
| 83 | + roles?: string[]; |
| 84 | + title: string; |
| 85 | + titleKey?: string; |
| 86 | +} |
| 87 | + |
| 88 | +// @public |
| 89 | +export const quickstartPlugin: BackstagePlugin<{}, {}, {}>; |
| 90 | + |
| 91 | +// @public |
| 92 | +export const quickstartTranslationRef: TranslationRef< |
| 93 | + 'plugin.quickstart', |
| 94 | + { |
| 95 | + readonly 'header.title': string; |
| 96 | + readonly 'header.subtitle': string; |
| 97 | + readonly 'steps.setupAuthentication.title': string; |
| 98 | + readonly 'steps.setupAuthentication.description': string; |
| 99 | + readonly 'steps.setupAuthentication.ctaTitle': string; |
| 100 | + readonly 'steps.configureRbac.title': string; |
| 101 | + readonly 'steps.configureRbac.description': string; |
| 102 | + readonly 'steps.configureRbac.ctaTitle': string; |
| 103 | + readonly 'steps.configureGit.title': string; |
| 104 | + readonly 'steps.configureGit.description': string; |
| 105 | + readonly 'steps.configureGit.ctaTitle': string; |
| 106 | + readonly 'steps.managePlugins.title': string; |
| 107 | + readonly 'steps.managePlugins.description': string; |
| 108 | + readonly 'steps.managePlugins.ctaTitle': string; |
| 109 | + readonly 'steps.importApplication.title': string; |
| 110 | + readonly 'steps.importApplication.description': string; |
| 111 | + readonly 'steps.importApplication.ctaTitle': string; |
| 112 | + readonly 'steps.learnAboutCatalog.title': string; |
| 113 | + readonly 'steps.learnAboutCatalog.description': string; |
| 114 | + readonly 'steps.learnAboutCatalog.ctaTitle': string; |
| 115 | + readonly 'steps.exploreSelfServiceTemplates.title': string; |
| 116 | + readonly 'steps.exploreSelfServiceTemplates.description': string; |
| 117 | + readonly 'steps.exploreSelfServiceTemplates.ctaTitle': string; |
| 118 | + readonly 'steps.findAllLearningPaths.title': string; |
| 119 | + readonly 'steps.findAllLearningPaths.description': string; |
| 120 | + readonly 'steps.findAllLearningPaths.ctaTitle': string; |
| 121 | + readonly 'steps.setupLightspeed.title': string; |
| 122 | + readonly 'steps.setupLightspeed.description': string; |
| 123 | + readonly 'steps.setupLightspeed.ctaTitle': string; |
| 124 | + readonly 'steps.getStartedWithLightspeed.title': string; |
| 125 | + readonly 'steps.getStartedWithLightspeed.description': string; |
| 126 | + readonly 'steps.getStartedWithLightspeed.ctaTitle': string; |
| 127 | + readonly 'button.quickstart': string; |
| 128 | + readonly 'button.openQuickstartGuide': string; |
| 129 | + readonly 'button.closeDrawer': string; |
| 130 | + readonly 'button.gotIt': string; |
| 131 | + readonly 'snackbar.helpPrompt': string; |
| 132 | + readonly 'footer.progress': string; |
| 133 | + readonly 'footer.notStarted': string; |
| 134 | + readonly 'footer.hide': string; |
| 135 | + readonly 'content.emptyState.title': string; |
| 136 | + readonly 'item.expandAriaLabel': string; |
| 137 | + readonly 'item.collapseAriaLabel': string; |
| 138 | + readonly 'item.expandButtonAriaLabel': string; |
| 139 | + readonly 'item.collapseButtonAriaLabel': string; |
| 140 | + readonly 'dev.pageTitle': string; |
| 141 | + readonly 'dev.pageDescription': string; |
| 142 | + readonly 'dev.drawerControls': string; |
| 143 | + readonly 'dev.currentState': string; |
| 144 | + readonly 'dev.stateOpen': string; |
| 145 | + readonly 'dev.stateClosed': string; |
| 146 | + readonly 'dev.instructions': string; |
| 147 | + readonly 'dev.step1': string; |
| 148 | + readonly 'dev.step2': string; |
| 149 | + readonly 'dev.step3': string; |
| 150 | + readonly 'dev.step4': string; |
| 151 | + readonly 'dev.step5': string; |
| 152 | + } |
| 153 | +>; |
| 154 | + |
| 155 | +// @public |
| 156 | +export const quickstartTranslations: TranslationResource<'plugin.quickstart'>; |
| 157 | + |
| 158 | +// @public |
| 159 | +export const useQuickstartDrawerContext: () => QuickstartDrawerContextType; |
| 160 | + |
| 161 | +// @public |
| 162 | +export type UserRole = 'admin' | 'developer'; |
| 163 | + |
| 164 | +// (No @packageDocumentation comment for this package) |
| 165 | +``` |
0 commit comments