From be2ee4cc66a6f907340ecdf24925d4f3d4baf1af Mon Sep 17 00:00:00 2001 From: bnechyporenko Date: Fri, 14 Oct 2022 13:23:05 +0200 Subject: [PATCH] Updated api-report.md Signed-off-by: bnechyporenko --- .changeset/angry-trees-relax.md | 2 +- plugins/scaffolder/api-report.md | 17 ++++++++++++++--- .../MultistepJsonForm/MultistepJsonForm.tsx | 9 +++++++-- .../src/components/MultistepJsonForm/index.ts | 1 + 4 files changed, 23 insertions(+), 6 deletions(-) diff --git a/.changeset/angry-trees-relax.md b/.changeset/angry-trees-relax.md index 17fad10e0f..23d5704cbd 100644 --- a/.changeset/angry-trees-relax.md +++ b/.changeset/angry-trees-relax.md @@ -6,7 +6,7 @@ Enabling the customization of the last page in the scaffolder template. To override the content you have to do the next: -```typescript +```typescript jsx scaffolderPlugin.__experimentalReconfigure({ lastStepFormComponent: (props: LastStepFormProps) => ( diff --git a/plugins/scaffolder/api-report.md b/plugins/scaffolder/api-report.md index f8628b193a..9db48b03cc 100644 --- a/plugins/scaffolder/api-report.md +++ b/plugins/scaffolder/api-report.md @@ -187,10 +187,21 @@ export type LogEvent = { taskId: string; }; -// Warning: (ae-forgotten-export) The symbol "Props" needs to be exported by the entry point index.d.ts -// // @public -export const MultistepJsonForm: (props: Props) => JSX.Element; +export const MultistepJsonForm: (props: MultistepJsonFormProps) => JSX.Element; + +// @public +export type MultistepJsonFormProps = { + steps: Step[]; + formData: Record; + onChange: (e: IChangeEvent) => void; + onReset: () => void; + onFinish?: () => Promise; + widgets?: FormProps['widgets']; + fields?: FormProps['fields']; + finishButtonLabel?: string; + layouts: LayoutOptions[]; +}; // @alpha export type NextCustomFieldValidator = ( diff --git a/plugins/scaffolder/src/components/MultistepJsonForm/MultistepJsonForm.tsx b/plugins/scaffolder/src/components/MultistepJsonForm/MultistepJsonForm.tsx index 4f067141c9..bf85210eee 100644 --- a/plugins/scaffolder/src/components/MultistepJsonForm/MultistepJsonForm.tsx +++ b/plugins/scaffolder/src/components/MultistepJsonForm/MultistepJsonForm.tsx @@ -38,7 +38,12 @@ import { useScaffolderPluginOptions } from '../../options'; const Form = withTheme(MuiTheme); -type Props = { +/** + * The props for a dynamic form of a scaffolder template. + * + * @public + */ +export type MultistepJsonFormProps = { /** * Steps for the form, each contains title and form schema */ @@ -58,7 +63,7 @@ type Props = { * * @public */ -export const MultistepJsonForm = (props: Props) => { +export const MultistepJsonForm = (props: MultistepJsonFormProps) => { const { formData, onChange, diff --git a/plugins/scaffolder/src/components/MultistepJsonForm/index.ts b/plugins/scaffolder/src/components/MultistepJsonForm/index.ts index 59c58fcb05..262bd0447f 100644 --- a/plugins/scaffolder/src/components/MultistepJsonForm/index.ts +++ b/plugins/scaffolder/src/components/MultistepJsonForm/index.ts @@ -14,6 +14,7 @@ * limitations under the License. */ export { MultistepJsonForm } from './MultistepJsonForm'; +export type { MultistepJsonFormProps } from './MultistepJsonForm'; export { lastStepFormComponent, LastStepForm } from './LastStepForm'; export type { LastStepFormProps } from './LastStepForm'; export type { Step } from './types';