@backstage/plugin-techdocs/dist/alpha.d.ts

The Backstage plugin that renders technical documentation for your components

import * as _backstage_core_plugin_api from '@backstage/core-plugin-api';
import * as _backstage_core_components from '@backstage/core-components';
import * as _backstage_plugin_techdocs_react from '@backstage/plugin-techdocs-react';
import * as _backstage_catalog_model from '@backstage/catalog-model';
import * as _backstage_plugin_catalog_react_alpha from '@backstage/plugin-catalog-react/alpha';
import * as react from 'react';
import * as _backstage_frontend_plugin_api from '@backstage/frontend-plugin-api';
import * as _backstage_plugin_search_react_alpha from '@backstage/plugin-search-react/alpha';

/** @alpha */
declare const techDocsSearchResultListItemExtension: _backstage_frontend_plugin_api.ExtensionDefinition<{
    config: {
        title: string | undefined;
        lineClamp: number;
        asLink: boolean;
        asListItem: boolean;
    } & {
        noTrack: boolean;
    };
    configInput: {
        title?: string | undefined;
        lineClamp?: number | undefined;
        asListItem?: boolean | undefined;
        asLink?: boolean | undefined;
    } & {
        noTrack?: boolean | undefined;
    };
    output: _backstage_frontend_plugin_api.ConfigurableExtensionDataRef<{
        predicate?: _backstage_plugin_search_react_alpha.SearchResultItemExtensionPredicate;
        component: _backstage_plugin_search_react_alpha.SearchResultItemExtensionComponent;
    }, "search.search-result-list-item.item", {}>;
    inputs: {
        [x: string]: _backstage_frontend_plugin_api.ExtensionInput<_backstage_frontend_plugin_api.AnyExtensionDataRef, {
            optional: boolean;
            singleton: boolean;
        }>;
    };
    kind: "search-result-list-item";
    name: undefined;
    params: _backstage_plugin_search_react_alpha.SearchResultListItemBlueprintParams;
}>;
/** @alpha */
declare const _default: _backstage_frontend_plugin_api.FrontendPlugin<{
    root: _backstage_frontend_plugin_api.RouteRef<undefined>;
    docRoot: _backstage_frontend_plugin_api.RouteRef<{
        name: string;
        kind: string;
        namespace: string;
    }>;
    entityContent: _backstage_frontend_plugin_api.RouteRef<undefined>;
}, {}, {
    "api:techdocs": _backstage_frontend_plugin_api.ExtensionDefinition<{
        kind: "api";
        name: undefined;
        config: {};
        configInput: {};
        output: _backstage_frontend_plugin_api.ConfigurableExtensionDataRef<_backstage_frontend_plugin_api.AnyApiFactory, "core.api.factory", {}>;
        inputs: {};
        params: {
            factory: _backstage_frontend_plugin_api.AnyApiFactory;
        };
    }>;
    "api:techdocs/storage": _backstage_frontend_plugin_api.ExtensionDefinition<{
        kind: "api";
        name: "storage";
        config: {};
        configInput: {};
        output: _backstage_frontend_plugin_api.ConfigurableExtensionDataRef<_backstage_frontend_plugin_api.AnyApiFactory, "core.api.factory", {}>;
        inputs: {};
        params: {
            factory: _backstage_frontend_plugin_api.AnyApiFactory;
        };
    }>;
    "empty-state:techdocs/entity-content": _backstage_frontend_plugin_api.ExtensionDefinition<{
        config: {};
        configInput: {};
        output: _backstage_frontend_plugin_api.ConfigurableExtensionDataRef<react.JSX.Element, "core.reactElement", {
            optional: true;
        }>;
        inputs: {
            [x: string]: _backstage_frontend_plugin_api.ExtensionInput<_backstage_frontend_plugin_api.AnyExtensionDataRef, {
                optional: boolean;
                singleton: boolean;
            }>;
        };
        params: never;
        kind: "empty-state";
        name: "entity-content";
    }>;
    "entity-content:techdocs": _backstage_frontend_plugin_api.ExtensionDefinition<{
        config: {
            path: string | undefined;
            title: string | undefined;
            filter: _backstage_plugin_catalog_react_alpha.EntityPredicate | undefined;
            group: string | false | undefined;
        };
        configInput: {
            filter?: _backstage_plugin_catalog_react_alpha.EntityPredicate | undefined;
            title?: string | undefined;
            path?: string | undefined;
            group?: string | false | undefined;
        };
        output: _backstage_frontend_plugin_api.ConfigurableExtensionDataRef<react.JSX.Element, "core.reactElement", {}> | _backstage_frontend_plugin_api.ConfigurableExtensionDataRef<string, "core.routing.path", {}> | _backstage_frontend_plugin_api.ConfigurableExtensionDataRef<_backstage_frontend_plugin_api.RouteRef<_backstage_frontend_plugin_api.AnyRouteRefParams>, "core.routing.ref", {
            optional: true;
        }> | _backstage_frontend_plugin_api.ConfigurableExtensionDataRef<string, "catalog.entity-content-title", {}> | _backstage_frontend_plugin_api.ConfigurableExtensionDataRef<(entity: _backstage_catalog_model.Entity) => boolean, "catalog.entity-filter-function", {
            optional: true;
        }> | _backstage_frontend_plugin_api.ConfigurableExtensionDataRef<string, "catalog.entity-filter-expression", {
            optional: true;
        }> | _backstage_frontend_plugin_api.ConfigurableExtensionDataRef<string, "catalog.entity-content-group", {
            optional: true;
        }>;
        inputs: {
            addons: _backstage_frontend_plugin_api.ExtensionInput<_backstage_frontend_plugin_api.ConfigurableExtensionDataRef<_backstage_plugin_techdocs_react.TechDocsAddonOptions, "techdocs.addon", {}>, {
                singleton: false;
                optional: false;
            }>;
            emptyState: _backstage_frontend_plugin_api.ExtensionInput<_backstage_frontend_plugin_api.ConfigurableExtensionDataRef<react.JSX.Element, "core.reactElement", {
                optional: true;
            }>, {
                singleton: true;
                optional: true;
            }>;
        };
        kind: "entity-content";
        name: undefined;
        params: {
            loader: () => Promise<JSX.Element>;
            defaultPath: string;
            defaultTitle: string;
            defaultGroup?: keyof typeof _backstage_plugin_catalog_react_alpha.defaultEntityContentGroups | (string & {});
            routeRef?: _backstage_frontend_plugin_api.RouteRef;
            filter?: string | _backstage_plugin_catalog_react_alpha.EntityPredicate | ((entity: _backstage_catalog_model.Entity) => boolean);
        };
    }>;
    "entity-icon-link:techdocs/read-docs": _backstage_frontend_plugin_api.ExtensionDefinition<{
        kind: "entity-icon-link";
        name: "read-docs";
        config: {
            label: string | undefined;
            title: string | undefined;
            filter: _backstage_plugin_catalog_react_alpha.EntityPredicate | undefined;
        };
        configInput: {
            filter?: _backstage_plugin_catalog_react_alpha.EntityPredicate | undefined;
            label?: string | undefined;
            title?: string | undefined;
        };
        output: _backstage_frontend_plugin_api.ConfigurableExtensionDataRef<(entity: _backstage_catalog_model.Entity) => boolean, "catalog.entity-filter-function", {
            optional: true;
        }> | _backstage_frontend_plugin_api.ConfigurableExtensionDataRef<string, "catalog.entity-filter-expression", {
            optional: true;
        }> | _backstage_frontend_plugin_api.ConfigurableExtensionDataRef<() => _backstage_core_components.IconLinkVerticalProps, "entity-icon-link-props", {}>;
        inputs: {};
        params: {
            useProps: () => Omit<_backstage_core_components.IconLinkVerticalProps, "color">;
            filter?: _backstage_plugin_catalog_react_alpha.EntityPredicate | ((entity: _backstage_catalog_model.Entity) => boolean);
        };
    }>;
    "nav-item:techdocs": _backstage_frontend_plugin_api.ExtensionDefinition<{
        kind: "nav-item";
        name: undefined;
        config: {};
        configInput: {};
        output: _backstage_frontend_plugin_api.ConfigurableExtensionDataRef<{
            title: string;
            icon: _backstage_core_plugin_api.IconComponent;
            routeRef: _backstage_frontend_plugin_api.RouteRef<undefined>;
        }, "core.nav-item.target", {}>;
        inputs: {};
        params: {
            title: string;
            icon: _backstage_core_plugin_api.IconComponent;
            routeRef: _backstage_frontend_plugin_api.RouteRef<undefined>;
        };
    }>;
    "page:techdocs": _backstage_frontend_plugin_api.ExtensionDefinition<{
        kind: "page";
        name: undefined;
        config: {
            path: string | undefined;
        };
        configInput: {
            path?: string | undefined;
        };
        output: _backstage_frontend_plugin_api.ConfigurableExtensionDataRef<react.JSX.Element, "core.reactElement", {}> | _backstage_frontend_plugin_api.ConfigurableExtensionDataRef<string, "core.routing.path", {}> | _backstage_frontend_plugin_api.ConfigurableExtensionDataRef<_backstage_frontend_plugin_api.RouteRef<_backstage_frontend_plugin_api.AnyRouteRefParams>, "core.routing.ref", {
            optional: true;
        }>;
        inputs: {};
        params: {
            defaultPath: string;
            loader: () => Promise<JSX.Element>;
            routeRef?: _backstage_frontend_plugin_api.RouteRef;
        };
    }>;
    "page:techdocs/reader": _backstage_frontend_plugin_api.ExtensionDefinition<{
        config: {
            path: string | undefined;
        };
        configInput: {
            path?: string | undefined;
        };
        output: _backstage_frontend_plugin_api.ConfigurableExtensionDataRef<react.JSX.Element, "core.reactElement", {}> | _backstage_frontend_plugin_api.ConfigurableExtensionDataRef<string, "core.routing.path", {}> | _backstage_frontend_plugin_api.ConfigurableExtensionDataRef<_backstage_frontend_plugin_api.RouteRef<_backstage_frontend_plugin_api.AnyRouteRefParams>, "core.routing.ref", {
            optional: true;
        }>;
        inputs: {
            addons: _backstage_frontend_plugin_api.ExtensionInput<_backstage_frontend_plugin_api.ConfigurableExtensionDataRef<_backstage_plugin_techdocs_react.TechDocsAddonOptions, "techdocs.addon", {}>, {
                singleton: false;
                optional: false;
            }>;
        };
        kind: "page";
        name: "reader";
        params: {
            defaultPath: string;
            loader: () => Promise<JSX.Element>;
            routeRef?: _backstage_frontend_plugin_api.RouteRef;
        };
    }>;
    "search-result-list-item:techdocs": _backstage_frontend_plugin_api.ExtensionDefinition<{
        config: {
            title: string | undefined;
            lineClamp: number;
            asLink: boolean;
            asListItem: boolean;
        } & {
            noTrack: boolean;
        };
        configInput: {
            title?: string | undefined;
            lineClamp?: number | undefined;
            asListItem?: boolean | undefined;
            asLink?: boolean | undefined;
        } & {
            noTrack?: boolean | undefined;
        };
        output: _backstage_frontend_plugin_api.ConfigurableExtensionDataRef<{
            predicate?: _backstage_plugin_search_react_alpha.SearchResultItemExtensionPredicate;
            component: _backstage_plugin_search_react_alpha.SearchResultItemExtensionComponent;
        }, "search.search-result-list-item.item", {}>;
        inputs: {
            [x: string]: _backstage_frontend_plugin_api.ExtensionInput<_backstage_frontend_plugin_api.AnyExtensionDataRef, {
                optional: boolean;
                singleton: boolean;
            }>;
        };
        kind: "search-result-list-item";
        name: undefined;
        params: _backstage_plugin_search_react_alpha.SearchResultListItemBlueprintParams;
    }>;
}>;

export { _default as default, techDocsSearchResultListItemExtension };