import { ReportIssueProps } from './ReportIssue';
/**
* The TechDocs addons contrib plugin
*
* @public
*/
export declare const techdocsModuleAddonsContribPlugin: import("@backstage/core-plugin-api").BackstagePlugin<{}, {}>;
/**
* TechDocs addon that lets you expand/collapse the TechDocs main navigation
* and keep the preferred state in local storage. The addon will render as
* a button next to the site name if the documentation has nested navigation.
*
* @example
* Here's a simple example:
* ```
* import {
* DefaultTechDocsHome,
* TechDocsIndexPage,
* TechDocsReaderPage,
* } from '@backstage/plugin-techdocs';
* import { TechDocsAddons } from '@backstage/plugin-techdocs-react/alpha';
* import { ExpandableNavigation } from '@backstage/plugin-techdocs-module-addons-contrib';
*
*
* const AppRoutes = () => {
*
* // other plugin routes
* }>
*
*
* }
* >
*
*
*
*
* ;
* };
* ```
*
* @public
*/
export declare const ExpandableNavigation: () => JSX.Element | null;
/**
* TechDocs addon that lets you select text and open GitHub/Gitlab issues
*
* @remarks
* Before using it, you should set up an `edit_uri` for your pages as explained {@link https://backstage.io/docs/features/techdocs/faqs#is-it-possible-for-users-to-suggest-changes-or-provide-feedback-on-a-techdocs-page | here} and remember, it only works for Github or Gitlab.
*
* @example
* Here's a simple example:
* ```
* import {
* DefaultTechDocsHome,
* TechDocsIndexPage,
* TechDocsReaderPage,
* } from '@backstage/plugin-techdocs';
* import { TechDocsAddons } from '@backstage/plugin-techdocs-react';
* import { ReportIssue } from '@backstage/plugin-techdocs-module-addons-contrib';
*
*
* const AppRoutes = () => {
*
* // other plugin routes
* }>
*
*
* }
* >
*
*
*
*
* ;
* };
* ```
*
* @example
* Here's an example with `debounceTime` and `templateBuilder` props:
* ```
* import {
* DefaultTechDocsHome,
* TechDocsIndexPage,
* TechDocsReaderPage,
* } from '@backstage/plugin-techdocs';
* import { TechDocsAddons } from '@backstage/plugin-techdocs-react';
* import { ReportIssue } from '@backstage/plugin-techdocs-module-addons-contrib';
*
* const templateBuilder = ({ selection }: ReportIssueTemplateBuilder) => (({
* title: 'Custom issue title',
* body: `Custom issue body: ${selection.toString()}`
* }))
*
* const AppRoutes = () => {
*
* // other plugin routes
* }>
*
*
* }
* >
*
*
*
*
* ;
* ```
* @param props - Object that can optionally contain `debounceTime` and `templateBuilder` properties.
* @public
*/
export declare const ReportIssue: (props: ReportIssueProps) => JSX.Element | null;
/**
* This TechDocs addon allows users to customize text size on documentation pages, they can select how much they want to increase or decrease the font size via slider or buttons.
*
* @remarks
* The default value for the font size is 100% of the HTML font size, if the theme does not have a `htmlFontSize` in its typography object, the addon will assume 16px as 100%, and remember, this setting is kept in the browser local storage.
*
* @example
* Here's a simple example:
* ```
* import {
* DefaultTechDocsHome,
* TechDocsIndexPage,
* TechDocsReaderPage,
* } from '@backstage/plugin-techdocs';
* import { TechDocsAddons } from '@backstage/plugin-techdocs-react';
* import { TextSize } from '@backstage/plugin-techdocs-module-addons-contrib';
*
*
* const AppRoutes = () => {
*
* // other plugin routes
* }>
*
*
* }
* >
*
*
*
*
* ;
* };
* ```
*
* @public
*/
export declare const TextSize: () => JSX.Element | null;
/**
* This TechDocs addon allows users to open images in a lightbox on documentation pages, they can navigate between images if there are several on one page.
*
* @remarks
* The image size of the lightbox image is the same as the image size on the document page.
*
* @example
* Here's a simple example:
* ```
* import {
* DefaultTechDocsHome,
* TechDocsIndexPage,
* TechDocsReaderPage,
* } from '@backstage/plugin-techdocs';
* import { TechDocsAddons } from '@backstage/plugin-techdocs-react';
* import { LightBox } from '@backstage/plugin-techdocs-module-addons-contrib';
*
*
* const AppRoutes = () => {
*
* // other plugin routes
* }>
*
*
* }
* >
*
*
*
*
* ;
* };
* ```
*
* @public
*/
export declare const LightBox: () => JSX.Element | null;