also export task page props and document

Signed-off-by: Brian Fletcher <brian@roadie.io>
This commit is contained in:
Brian Fletcher
2022-02-01 22:59:53 +00:00
parent 5f32f20a34
commit d0a3bdb263
4 changed files with 21 additions and 5 deletions
+6 -4
View File
@@ -277,12 +277,14 @@ const scaffolderPlugin: BackstagePlugin<
export { scaffolderPlugin as plugin };
export { scaffolderPlugin };
// Warning: (ae-forgotten-export) The symbol "TaskPageProps" needs to be exported by the entry point index.d.ts
// Warning: (ae-missing-release-tag) "TaskPage" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal)
//
// @public (undocumented)
// @public
export const TaskPage: ({ loadingText }: TaskPageProps) => JSX.Element;
// @public
export type TaskPageProps = {
loadingText?: string;
};
// Warning: (ae-missing-release-tag) "TemplateList" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal)
//
// @public (undocumented)
@@ -218,10 +218,22 @@ export const TaskStatusStepper = memo(
const hasLinks = ({ entityRef, remoteUrl, links = [] }: TaskOutput): boolean =>
!!(entityRef || remoteUrl || links.length > 0);
type TaskPageProps = {
/**
* TaskPageProps for constructing a TaskPage
* @param loadingText - Optional loading text shown before a task begins executing.
*
* @public
*/
export type TaskPageProps = {
loadingText?: string;
};
/**
* TaskPage for showing the status of the taskId provided as a param
* @param loadingText - Optional loading text shown before a task begins executing.
*
* @public
*/
export const TaskPage = ({ loadingText }: TaskPageProps) => {
const classes = useStyles();
const navigate = useNavigate();
@@ -14,3 +14,4 @@
* limitations under the License.
*/
export { TaskPage } from './TaskPage';
export type { TaskPageProps } from './TaskPage';
+1
View File
@@ -57,3 +57,4 @@ export { TemplateList } from './components/TemplateList';
export type { TemplateListProps } from './components/TemplateList';
export { TemplateTypePicker } from './components/TemplateTypePicker';
export { TaskPage } from './components/TaskPage';
export type { TaskPageProps } from './components/TaskPage';