deprecate scaffolder layout components

Signed-off-by: Paul Cowan <paul.cowan@cutting.scot>
This commit is contained in:
Paul Cowan
2023-01-11 17:56:40 +00:00
parent 20072808c1
commit 969b9ae616
18 changed files with 87 additions and 156 deletions
+11
View File
@@ -65,6 +65,11 @@ export function createScaffolderFieldExtension<
options: FieldExtensionOptions<TReturnValue, TInputProps>,
): Extension<FieldExtensionComponent<TReturnValue, TInputProps>>;
// @public
export function createScaffolderLayout<TInputProps = unknown>(
options: LayoutOptions,
): Extension<LayoutComponent<TInputProps>>;
// @public
export type CustomFieldExtensionSchema = {
returnValue: JSONSchema7;
@@ -122,6 +127,9 @@ export type FormProps = Pick<
'transformErrors' | 'noHtml5Validate'
>;
// @public
export type LayoutComponent<_TInputProps> = () => null;
// @public
export interface LayoutOptions<P = any> {
// (undocumented)
@@ -289,6 +297,9 @@ export interface ScaffolderGetIntegrationsListResponse {
}[];
}
// @public
export const ScaffolderLayouts: React.ComponentType;
// @public (undocumented)
export type ScaffolderOutputLink = {
title?: string;
@@ -25,7 +25,8 @@ import { Extension, attachComponentData } from '@backstage/core-plugin-api';
import { FIELD_EXTENSION_KEY, FIELD_EXTENSION_WRAPPER_KEY } from './keys';
/**
* A type used to wrap up the FieldExtension to embed the ReturnValue and the InputProps
* The type used to wrap up the Layout and embed the input props
*
* @public
*/
export type FieldExtensionComponent<_TReturnValue, _TInputProps> = () => null;
@@ -15,6 +15,7 @@
*/
export * from './components';
export * from './extensions';
export * from './layouts';
export * from './types';
export * from './lib';
export * from './hooks';
@@ -18,6 +18,10 @@ import { LAYOUTS_KEY, LAYOUTS_WRAPPER_KEY } from './keys';
*/
import { attachComponentData, Extension } from '@backstage/core-plugin-api';
/**
* A type used to wrap up the FieldExtension to embed the ReturnValue and the InputProps
* @public
*/
export type LayoutComponent<_TInputProps> = () => null;
/**