@backstage/plugin-techdocs 0.0.0-nightly-20250429023924 → 0.0.0-nightly-20250501024241
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
CHANGED
|
@@ -1,28 +1,54 @@
|
|
|
1
1
|
# @backstage/plugin-techdocs
|
|
2
2
|
|
|
3
|
-
## 0.0.0-nightly-
|
|
3
|
+
## 0.0.0-nightly-20250501024241
|
|
4
|
+
|
|
5
|
+
### Patch Changes
|
|
6
|
+
|
|
7
|
+
- fb58f20: Internal update to use the new `pluginId` option of `createFrontendPlugin`.
|
|
8
|
+
- 72d019d: Removed various typos
|
|
9
|
+
- 2ffd273: Add hover and focus styling to the "copy to clipboard" button within codeblocks in techdocs. Also added an aria-label to the button for accessibility.
|
|
10
|
+
- Updated dependencies
|
|
11
|
+
- @backstage/theme@0.0.0-nightly-20250501024241
|
|
12
|
+
- @backstage/integration@0.0.0-nightly-20250501024241
|
|
13
|
+
- @backstage/core-components@0.0.0-nightly-20250501024241
|
|
14
|
+
- @backstage/frontend-plugin-api@0.0.0-nightly-20250501024241
|
|
15
|
+
- @backstage/core-compat-api@0.0.0-nightly-20250501024241
|
|
16
|
+
- @backstage/plugin-search-react@0.0.0-nightly-20250501024241
|
|
17
|
+
- @backstage/plugin-catalog-react@0.0.0-nightly-20250501024241
|
|
18
|
+
- @backstage/plugin-techdocs-react@0.0.0-nightly-20250501024241
|
|
19
|
+
- @backstage/plugin-auth-react@0.0.0-nightly-20250501024241
|
|
20
|
+
- @backstage/catalog-client@0.0.0-nightly-20250501024241
|
|
21
|
+
- @backstage/integration-react@0.0.0-nightly-20250501024241
|
|
22
|
+
- @backstage/catalog-model@1.7.3
|
|
23
|
+
- @backstage/config@1.3.2
|
|
24
|
+
- @backstage/core-plugin-api@1.10.6
|
|
25
|
+
- @backstage/errors@1.2.7
|
|
26
|
+
- @backstage/plugin-search-common@0.0.0-nightly-20250501024241
|
|
27
|
+
- @backstage/plugin-techdocs-common@0.1.0
|
|
28
|
+
|
|
29
|
+
## 1.12.6-next.1
|
|
4
30
|
|
|
5
31
|
### Patch Changes
|
|
6
32
|
|
|
7
33
|
- fb58f20: Internal update to use the new `pluginId` option of `createFrontendPlugin`.
|
|
8
34
|
- 72d019d: Removed various typos
|
|
9
35
|
- Updated dependencies
|
|
10
|
-
- @backstage/
|
|
11
|
-
- @backstage/
|
|
12
|
-
- @backstage/
|
|
13
|
-
- @backstage/
|
|
14
|
-
- @backstage/
|
|
15
|
-
- @backstage/
|
|
16
|
-
- @backstage/plugin-
|
|
17
|
-
- @backstage/plugin-
|
|
18
|
-
- @backstage/
|
|
19
|
-
- @backstage/integration-react@
|
|
36
|
+
- @backstage/theme@0.6.6-next.0
|
|
37
|
+
- @backstage/core-components@0.17.2-next.0
|
|
38
|
+
- @backstage/frontend-plugin-api@0.10.2-next.0
|
|
39
|
+
- @backstage/core-compat-api@0.4.2-next.1
|
|
40
|
+
- @backstage/integration@1.16.4-next.1
|
|
41
|
+
- @backstage/plugin-search-react@1.9.0-next.0
|
|
42
|
+
- @backstage/plugin-catalog-react@1.18.0-next.1
|
|
43
|
+
- @backstage/plugin-techdocs-react@1.2.17-next.0
|
|
44
|
+
- @backstage/plugin-auth-react@0.1.15-next.0
|
|
45
|
+
- @backstage/integration-react@1.2.7-next.1
|
|
46
|
+
- @backstage/catalog-client@1.10.0-next.0
|
|
20
47
|
- @backstage/catalog-model@1.7.3
|
|
21
48
|
- @backstage/config@1.3.2
|
|
22
49
|
- @backstage/core-plugin-api@1.10.6
|
|
23
50
|
- @backstage/errors@1.2.7
|
|
24
|
-
- @backstage/
|
|
25
|
-
- @backstage/plugin-search-common@0.0.0-nightly-20250429023924
|
|
51
|
+
- @backstage/plugin-search-common@1.2.18-next.0
|
|
26
52
|
- @backstage/plugin-techdocs-common@0.1.0
|
|
27
53
|
|
|
28
54
|
## 1.12.6-next.0
|
|
@@ -39,9 +39,10 @@ const CopyToClipboardButton = ({ text }) => {
|
|
|
39
39
|
children: /* @__PURE__ */ jsx(
|
|
40
40
|
IconButton,
|
|
41
41
|
{
|
|
42
|
-
style: {
|
|
42
|
+
style: { position: "absolute" },
|
|
43
43
|
className: "md-clipboard md-icon",
|
|
44
44
|
onClick: handleClick,
|
|
45
|
+
"aria-label": "Copy to clipboard",
|
|
45
46
|
children: /* @__PURE__ */ jsx(CopyToClipboardIcon, {})
|
|
46
47
|
}
|
|
47
48
|
)
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"copyToClipboard.esm.js","sources":["../../../src/reader/transformers/copyToClipboard.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 { useState, useCallback } from 'react';\nimport { renderReactElement } from './renderReactElement';\nimport { ThemeProvider } from '@material-ui/core/styles';\nimport SvgIcon from '@material-ui/core/SvgIcon';\nimport Tooltip from '@material-ui/core/Tooltip';\nimport { withStyles, Theme } from '@material-ui/core/styles';\nimport IconButton from '@material-ui/core/IconButton';\nimport type { Transformer } from './transformer';\nimport useCopyToClipboard from 'react-use/esm/useCopyToClipboard';\n\nconst CopyToClipboardTooltip = withStyles(theme => ({\n tooltip: {\n fontSize: 'inherit',\n color: theme.palette.text.primary,\n margin: 0,\n padding: theme.spacing(0.5),\n backgroundColor: 'transparent',\n boxShadow: 'none',\n },\n}))(Tooltip);\n\nconst CopyToClipboardIcon = () => (\n <SvgIcon>\n <path d=\"M16 1H4c-1.1 0-2 .9-2 2v14h2V3h12V1zm3 4H8c-1.1 0-2 .9-2 2v14c0 1.1.9 2 2 2h11c1.1 0 2-.9 2-2V7c0-1.1-.9-2-2-2zm0 16H8V7h11v14z\" />\n </SvgIcon>\n);\n\ntype CopyToClipboardButtonProps = {\n text: string;\n};\n\nconst CopyToClipboardButton = ({ text }: CopyToClipboardButtonProps) => {\n const [open, setOpen] = useState(false);\n const [, copyToClipboard] = useCopyToClipboard();\n\n const handleClick = useCallback(() => {\n copyToClipboard(text);\n setOpen(true);\n }, [text, copyToClipboard]);\n\n const handleClose = useCallback(() => {\n setOpen(false);\n }, [setOpen]);\n\n return (\n <CopyToClipboardTooltip\n title=\"Copied to clipboard\"\n placement=\"left\"\n open={open}\n onClose={handleClose}\n leaveDelay={1000}\n >\n <IconButton\n style={{
|
|
1
|
+
{"version":3,"file":"copyToClipboard.esm.js","sources":["../../../src/reader/transformers/copyToClipboard.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 { useState, useCallback } from 'react';\nimport { renderReactElement } from './renderReactElement';\nimport { ThemeProvider } from '@material-ui/core/styles';\nimport SvgIcon from '@material-ui/core/SvgIcon';\nimport Tooltip from '@material-ui/core/Tooltip';\nimport { withStyles, Theme } from '@material-ui/core/styles';\nimport IconButton from '@material-ui/core/IconButton';\nimport type { Transformer } from './transformer';\nimport useCopyToClipboard from 'react-use/esm/useCopyToClipboard';\n\nconst CopyToClipboardTooltip = withStyles(theme => ({\n tooltip: {\n fontSize: 'inherit',\n color: theme.palette.text.primary,\n margin: 0,\n padding: theme.spacing(0.5),\n backgroundColor: 'transparent',\n boxShadow: 'none',\n },\n}))(Tooltip);\n\nconst CopyToClipboardIcon = () => (\n <SvgIcon>\n <path d=\"M16 1H4c-1.1 0-2 .9-2 2v14h2V3h12V1zm3 4H8c-1.1 0-2 .9-2 2v14c0 1.1.9 2 2 2h11c1.1 0 2-.9 2-2V7c0-1.1-.9-2-2-2zm0 16H8V7h11v14z\" />\n </SvgIcon>\n);\n\ntype CopyToClipboardButtonProps = {\n text: string;\n};\n\nconst CopyToClipboardButton = ({ text }: CopyToClipboardButtonProps) => {\n const [open, setOpen] = useState(false);\n const [, copyToClipboard] = useCopyToClipboard();\n\n const handleClick = useCallback(() => {\n copyToClipboard(text);\n setOpen(true);\n }, [text, copyToClipboard]);\n\n const handleClose = useCallback(() => {\n setOpen(false);\n }, [setOpen]);\n\n return (\n <CopyToClipboardTooltip\n title=\"Copied to clipboard\"\n placement=\"left\"\n open={open}\n onClose={handleClose}\n leaveDelay={1000}\n >\n <IconButton\n style={{ position: 'absolute' }}\n className=\"md-clipboard md-icon\"\n onClick={handleClick}\n aria-label=\"Copy to clipboard\"\n >\n <CopyToClipboardIcon />\n </IconButton>\n </CopyToClipboardTooltip>\n );\n};\n\n/**\n * Recreates copy-to-clipboard functionality attached to <code> snippets that\n * is native to mkdocs-material theme.\n */\nexport const copyToClipboard = (theme: Theme): Transformer => {\n return dom => {\n const codes = dom.querySelectorAll('pre > code');\n for (const code of codes) {\n const text = code.textContent || '';\n const container = document.createElement('div');\n code?.parentElement?.prepend(container);\n renderReactElement(\n <ThemeProvider theme={theme}>\n <CopyToClipboardButton text={text} />\n </ThemeProvider>,\n container,\n );\n }\n return dom;\n };\n};\n"],"names":["copyToClipboard"],"mappings":";;;;;;;;;AA0BA,MAAM,sBAAA,GAAyB,WAAW,CAAU,KAAA,MAAA;AAAA,EAClD,OAAS,EAAA;AAAA,IACP,QAAU,EAAA,SAAA;AAAA,IACV,KAAA,EAAO,KAAM,CAAA,OAAA,CAAQ,IAAK,CAAA,OAAA;AAAA,IAC1B,MAAQ,EAAA,CAAA;AAAA,IACR,OAAA,EAAS,KAAM,CAAA,OAAA,CAAQ,GAAG,CAAA;AAAA,IAC1B,eAAiB,EAAA,aAAA;AAAA,IACjB,SAAW,EAAA;AAAA;AAEf,CAAA,CAAE,EAAE,OAAO,CAAA;AAEX,MAAM,mBAAA,GAAsB,sBACzB,GAAA,CAAA,OAAA,EAAA,EACC,8BAAC,MAAK,EAAA,EAAA,CAAA,EAAE,mIAAkI,CAC5I,EAAA,CAAA;AAOF,MAAM,qBAAwB,GAAA,CAAC,EAAE,IAAA,EAAuC,KAAA;AACtE,EAAA,MAAM,CAAC,IAAA,EAAM,OAAO,CAAA,GAAI,SAAS,KAAK,CAAA;AACtC,EAAA,MAAM,GAAGA,gBAAe,CAAA,GAAI,kBAAmB,EAAA;AAE/C,EAAM,MAAA,WAAA,GAAc,YAAY,MAAM;AACpC,IAAAA,iBAAgB,IAAI,CAAA;AACpB,IAAA,OAAA,CAAQ,IAAI,CAAA;AAAA,GACX,EAAA,CAAC,IAAMA,EAAAA,gBAAe,CAAC,CAAA;AAE1B,EAAM,MAAA,WAAA,GAAc,YAAY,MAAM;AACpC,IAAA,OAAA,CAAQ,KAAK,CAAA;AAAA,GACf,EAAG,CAAC,OAAO,CAAC,CAAA;AAEZ,EACE,uBAAA,GAAA;AAAA,IAAC,sBAAA;AAAA,IAAA;AAAA,MACC,KAAM,EAAA,qBAAA;AAAA,MACN,SAAU,EAAA,MAAA;AAAA,MACV,IAAA;AAAA,MACA,OAAS,EAAA,WAAA;AAAA,MACT,UAAY,EAAA,GAAA;AAAA,MAEZ,QAAA,kBAAA,GAAA;AAAA,QAAC,UAAA;AAAA,QAAA;AAAA,UACC,KAAA,EAAO,EAAE,QAAA,EAAU,UAAW,EAAA;AAAA,UAC9B,SAAU,EAAA,sBAAA;AAAA,UACV,OAAS,EAAA,WAAA;AAAA,UACT,YAAW,EAAA,mBAAA;AAAA,UAEX,8BAAC,mBAAoB,EAAA,EAAA;AAAA;AAAA;AACvB;AAAA,GACF;AAEJ,CAAA;AAMa,MAAA,eAAA,GAAkB,CAAC,KAA8B,KAAA;AAC5D,EAAA,OAAO,CAAO,GAAA,KAAA;AACZ,IAAM,MAAA,KAAA,GAAQ,GAAI,CAAA,gBAAA,CAAiB,YAAY,CAAA;AAC/C,IAAA,KAAA,MAAW,QAAQ,KAAO,EAAA;AACxB,MAAM,MAAA,IAAA,GAAO,KAAK,WAAe,IAAA,EAAA;AACjC,MAAM,MAAA,SAAA,GAAY,QAAS,CAAA,aAAA,CAAc,KAAK,CAAA;AAC9C,MAAM,IAAA,EAAA,aAAA,EAAe,QAAQ,SAAS,CAAA;AACtC,MAAA,kBAAA;AAAA,4BACG,aAAc,EAAA,EAAA,KAAA,EACb,QAAC,kBAAA,GAAA,CAAA,qBAAA,EAAA,EAAsB,MAAY,CACrC,EAAA,CAAA;AAAA,QACA;AAAA,OACF;AAAA;AAEF,IAAO,OAAA,GAAA;AAAA,GACT;AACF;;;;"}
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@backstage/plugin-techdocs",
|
|
3
|
-
"version": "0.0.0-nightly-
|
|
3
|
+
"version": "0.0.0-nightly-20250501024241",
|
|
4
4
|
"description": "The Backstage plugin that renders technical documentation for your components",
|
|
5
5
|
"backstage": {
|
|
6
6
|
"role": "frontend-plugin",
|
|
@@ -71,23 +71,23 @@
|
|
|
71
71
|
"test": "backstage-cli package test"
|
|
72
72
|
},
|
|
73
73
|
"dependencies": {
|
|
74
|
-
"@backstage/catalog-client": "0.0.0-nightly-
|
|
74
|
+
"@backstage/catalog-client": "0.0.0-nightly-20250501024241",
|
|
75
75
|
"@backstage/catalog-model": "1.7.3",
|
|
76
76
|
"@backstage/config": "1.3.2",
|
|
77
|
-
"@backstage/core-compat-api": "0.0.0-nightly-
|
|
78
|
-
"@backstage/core-components": "0.0.0-nightly-
|
|
77
|
+
"@backstage/core-compat-api": "0.0.0-nightly-20250501024241",
|
|
78
|
+
"@backstage/core-components": "0.0.0-nightly-20250501024241",
|
|
79
79
|
"@backstage/core-plugin-api": "1.10.6",
|
|
80
80
|
"@backstage/errors": "1.2.7",
|
|
81
|
-
"@backstage/frontend-plugin-api": "0.0.0-nightly-
|
|
82
|
-
"@backstage/integration": "0.0.0-nightly-
|
|
83
|
-
"@backstage/integration-react": "0.0.0-nightly-
|
|
84
|
-
"@backstage/plugin-auth-react": "0.0.0-nightly-
|
|
85
|
-
"@backstage/plugin-catalog-react": "0.0.0-nightly-
|
|
86
|
-
"@backstage/plugin-search-common": "0.0.0-nightly-
|
|
87
|
-
"@backstage/plugin-search-react": "0.0.0-nightly-
|
|
81
|
+
"@backstage/frontend-plugin-api": "0.0.0-nightly-20250501024241",
|
|
82
|
+
"@backstage/integration": "0.0.0-nightly-20250501024241",
|
|
83
|
+
"@backstage/integration-react": "0.0.0-nightly-20250501024241",
|
|
84
|
+
"@backstage/plugin-auth-react": "0.0.0-nightly-20250501024241",
|
|
85
|
+
"@backstage/plugin-catalog-react": "0.0.0-nightly-20250501024241",
|
|
86
|
+
"@backstage/plugin-search-common": "0.0.0-nightly-20250501024241",
|
|
87
|
+
"@backstage/plugin-search-react": "0.0.0-nightly-20250501024241",
|
|
88
88
|
"@backstage/plugin-techdocs-common": "0.1.0",
|
|
89
|
-
"@backstage/plugin-techdocs-react": "0.0.0-nightly-
|
|
90
|
-
"@backstage/theme": "0.
|
|
89
|
+
"@backstage/plugin-techdocs-react": "0.0.0-nightly-20250501024241",
|
|
90
|
+
"@backstage/theme": "0.0.0-nightly-20250501024241",
|
|
91
91
|
"@material-ui/core": "^4.12.2",
|
|
92
92
|
"@material-ui/icons": "^4.9.1",
|
|
93
93
|
"@material-ui/lab": "4.0.0-alpha.61",
|
|
@@ -101,12 +101,12 @@
|
|
|
101
101
|
"react-use": "^17.2.4"
|
|
102
102
|
},
|
|
103
103
|
"devDependencies": {
|
|
104
|
-
"@backstage/cli": "0.0.0-nightly-
|
|
104
|
+
"@backstage/cli": "0.0.0-nightly-20250501024241",
|
|
105
105
|
"@backstage/core-app-api": "1.16.1",
|
|
106
|
-
"@backstage/dev-utils": "0.0.0-nightly-
|
|
107
|
-
"@backstage/plugin-catalog": "0.0.0-nightly-
|
|
108
|
-
"@backstage/plugin-techdocs-module-addons-contrib": "0.0.0-nightly-
|
|
109
|
-
"@backstage/test-utils": "0.0.0-nightly-
|
|
106
|
+
"@backstage/dev-utils": "0.0.0-nightly-20250501024241",
|
|
107
|
+
"@backstage/plugin-catalog": "0.0.0-nightly-20250501024241",
|
|
108
|
+
"@backstage/plugin-techdocs-module-addons-contrib": "0.0.0-nightly-20250501024241",
|
|
109
|
+
"@backstage/test-utils": "0.0.0-nightly-20250501024241",
|
|
110
110
|
"@testing-library/dom": "^10.0.0",
|
|
111
111
|
"@testing-library/jest-dom": "^6.0.0",
|
|
112
112
|
"@testing-library/react": "^16.0.0",
|