Backstage
    Preparing search index...

    Variable SubPageBlueprintConst

    SubPageBlueprint: ExtensionBlueprint<
        {
            config: { path: string
            | undefined; title: string | undefined };
            configInput: { path?: string; title?: string };
            dataRefs: never;
            inputs: {};
            kind: "sub-page";
            output:
                | ExtensionDataRef<Element, "core.reactElement", {}>
                | ExtensionDataRef<string, "core.routing.path", {}>
                | ExtensionDataRef<
                    RouteRef<AnyRouteRefParams>,
                    "core.routing.ref",
                    { optional: true },
                >
                | ExtensionDataRef<string, "core.title", {}>
                | ExtensionDataRef<IconElement, "core.icon", { optional: true }>;
            params: {
                icon?: IconElement;
                loader: () => Promise<Element>;
                path: string;
                routeRef?: RouteRef<AnyRouteRefParams>;
                title: string;
            };
        },
    > = ...

    Creates extensions that are sub-page React components attached to a parent page. Sub-pages are rendered as tabs within the parent page's header.

    const overviewRouteRef = createRouteRef();

    const mySubPage = SubPageBlueprint.make({
      attachTo: { id: 'page:my-plugin', input: 'pages' },
      name: 'overview',
      params: {
        path: 'overview',
        title: 'Overview',
        routeRef: overviewRouteRef,
        loader: () => import('./components/Overview').then(m => <m.Overview />),
      },
    });

    Settings

    Member Visibility