Interface DevAppBuilder

DevApp builder that is similar to the App builder API, but creates an App with the purpose of developing one or more plugins inside it.

interface DevAppBuilder {
    addPage(opts: DevAppPageOptions): DevAppBuilder;
    addRootChild(node: ReactNode): DevAppBuilder;
    addSidebarItem(sidebarItem: Element): DevAppBuilder;
    addSignInProvider(provider: SignInProviderConfig): DevAppBuilder;
    addThemes(themes: AppTheme[]): DevAppBuilder;
    addTranslationResource(resource: TranslationResource): DevAppBuilder;
    build(): ComponentType<{ children?: ReactNode }>;
    registerApi<Api, Impl, Deps extends { [key: string]: unknown }>(
        factory: ApiFactory<Api, Impl, Deps>,
    ): DevAppBuilder;
    registerPlugin(...plugins: BackstagePlugin[]): DevAppBuilder;
    render(): void;
    setAvailableLanguages(languages: string[]): DevAppBuilder;
    setDefaultLanguage(language: string): DevAppBuilder;
}

Index

Methods

addPage addRootChild addSidebarItem addSignInProvider addThemes addTranslationResource build registerApi registerPlugin render setAvailableLanguages setDefaultLanguage

Methods

addPage

addPage(opts: DevAppPageOptions): DevAppBuilder
Adds a page component along with accompanying sidebar item.

If no path is provided one will be generated. If no title is provided, no sidebar item will be created.
Parameters
- opts: DevAppPageOptions
Returns DevAppBuilder
- Defined in packages/dev-utils/src/devApp/render.tsx:157

addRootChild

addRootChild(node: ReactNode): DevAppBuilder
Adds a React node to place just inside the App Provider.

Useful for adding more global components like the AlertDisplay.
Parameters
- node: ReactNode
Returns DevAppBuilder
- Defined in packages/dev-utils/src/devApp/render.tsx:136

addSidebarItem

addSidebarItem(sidebarItem: Element): DevAppBuilder
Adds a new sidebar item to the dev app.

Useful for adding only sidebar items without a corresponding page.
Parameters
- sidebarItem: Element
Returns DevAppBuilder
- Defined in packages/dev-utils/src/devApp/render.tsx:146

addSignInProvider

addSignInProvider(provider: SignInProviderConfig): DevAppBuilder
Adds new sign in provider for the dev app
Parameters
- provider: SignInProviderConfig
Returns DevAppBuilder
- Defined in packages/dev-utils/src/devApp/render.tsx:197

addThemes

addThemes(themes: AppTheme[]): DevAppBuilder
Adds an array of themes to override the default theme.
Parameters
- themes: AppTheme[]
Returns DevAppBuilder
- Defined in packages/dev-utils/src/devApp/render.tsx:189

addTranslationResource

addTranslationResource(resource: TranslationResource): DevAppBuilder
Add translation resource to the dev app
Parameters
- resource: TranslationResource
Returns DevAppBuilder
- Defined in packages/dev-utils/src/devApp/render.tsx:213

build

build(): ComponentType<{ children?: ReactNode }>
Build a DevApp component using the resources registered so far

Returns ComponentType<{ children?: ReactNode }>
- Defined in packages/dev-utils/src/devApp/render.tsx:229

registerApi

registerApi<Api, Impl, Deps extends { [key: string]: unknown }>(
factory: ApiFactory<Api, Impl, Deps>,
): DevAppBuilder
Register an API factory to add to the app
Type Parameters
- Api
- Impl
- Deps extends { [key: string]: unknown }
Parameters
- factory: ApiFactory<Api, Impl, Deps>
Returns DevAppBuilder
- Defined in packages/dev-utils/src/devApp/render.tsx:122

registerPlugin

registerPlugin(...plugins: BackstagePlugin[]): DevAppBuilder
Register one or more plugins to render in the dev app
Parameters
- ...plugins: BackstagePlugin[]
Returns DevAppBuilder
- Defined in packages/dev-utils/src/devApp/render.tsx:114

render

render(): void
Build and render directory to #root element, with react hot loading.

Returns void
- Defined in packages/dev-utils/src/devApp/render.tsx:309

setAvailableLanguages

setAvailableLanguages(languages: string[]): DevAppBuilder
Set available languages to be shown in the dev app
Parameters
- languages: string[]
Returns DevAppBuilder
- Defined in packages/dev-utils/src/devApp/render.tsx:205

setDefaultLanguage

setDefaultLanguage(language: string): DevAppBuilder
Set default language for the dev app
Parameters
- language: string
Returns DevAppBuilder
- Defined in packages/dev-utils/src/devApp/render.tsx:221

Interface DevAppBuilder

Index

Methods

Methods

addPage

Parameters

Returns DevAppBuilder

addRootChild

Parameters

Returns DevAppBuilder

addSidebarItem

Parameters

Returns DevAppBuilder

addSignInProvider

Parameters

Returns DevAppBuilder

addThemes

Parameters

Returns DevAppBuilder

addTranslationResource

Parameters

Returns DevAppBuilder

build

Returns ComponentType<{ children?: ReactNode }>

registerApi

Type Parameters

Parameters

Returns DevAppBuilder

registerPlugin

Parameters

Returns DevAppBuilder

render

Returns void

setAvailableLanguages

Parameters

Returns DevAppBuilder

setDefaultLanguage

Parameters

Returns DevAppBuilder

Settings

On This Page