diff --git a/plugins/techdocs-module-addons-contrib/api-report.md b/plugins/techdocs-module-addons-contrib/api-report.md index 490b414141..19d2f70a2b 100644 --- a/plugins/techdocs-module-addons-contrib/api-report.md +++ b/plugins/techdocs-module-addons-contrib/api-report.md @@ -10,19 +10,19 @@ import { BackstagePlugin } from '@backstage/core-plugin-api'; // @public export const ReportIssue: (props: ReportIssueProps) => JSX.Element | null; -// @public (undocumented) +// @public export type ReportIssueProps = { debounceTime?: number; templateBuilder?: ReportIssueTemplateBuilder; }; -// @public (undocumented) +// @public export type ReportIssueTemplate = { title: string; body: string; }; -// @public (undocumented) +// @public export type ReportIssueTemplateBuilder = ({ selection, }: { diff --git a/plugins/techdocs-module-addons-contrib/src/ReportIssue/ReportIssue.tsx b/plugins/techdocs-module-addons-contrib/src/ReportIssue/ReportIssue.tsx index 2fe8d604e6..c8caa5ddbc 100644 --- a/plugins/techdocs-module-addons-contrib/src/ReportIssue/ReportIssue.tsx +++ b/plugins/techdocs-module-addons-contrib/src/ReportIssue/ReportIssue.tsx @@ -49,10 +49,21 @@ type Style = { }; /** + * Props customizing the Addon. + * * @public */ export type ReportIssueProps = { + /** + * Number of milliseconds after a user highlights some text before the report + * issue link appears above the highlighted text. Defaults to 500ms. + */ debounceTime?: number; + + /** + * An optional function defining how a custom issue title and body should be + * constructed, given some selected text. + */ templateBuilder?: ReportIssueTemplateBuilder; }; diff --git a/plugins/techdocs-module-addons-contrib/src/ReportIssue/types.ts b/plugins/techdocs-module-addons-contrib/src/ReportIssue/types.ts index a4780535ca..0816b45d9d 100644 --- a/plugins/techdocs-module-addons-contrib/src/ReportIssue/types.ts +++ b/plugins/techdocs-module-addons-contrib/src/ReportIssue/types.ts @@ -15,14 +15,26 @@ */ /** + * Properties for creating an issue in a remote issue tracker. + * * @public */ export type ReportIssueTemplate = { + /** + * The title of the issue. + */ title: string; + + /** + * The body or description of the issue. + */ body: string; }; /** + * A function for returning a custom issue template, given a selection of text + * on a TechDocs page. + * * @public */ export type ReportIssueTemplateBuilder = ({