chore: some more deprecations for the scaffolder

Signed-off-by: blam <ben@blam.sh>
This commit is contained in:
blam
2022-02-25 10:48:57 +01:00
parent 52eeb35d71
commit 4618350aa8
4 changed files with 11 additions and 3 deletions
+2
View File
@@ -5,7 +5,9 @@
Added some deprecations as follows:
- **DEPRECATED**: `TemplateCardComponent` and `TaskPageComponent` props have been deprecated, and moved to a `components` prop instead. You can pass them in through there instead.
- **DEPRECATED**: `TemplateList` and `TemplateListProps` has been deprecated. Please use the `TemplateCard` to create your own list component instead.
Other notable changes:
- `scaffolderApi.scaffold()` `values` type has been narrowed from `Record<string, any>` to `Record<string, JsonValue>` instead.
- Moved all navigation internally over to using `routeRefs` and `subRouteRefs`
+2 -2
View File
@@ -427,7 +427,7 @@ export type TaskPageProps = {
// 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)
// @public @deprecated (undocumented)
export const TemplateList: ({
TemplateCardComponent,
group,
@@ -435,7 +435,7 @@ export const TemplateList: ({
// Warning: (ae-missing-release-tag) "TemplateListProps" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal)
//
// @public (undocumented)
// @public @deprecated (undocumented)
export type TemplateListProps = {
TemplateCardComponent?:
| ComponentType<{
@@ -29,6 +29,9 @@ import { useEntityList } from '@backstage/plugin-catalog-react';
import { Typography } from '@material-ui/core';
import { TemplateCard } from '../TemplateCard';
/**
* @deprecated this type is deprecated and will be removed in a future releases, please use the TemplateCard to render your own list.
*/
export type TemplateListProps = {
TemplateCardComponent?:
| ComponentType<{ template: TemplateEntityV1beta2 }>
@@ -40,6 +43,9 @@ export type TemplateListProps = {
};
};
/**
* @deprecated this component is deprecated and will be removed in a future releases, please use the TemplateCard to render your own list.
*/
export const TemplateList = ({
TemplateCardComponent,
group,
@@ -18,7 +18,7 @@ import { LinearProgress } from '@material-ui/core';
import { FormValidation, IChangeEvent } from '@rjsf/core';
import qs from 'qs';
import React, { useCallback, useContext, useState } from 'react';
import { generatePath, Navigate, useNavigate } from 'react-router';
import { Navigate, useNavigate } from 'react-router';
import { useParams } from 'react-router-dom';
import useAsync from 'react-use/lib/useAsync';
import { scaffolderApiRef } from '../../api';