@backstage/plugin-techdocs-react 1.3.16-next.1 → 1.3.16-next.2
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/CHANGELOG.md +9 -0
- package/dist/addons.esm.js +4 -3
- package/dist/addons.esm.js.map +1 -1
- package/dist/index.d.ts +6 -1
- package/package.json +3 -3
package/CHANGELOG.md
CHANGED
|
@@ -1,5 +1,14 @@
|
|
|
1
1
|
# @backstage/plugin-techdocs-react
|
|
2
2
|
|
|
3
|
+
## 1.3.16-next.2
|
|
4
|
+
|
|
5
|
+
### Patch Changes
|
|
6
|
+
|
|
7
|
+
- 450dd64: Isolated TechDocs addons in individual Suspense boundaries so that a lazy addon no longer hides the surrounding reader while it loads.
|
|
8
|
+
- Updated dependencies
|
|
9
|
+
- @backstage/core-components@0.18.15-next.2
|
|
10
|
+
- @backstage/plugin-techdocs-common@0.1.2-next.0
|
|
11
|
+
|
|
3
12
|
## 1.3.16-next.1
|
|
4
13
|
|
|
5
14
|
### Patch Changes
|
package/dist/addons.esm.js
CHANGED
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
import { jsx } from 'react/jsx-runtime';
|
|
2
|
-
import { useCallback } from 'react';
|
|
2
|
+
import { useCallback, Suspense } from 'react';
|
|
3
3
|
import { useOutlet } from 'react-router-dom';
|
|
4
4
|
import { attachComponentData, createReactExtension, useElementFilter } from '@backstage/core-plugin-api';
|
|
5
5
|
|
|
@@ -55,14 +55,15 @@ const useTechDocsAddons = () => {
|
|
|
55
55
|
const renderComponentByName = useCallback(
|
|
56
56
|
(name) => {
|
|
57
57
|
const data = options.find((option) => option.name === name);
|
|
58
|
-
|
|
58
|
+
const addon = data ? findAddonByData(data) : null;
|
|
59
|
+
return addon ? /* @__PURE__ */ jsx(Suspense, { fallback: null, children: addon }) : null;
|
|
59
60
|
},
|
|
60
61
|
[options, findAddonByData]
|
|
61
62
|
);
|
|
62
63
|
const renderComponentsByLocation = useCallback(
|
|
63
64
|
(location) => {
|
|
64
65
|
const data = options.filter((option) => option.location === location);
|
|
65
|
-
return data.length ? data.map(findAddonByData) : null;
|
|
66
|
+
return data.length ? data.map((option) => /* @__PURE__ */ jsx(Suspense, { fallback: null, children: findAddonByData(option) }, option.name)) : null;
|
|
66
67
|
},
|
|
67
68
|
[options, findAddonByData]
|
|
68
69
|
);
|
package/dist/addons.esm.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"addons.esm.js","sources":["../src/addons.tsx"],"sourcesContent":["/*\n * Copyright 2022 The Backstage Authors\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n * http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\n\nimport { PropsWithChildren, ComponentType, useCallback } from 'react';\nimport { useOutlet } from 'react-router-dom';\n\nimport {\n attachComponentData,\n createReactExtension,\n ElementCollection,\n Extension,\n useElementFilter,\n} from '@backstage/core-plugin-api';\n\nimport { TechDocsAddonLocations, TechDocsAddonOptions } from './types';\n\n/**\n * Key for each addon.\n * @public\n */\nexport const TECHDOCS_ADDONS_KEY = 'techdocs.addons.addon.v1';\n\n/**\n * Marks the `<TechDocsAddons>` registry component.\n * @public\n */\nexport const TECHDOCS_ADDONS_WRAPPER_KEY = 'techdocs.addons.wrapper.v1';\n\n/**\n * TechDocs Addon registry.\n * @public\n */\nexport const TechDocsAddons: ComponentType<PropsWithChildren<{}>> = () => null;\n\nattachComponentData(TechDocsAddons, TECHDOCS_ADDONS_WRAPPER_KEY, true);\n\nexport const getDataKeyByName = (name: string) => {\n return `${TECHDOCS_ADDONS_KEY}.${name.toLowerCase()}`;\n};\n\n/**\n * Create a TechDocs addon overload signature without props.\n * @public\n */\nexport function createTechDocsAddonExtension(\n options: TechDocsAddonOptions,\n): Extension<() => JSX.Element | null>;\n\n/**\n * Create a TechDocs addon overload signature with props.\n * @public\n */\nexport function createTechDocsAddonExtension<TComponentProps>(\n options: TechDocsAddonOptions<TComponentProps>,\n): Extension<(props: TComponentProps) => JSX.Element | null>;\n\n/**\n * Create a TechDocs addon implementation.\n * @public\n */\nexport function createTechDocsAddonExtension<\n TComponentProps extends PropsWithChildren<{}>,\n>(\n options: TechDocsAddonOptions<TComponentProps>,\n): Extension<(props: TComponentProps) => JSX.Element | null> {\n const { name, component: TechDocsAddon } = options;\n return createReactExtension({\n name,\n component: {\n sync: (props: TComponentProps) => <TechDocsAddon {...props} />,\n },\n data: {\n [TECHDOCS_ADDONS_KEY]: options,\n [getDataKeyByName(name)]: true,\n },\n });\n}\n\nconst getTechDocsAddonByName = (\n collection: ElementCollection,\n key: string,\n): JSX.Element | undefined => {\n return collection.selectByComponentData({ key }).getElements()[0];\n};\n\nconst getAllTechDocsAddons = (collection: ElementCollection) => {\n return collection\n .selectByComponentData({\n key: TECHDOCS_ADDONS_WRAPPER_KEY,\n })\n .selectByComponentData({\n key: TECHDOCS_ADDONS_KEY,\n });\n};\n\nconst getAllTechDocsAddonsData = (collection: ElementCollection) => {\n return collection\n .selectByComponentData({\n key: TECHDOCS_ADDONS_WRAPPER_KEY,\n })\n .findComponentData<TechDocsAddonOptions>({\n key: TECHDOCS_ADDONS_KEY,\n });\n};\n\n/**\n *
|
|
1
|
+
{"version":3,"file":"addons.esm.js","sources":["../src/addons.tsx"],"sourcesContent":["/*\n * Copyright 2022 The Backstage Authors\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n * http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\n\nimport { PropsWithChildren, ComponentType, Suspense, useCallback } from 'react';\nimport { useOutlet } from 'react-router-dom';\n\nimport {\n attachComponentData,\n createReactExtension,\n ElementCollection,\n Extension,\n useElementFilter,\n} from '@backstage/core-plugin-api';\n\nimport { TechDocsAddonLocations, TechDocsAddonOptions } from './types';\n\n/**\n * Key for each addon.\n * @public\n */\nexport const TECHDOCS_ADDONS_KEY = 'techdocs.addons.addon.v1';\n\n/**\n * Marks the `<TechDocsAddons>` registry component.\n * @public\n */\nexport const TECHDOCS_ADDONS_WRAPPER_KEY = 'techdocs.addons.wrapper.v1';\n\n/**\n * TechDocs Addon registry.\n * @public\n */\nexport const TechDocsAddons: ComponentType<PropsWithChildren<{}>> = () => null;\n\nattachComponentData(TechDocsAddons, TECHDOCS_ADDONS_WRAPPER_KEY, true);\n\nexport const getDataKeyByName = (name: string) => {\n return `${TECHDOCS_ADDONS_KEY}.${name.toLowerCase()}`;\n};\n\n/**\n * Create a TechDocs addon overload signature without props.\n * @public\n */\nexport function createTechDocsAddonExtension(\n options: TechDocsAddonOptions,\n): Extension<() => JSX.Element | null>;\n\n/**\n * Create a TechDocs addon overload signature with props.\n * @public\n */\nexport function createTechDocsAddonExtension<TComponentProps>(\n options: TechDocsAddonOptions<TComponentProps>,\n): Extension<(props: TComponentProps) => JSX.Element | null>;\n\n/**\n * Create a TechDocs addon implementation.\n * @public\n */\nexport function createTechDocsAddonExtension<\n TComponentProps extends PropsWithChildren<{}>,\n>(\n options: TechDocsAddonOptions<TComponentProps>,\n): Extension<(props: TComponentProps) => JSX.Element | null> {\n const { name, component: TechDocsAddon } = options;\n return createReactExtension({\n name,\n component: {\n sync: (props: TComponentProps) => <TechDocsAddon {...props} />,\n },\n data: {\n [TECHDOCS_ADDONS_KEY]: options,\n [getDataKeyByName(name)]: true,\n },\n });\n}\n\nconst getTechDocsAddonByName = (\n collection: ElementCollection,\n key: string,\n): JSX.Element | undefined => {\n return collection.selectByComponentData({ key }).getElements()[0];\n};\n\nconst getAllTechDocsAddons = (collection: ElementCollection) => {\n return collection\n .selectByComponentData({\n key: TECHDOCS_ADDONS_WRAPPER_KEY,\n })\n .selectByComponentData({\n key: TECHDOCS_ADDONS_KEY,\n });\n};\n\nconst getAllTechDocsAddonsData = (collection: ElementCollection) => {\n return collection\n .selectByComponentData({\n key: TECHDOCS_ADDONS_WRAPPER_KEY,\n })\n .findComponentData<TechDocsAddonOptions>({\n key: TECHDOCS_ADDONS_KEY,\n });\n};\n\n/**\n * Hook to use addons in components.\n *\n * Addons rendered through this hook are isolated in individual Suspense\n * boundaries with no fallback, so a suspended addon does not hide the reader\n * or sibling addons while it loads.\n *\n * @public\n */\nexport const useTechDocsAddons = () => {\n const node = useOutlet();\n const collection = useElementFilter(node, getAllTechDocsAddons);\n const options = useElementFilter(node, getAllTechDocsAddonsData);\n\n const findAddonByData = useCallback(\n (data: TechDocsAddonOptions | undefined) => {\n if (!collection || !data) return null;\n const nameKey = getDataKeyByName(data.name);\n return getTechDocsAddonByName(collection, nameKey) ?? null;\n },\n [collection],\n );\n\n const renderComponentByName = useCallback(\n (name: string): JSX.Element | null => {\n const data = options.find(option => option.name === name);\n const addon = data ? findAddonByData(data) : null;\n return addon ? <Suspense fallback={null}>{addon}</Suspense> : null;\n },\n [options, findAddonByData],\n );\n\n const renderComponentsByLocation = useCallback(\n (\n location: keyof typeof TechDocsAddonLocations,\n ): (JSX.Element | null)[] | null => {\n const data = options.filter(option => option.location === location);\n return data.length\n ? data.map(option => (\n <Suspense key={option.name} fallback={null}>\n {findAddonByData(option)}\n </Suspense>\n ))\n : null;\n },\n [options, findAddonByData],\n );\n\n return { renderComponentByName, renderComponentsByLocation };\n};\n"],"names":[],"mappings":";;;;;AAiCO,MAAM,mBAAA,GAAsB;AAM5B,MAAM,2BAAA,GAA8B;AAMpC,MAAM,iBAAuD,MAAM;AAE1E,mBAAA,CAAoB,cAAA,EAAgB,6BAA6B,IAAI,CAAA;AAE9D,MAAM,gBAAA,GAAmB,CAAC,IAAA,KAAiB;AAChD,EAAA,OAAO,CAAA,EAAG,mBAAmB,CAAA,CAAA,EAAI,IAAA,CAAK,aAAa,CAAA,CAAA;AACrD;AAsBO,SAAS,6BAGd,OAAA,EAC2D;AAC3D,EAAA,MAAM,EAAE,IAAA,EAAM,SAAA,EAAW,aAAA,EAAc,GAAI,OAAA;AAC3C,EAAA,OAAO,oBAAA,CAAqB;AAAA,IAC1B,IAAA;AAAA,IACA,SAAA,EAAW;AAAA,MACT,MAAM,CAAC,KAAA,qBAA2B,GAAA,CAAC,aAAA,EAAA,EAAe,GAAG,KAAA,EAAO;AAAA,KAC9D;AAAA,IACA,IAAA,EAAM;AAAA,MACJ,CAAC,mBAAmB,GAAG,OAAA;AAAA,MACvB,CAAC,gBAAA,CAAiB,IAAI,CAAC,GAAG;AAAA;AAC5B,GACD,CAAA;AACH;AAEA,MAAM,sBAAA,GAAyB,CAC7B,UAAA,EACA,GAAA,KAC4B;AAC5B,EAAA,OAAO,UAAA,CAAW,sBAAsB,EAAE,GAAA,EAAK,CAAA,CAAE,WAAA,GAAc,CAAC,CAAA;AAClE,CAAA;AAEA,MAAM,oBAAA,GAAuB,CAAC,UAAA,KAAkC;AAC9D,EAAA,OAAO,WACJ,qBAAA,CAAsB;AAAA,IACrB,GAAA,EAAK;AAAA,GACN,EACA,qBAAA,CAAsB;AAAA,IACrB,GAAA,EAAK;AAAA,GACN,CAAA;AACL,CAAA;AAEA,MAAM,wBAAA,GAA2B,CAAC,UAAA,KAAkC;AAClE,EAAA,OAAO,WACJ,qBAAA,CAAsB;AAAA,IACrB,GAAA,EAAK;AAAA,GACN,EACA,iBAAA,CAAwC;AAAA,IACvC,GAAA,EAAK;AAAA,GACN,CAAA;AACL,CAAA;AAWO,MAAM,oBAAoB,MAAM;AACrC,EAAA,MAAM,OAAO,SAAA,EAAU;AACvB,EAAA,MAAM,UAAA,GAAa,gBAAA,CAAiB,IAAA,EAAM,oBAAoB,CAAA;AAC9D,EAAA,MAAM,OAAA,GAAU,gBAAA,CAAiB,IAAA,EAAM,wBAAwB,CAAA;AAE/D,EAAA,MAAM,eAAA,GAAkB,WAAA;AAAA,IACtB,CAAC,IAAA,KAA2C;AAC1C,MAAA,IAAI,CAAC,UAAA,IAAc,CAAC,IAAA,EAAM,OAAO,IAAA;AACjC,MAAA,MAAM,OAAA,GAAU,gBAAA,CAAiB,IAAA,CAAK,IAAI,CAAA;AAC1C,MAAA,OAAO,sBAAA,CAAuB,UAAA,EAAY,OAAO,CAAA,IAAK,IAAA;AAAA,IACxD,CAAA;AAAA,IACA,CAAC,UAAU;AAAA,GACb;AAEA,EAAA,MAAM,qBAAA,GAAwB,WAAA;AAAA,IAC5B,CAAC,IAAA,KAAqC;AACpC,MAAA,MAAM,OAAO,OAAA,CAAQ,IAAA,CAAK,CAAA,MAAA,KAAU,MAAA,CAAO,SAAS,IAAI,CAAA;AACxD,MAAA,MAAM,KAAA,GAAQ,IAAA,GAAO,eAAA,CAAgB,IAAI,CAAA,GAAI,IAAA;AAC7C,MAAA,OAAO,wBAAQ,GAAA,CAAC,QAAA,EAAA,EAAS,QAAA,EAAU,IAAA,EAAO,iBAAM,CAAA,GAAc,IAAA;AAAA,IAChE,CAAA;AAAA,IACA,CAAC,SAAS,eAAe;AAAA,GAC3B;AAEA,EAAA,MAAM,0BAAA,GAA6B,WAAA;AAAA,IACjC,CACE,QAAA,KACkC;AAClC,MAAA,MAAM,OAAO,OAAA,CAAQ,MAAA,CAAO,CAAA,MAAA,KAAU,MAAA,CAAO,aAAa,QAAQ,CAAA;AAClE,MAAA,OAAO,IAAA,CAAK,MAAA,GACR,IAAA,CAAK,GAAA,CAAI,4BACP,GAAA,CAAC,QAAA,EAAA,EAA2B,QAAA,EAAU,IAAA,EACnC,0BAAgB,MAAM,CAAA,EAAA,EADV,MAAA,CAAO,IAEtB,CACD,CAAA,GACD,IAAA;AAAA,IACN,CAAA;AAAA,IACA,CAAC,SAAS,eAAe;AAAA,GAC3B;AAEA,EAAA,OAAO,EAAE,uBAAuB,0BAAA,EAA2B;AAC7D;;"}
|
package/dist/index.d.ts
CHANGED
|
@@ -34,7 +34,12 @@ declare function createTechDocsAddonExtension(options: TechDocsAddonOptions): Ex
|
|
|
34
34
|
*/
|
|
35
35
|
declare function createTechDocsAddonExtension<TComponentProps>(options: TechDocsAddonOptions<TComponentProps>): Extension<(props: TComponentProps) => JSX.Element | null>;
|
|
36
36
|
/**
|
|
37
|
-
*
|
|
37
|
+
* Hook to use addons in components.
|
|
38
|
+
*
|
|
39
|
+
* Addons rendered through this hook are isolated in individual Suspense
|
|
40
|
+
* boundaries with no fallback, so a suspended addon does not hide the reader
|
|
41
|
+
* or sibling addons while it loads.
|
|
42
|
+
*
|
|
38
43
|
* @public
|
|
39
44
|
*/
|
|
40
45
|
declare const useTechDocsAddons: () => {
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@backstage/plugin-techdocs-react",
|
|
3
|
-
"version": "1.3.16-next.
|
|
3
|
+
"version": "1.3.16-next.2",
|
|
4
4
|
"description": "Shared frontend utilities for TechDocs and Addons",
|
|
5
5
|
"backstage": {
|
|
6
6
|
"role": "web-library",
|
|
@@ -68,10 +68,10 @@
|
|
|
68
68
|
"dependencies": {
|
|
69
69
|
"@backstage/catalog-model": "1.10.2-next.0",
|
|
70
70
|
"@backstage/config": "1.3.10-next.0",
|
|
71
|
-
"@backstage/core-components": "0.18.15-next.
|
|
71
|
+
"@backstage/core-components": "0.18.15-next.2",
|
|
72
72
|
"@backstage/core-plugin-api": "1.12.11-next.0",
|
|
73
73
|
"@backstage/frontend-plugin-api": "0.18.2-next.0",
|
|
74
|
-
"@backstage/plugin-techdocs-common": "0.1.
|
|
74
|
+
"@backstage/plugin-techdocs-common": "0.1.2-next.0",
|
|
75
75
|
"@backstage/version-bridge": "1.0.12",
|
|
76
76
|
"@material-ui/core": "^4.12.2",
|
|
77
77
|
"@material-ui/styles": "^4.11.0",
|