@backstage/plugin-techdocs-react 1.2.7-next.1 → 1.2.8-next.0
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 +23 -0
- package/dist/hooks.esm.js +5 -5
- package/dist/hooks.esm.js.map +1 -1
- package/package.json +5 -5
package/CHANGELOG.md
CHANGED
|
@@ -1,5 +1,28 @@
|
|
|
1
1
|
# @backstage/plugin-techdocs-react
|
|
2
2
|
|
|
3
|
+
## 1.2.8-next.0
|
|
4
|
+
|
|
5
|
+
### Patch Changes
|
|
6
|
+
|
|
7
|
+
- 5ee3d27: Fixed issue in useShadowRootElements which could lead to unlimited render loops
|
|
8
|
+
- Updated dependencies
|
|
9
|
+
- @backstage/catalog-model@1.6.0
|
|
10
|
+
- @backstage/config@1.2.0
|
|
11
|
+
- @backstage/core-components@0.14.10
|
|
12
|
+
- @backstage/core-plugin-api@1.9.3
|
|
13
|
+
- @backstage/version-bridge@1.0.8
|
|
14
|
+
|
|
15
|
+
## 1.2.7
|
|
16
|
+
|
|
17
|
+
### Patch Changes
|
|
18
|
+
|
|
19
|
+
- Updated dependencies
|
|
20
|
+
- @backstage/core-components@0.14.10
|
|
21
|
+
- @backstage/catalog-model@1.6.0
|
|
22
|
+
- @backstage/config@1.2.0
|
|
23
|
+
- @backstage/core-plugin-api@1.9.3
|
|
24
|
+
- @backstage/version-bridge@1.0.8
|
|
25
|
+
|
|
3
26
|
## 1.2.7-next.1
|
|
4
27
|
|
|
5
28
|
### Patch Changes
|
package/dist/hooks.esm.js
CHANGED
|
@@ -8,12 +8,12 @@ const useShadowRoot = () => {
|
|
|
8
8
|
};
|
|
9
9
|
const useShadowRootElements = (selectors) => {
|
|
10
10
|
const shadowRoot = useShadowRoot();
|
|
11
|
-
const [
|
|
11
|
+
const [root, setRootNode] = useState(shadowRoot?.firstChild);
|
|
12
12
|
useEffect(() => {
|
|
13
13
|
let observer;
|
|
14
14
|
if (shadowRoot) {
|
|
15
15
|
observer = new MutationObserver(() => {
|
|
16
|
-
|
|
16
|
+
setRootNode(shadowRoot?.firstChild);
|
|
17
17
|
});
|
|
18
18
|
observer.observe(shadowRoot, {
|
|
19
19
|
attributes: true,
|
|
@@ -23,9 +23,9 @@ const useShadowRootElements = (selectors) => {
|
|
|
23
23
|
});
|
|
24
24
|
}
|
|
25
25
|
return () => observer?.disconnect();
|
|
26
|
-
}, [shadowRoot
|
|
27
|
-
if (!
|
|
28
|
-
return selectors.map((selector) =>
|
|
26
|
+
}, [shadowRoot]);
|
|
27
|
+
if (!root || !(root instanceof HTMLElement)) return [];
|
|
28
|
+
return selectors.map((selector) => root.querySelectorAll(selector)).filter((nodeList) => nodeList.length).map((nodeList) => Array.from(nodeList)).flat();
|
|
29
29
|
};
|
|
30
30
|
const isValidSelection = (newSelection) => {
|
|
31
31
|
return newSelection.toString() && newSelection.rangeCount && newSelection.getRangeAt(0).getBoundingClientRect().top;
|
package/dist/hooks.esm.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"hooks.esm.js","sources":["../src/hooks.ts"],"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 */\nimport { useEffect, useMemo, useState } from 'react';\nimport debounce from 'lodash/debounce';\nimport { useTechDocsReaderPage } from './context';\n\n/**\n * Hook for use within TechDocs addons that provides access to the underlying\n * shadow root of the current page, allowing the DOM within to be mutated.\n * @public\n */\nexport const useShadowRoot = () => {\n const { shadowRoot } = useTechDocsReaderPage();\n return shadowRoot;\n};\n\n/**\n * Convenience hook for use within TechDocs addons that provides access to\n * elements that match a given selector within the shadow root.\n *\n * @public\n */\nexport const useShadowRootElements = <\n TReturnedElement extends HTMLElement = HTMLElement,\n>(\n selectors: string[],\n): TReturnedElement[] => {\n const shadowRoot = useShadowRoot();\n const [
|
|
1
|
+
{"version":3,"file":"hooks.esm.js","sources":["../src/hooks.ts"],"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 */\nimport { useEffect, useMemo, useState } from 'react';\nimport debounce from 'lodash/debounce';\nimport { useTechDocsReaderPage } from './context';\n\n/**\n * Hook for use within TechDocs addons that provides access to the underlying\n * shadow root of the current page, allowing the DOM within to be mutated.\n * @public\n */\nexport const useShadowRoot = () => {\n const { shadowRoot } = useTechDocsReaderPage();\n return shadowRoot;\n};\n\n/**\n * Convenience hook for use within TechDocs addons that provides access to\n * elements that match a given selector within the shadow root.\n *\n * @public\n */\nexport const useShadowRootElements = <\n TReturnedElement extends HTMLElement = HTMLElement,\n>(\n selectors: string[],\n): TReturnedElement[] => {\n const shadowRoot = useShadowRoot();\n const [root, setRootNode] = useState(shadowRoot?.firstChild);\n\n useEffect(() => {\n let observer: MutationObserver;\n if (shadowRoot) {\n observer = new MutationObserver(() => {\n setRootNode(shadowRoot?.firstChild);\n });\n observer.observe(shadowRoot, {\n attributes: true,\n characterData: true,\n childList: true,\n subtree: true,\n });\n }\n return () => observer?.disconnect();\n }, [shadowRoot]);\n\n if (!root || !(root instanceof HTMLElement)) return [];\n\n return selectors\n .map(selector => root.querySelectorAll<TReturnedElement>(selector))\n .filter(nodeList => nodeList.length)\n .map(nodeList => Array.from(nodeList))\n .flat();\n};\n\nconst isValidSelection = (newSelection: Selection) => {\n // Safari sets the selection rect to top zero\n return (\n newSelection.toString() &&\n newSelection.rangeCount &&\n newSelection.getRangeAt(0).getBoundingClientRect().top\n );\n};\n\n/**\n * Hook for retrieving a selection within the ShadowRoot.\n * @public\n */\nexport const useShadowRootSelection = (waitMillis: number = 0) => {\n const shadowRoot = useShadowRoot();\n const [selection, setSelection] = useState<Selection | null>(null);\n const handleSelectionChange = useMemo(\n () =>\n debounce(() => {\n const shadowDocument = shadowRoot as ShadowRoot &\n Pick<Document, 'getSelection'>;\n // Firefox and Safari don't implement getSelection for Shadow DOM\n const newSelection = shadowDocument.getSelection\n ? shadowDocument.getSelection()\n : document.getSelection();\n\n if (newSelection && isValidSelection(newSelection)) {\n setSelection(newSelection);\n } else {\n setSelection(null);\n }\n }, waitMillis),\n [shadowRoot, setSelection, waitMillis],\n );\n\n useEffect(() => {\n window.document.addEventListener('selectionchange', handleSelectionChange);\n return () => {\n handleSelectionChange.cancel();\n window.document.removeEventListener(\n 'selectionchange',\n handleSelectionChange,\n );\n };\n }, [handleSelectionChange]);\n\n return selection;\n};\n"],"names":[],"mappings":";;;;AAwBO,MAAM,gBAAgB,MAAM;AACjC,EAAM,MAAA,EAAE,UAAW,EAAA,GAAI,qBAAsB,EAAA,CAAA;AAC7C,EAAO,OAAA,UAAA,CAAA;AACT,EAAA;AAQa,MAAA,qBAAA,GAAwB,CAGnC,SACuB,KAAA;AACvB,EAAA,MAAM,aAAa,aAAc,EAAA,CAAA;AACjC,EAAA,MAAM,CAAC,IAAM,EAAA,WAAW,CAAI,GAAA,QAAA,CAAS,YAAY,UAAU,CAAA,CAAA;AAE3D,EAAA,SAAA,CAAU,MAAM;AACd,IAAI,IAAA,QAAA,CAAA;AACJ,IAAA,IAAI,UAAY,EAAA;AACd,MAAW,QAAA,GAAA,IAAI,iBAAiB,MAAM;AACpC,QAAA,WAAA,CAAY,YAAY,UAAU,CAAA,CAAA;AAAA,OACnC,CAAA,CAAA;AACD,MAAA,QAAA,CAAS,QAAQ,UAAY,EAAA;AAAA,QAC3B,UAAY,EAAA,IAAA;AAAA,QACZ,aAAe,EAAA,IAAA;AAAA,QACf,SAAW,EAAA,IAAA;AAAA,QACX,OAAS,EAAA,IAAA;AAAA,OACV,CAAA,CAAA;AAAA,KACH;AACA,IAAO,OAAA,MAAM,UAAU,UAAW,EAAA,CAAA;AAAA,GACpC,EAAG,CAAC,UAAU,CAAC,CAAA,CAAA;AAEf,EAAA,IAAI,CAAC,IAAQ,IAAA,EAAE,IAAgB,YAAA,WAAA,CAAA,SAAqB,EAAC,CAAA;AAErD,EAAO,OAAA,SAAA,CACJ,IAAI,CAAY,QAAA,KAAA,IAAA,CAAK,iBAAmC,QAAQ,CAAC,EACjE,MAAO,CAAA,CAAA,QAAA,KAAY,SAAS,MAAM,CAAA,CAClC,IAAI,CAAY,QAAA,KAAA,KAAA,CAAM,KAAK,QAAQ,CAAC,EACpC,IAAK,EAAA,CAAA;AACV,EAAA;AAEA,MAAM,gBAAA,GAAmB,CAAC,YAA4B,KAAA;AAEpD,EACE,OAAA,YAAA,CAAa,QAAS,EAAA,IACtB,YAAa,CAAA,UAAA,IACb,aAAa,UAAW,CAAA,CAAC,CAAE,CAAA,qBAAA,EAAwB,CAAA,GAAA,CAAA;AAEvD,CAAA,CAAA;AAMa,MAAA,sBAAA,GAAyB,CAAC,UAAA,GAAqB,CAAM,KAAA;AAChE,EAAA,MAAM,aAAa,aAAc,EAAA,CAAA;AACjC,EAAA,MAAM,CAAC,SAAA,EAAW,YAAY,CAAA,GAAI,SAA2B,IAAI,CAAA,CAAA;AACjE,EAAA,MAAM,qBAAwB,GAAA,OAAA;AAAA,IAC5B,MACE,SAAS,MAAM;AACb,MAAA,MAAM,cAAiB,GAAA,UAAA,CAAA;AAGvB,MAAA,MAAM,eAAe,cAAe,CAAA,YAAA,GAChC,eAAe,YAAa,EAAA,GAC5B,SAAS,YAAa,EAAA,CAAA;AAE1B,MAAI,IAAA,YAAA,IAAgB,gBAAiB,CAAA,YAAY,CAAG,EAAA;AAClD,QAAA,YAAA,CAAa,YAAY,CAAA,CAAA;AAAA,OACpB,MAAA;AACL,QAAA,YAAA,CAAa,IAAI,CAAA,CAAA;AAAA,OACnB;AAAA,OACC,UAAU,CAAA;AAAA,IACf,CAAC,UAAY,EAAA,YAAA,EAAc,UAAU,CAAA;AAAA,GACvC,CAAA;AAEA,EAAA,SAAA,CAAU,MAAM;AACd,IAAO,MAAA,CAAA,QAAA,CAAS,gBAAiB,CAAA,iBAAA,EAAmB,qBAAqB,CAAA,CAAA;AACzE,IAAA,OAAO,MAAM;AACX,MAAA,qBAAA,CAAsB,MAAO,EAAA,CAAA;AAC7B,MAAA,MAAA,CAAO,QAAS,CAAA,mBAAA;AAAA,QACd,iBAAA;AAAA,QACA,qBAAA;AAAA,OACF,CAAA;AAAA,KACF,CAAA;AAAA,GACF,EAAG,CAAC,qBAAqB,CAAC,CAAA,CAAA;AAE1B,EAAO,OAAA,SAAA,CAAA;AACT;;;;"}
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@backstage/plugin-techdocs-react",
|
|
3
|
-
"version": "1.2.
|
|
3
|
+
"version": "1.2.8-next.0",
|
|
4
4
|
"description": "Shared frontend utilities for TechDocs and Addons",
|
|
5
5
|
"backstage": {
|
|
6
6
|
"role": "web-library",
|
|
@@ -45,9 +45,9 @@
|
|
|
45
45
|
"test": "backstage-cli package test"
|
|
46
46
|
},
|
|
47
47
|
"dependencies": {
|
|
48
|
-
"@backstage/catalog-model": "^1.6.0
|
|
48
|
+
"@backstage/catalog-model": "^1.6.0",
|
|
49
49
|
"@backstage/config": "^1.2.0",
|
|
50
|
-
"@backstage/core-components": "^0.14.10
|
|
50
|
+
"@backstage/core-components": "^0.14.10",
|
|
51
51
|
"@backstage/core-plugin-api": "^1.9.3",
|
|
52
52
|
"@backstage/version-bridge": "^1.0.8",
|
|
53
53
|
"@material-ui/core": "^4.12.2",
|
|
@@ -59,8 +59,8 @@
|
|
|
59
59
|
"react-use": "^17.2.4"
|
|
60
60
|
},
|
|
61
61
|
"devDependencies": {
|
|
62
|
-
"@backstage/cli": "^0.27.
|
|
63
|
-
"@backstage/test-utils": "^1.
|
|
62
|
+
"@backstage/cli": "^0.27.1-next.0",
|
|
63
|
+
"@backstage/test-utils": "^1.6.0-next.0",
|
|
64
64
|
"@backstage/theme": "^0.5.6",
|
|
65
65
|
"@testing-library/jest-dom": "^6.0.0",
|
|
66
66
|
"@testing-library/react": "^15.0.0"
|