Updated api-report.md

Signed-off-by: bnechyporenko <bnechyporenko@bol.com>
This commit is contained in:
bnechyporenko
2022-10-14 13:23:05 +02:00
parent 9e5d5dfe75
commit be2ee4cc66
4 changed files with 23 additions and 6 deletions
+1 -1
View File
@@ -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) => (
<YourCustomComponent {...props} />
+14 -3
View File
@@ -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<string, any>;
onChange: (e: IChangeEvent) => void;
onReset: () => void;
onFinish?: () => Promise<void>;
widgets?: FormProps<any>['widgets'];
fields?: FormProps<any>['fields'];
finishButtonLabel?: string;
layouts: LayoutOptions[];
};
// @alpha
export type NextCustomFieldValidator<TFieldReturnValue> = (
@@ -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,
@@ -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';