@backstage/plugin-techdocs-module-addons-contrib 1.1.21 → 1.1.22-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 +10 -0
- package/dist/{LigthBox → LightBox}/LightBox.esm.js.map +1 -1
- package/dist/alpha.d.ts +12 -0
- package/dist/alpha.esm.js +59 -0
- package/dist/alpha.esm.js.map +1 -0
- package/dist/plugin.esm.js +1 -1
- package/dist/plugin.esm.js.map +1 -1
- package/package.json +36 -21
- /package/dist/{LigthBox → LightBox}/LightBox.esm.js +0 -0
package/CHANGELOG.md
CHANGED
|
@@ -1,5 +1,15 @@
|
|
|
1
1
|
# @backstage/plugin-techdocs-module-addons-contrib
|
|
2
2
|
|
|
3
|
+
## 1.1.22-next.0
|
|
4
|
+
|
|
5
|
+
### Patch Changes
|
|
6
|
+
|
|
7
|
+
- b5a8208: Added `TechDocsAddonsBlueprint` extension to allow adding of techdocs addons.
|
|
8
|
+
- Updated dependencies
|
|
9
|
+
- @backstage/plugin-techdocs-react@1.2.15-next.0
|
|
10
|
+
- @backstage/frontend-plugin-api@0.9.6-next.0
|
|
11
|
+
- @backstage/integration-react@1.2.4
|
|
12
|
+
|
|
3
13
|
## 1.1.21
|
|
4
14
|
|
|
5
15
|
### Patch Changes
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"LightBox.esm.js","sources":["../../src/
|
|
1
|
+
{"version":3,"file":"LightBox.esm.js","sources":["../../src/LightBox/LightBox.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 { useEffect } from 'react';\nimport { useShadowRootElements } from '@backstage/plugin-techdocs-react';\n// @ts-ignore\nimport PhotoSwipeLightbox, { DataSource, ZoomLevel } from 'photoswipe/lightbox';\nimport PhotoSwipe from 'photoswipe';\nimport 'photoswipe/style.css';\nimport './lightbox.css';\n\nexport const LightBoxAddon = () => {\n const images = useShadowRootElements<HTMLImageElement>(['img']);\n\n useEffect(() => {\n let dataSourceImages: DataSource | null = null;\n\n let lightbox: PhotoSwipeLightbox | null = new PhotoSwipeLightbox({\n pswpModule: PhotoSwipe,\n initialZoomLevel: 1,\n secondaryZoomLevel: (zoomLevelObject: ZoomLevel) => {\n // photoswipe/lightbox won't zoom the image further then the given width and height.\n // therefore we need to calculate the zoom factor needed to fit the complete image in the viewport manually.\n const imageWidth = zoomLevelObject.elementSize.x;\n const imageHeight = zoomLevelObject.elementSize.y;\n const viewportWidth = zoomLevelObject.panAreaSize.x;\n const viewportHeight = zoomLevelObject.panAreaSize.y;\n\n const widthScale = viewportWidth / imageWidth;\n const heightScale = viewportHeight / imageHeight;\n\n const scaleFactor = Math.min(widthScale, heightScale);\n return scaleFactor;\n },\n wheelToZoom: true,\n arrowPrevSVG:\n '<svg class=\"MuiSvgIcon-root MuiSvgIcon-fontSizeLarge css-c1sh5i\" focusable=\"false\" aria-hidden=\"true\" viewBox=\"0 0 24 24\" data-testid=\"ArrowBackIosIcon\" aria-label=\"fontSize large\"><path d=\"M11.67 3.87 9.9 2.1 0 12l9.9 9.9 1.77-1.77L3.54 12z\"></path></svg>',\n arrowNextSVG:\n '<svg class=\"MuiSvgIcon-root MuiSvgIcon-fontSizeLarge css-c1sh5i\" focusable=\"false\" aria-hidden=\"true\" viewBox=\"0 0 24 24\" data-testid=\"ArrowForwardIosIcon\" aria-label=\"fontSize large\"><path d=\"M6.23 20.23 8 22l10-10L8 2 6.23 3.77 14.46 12z\"></path></svg>',\n closeSVG:\n '<svg class=\"MuiSvgIcon-root MuiSvgIcon-fontSizeLarge css-c1sh5i\" focusable=\"false\" aria-hidden=\"true\" viewBox=\"0 0 24 24\" data-testid=\"CloseIcon\" aria-label=\"fontSize large\"><path d=\"M19 6.41 17.59 5 12 10.59 6.41 5 5 6.41 10.59 12 5 17.59 6.41 19 12 13.41 17.59 19 19 17.59 13.41 12z\"></path></svg>',\n zoomSVG: `<svg class=\"MuiSvgIcon-root MuiSvgIcon-fontSizeLarge css-c1sh5i\" focusable=\"false\" aria-hidden=\"true\" viewBox=\"0 0 24 24\" data-testid=\"ZoomIcon\" aria-label=\"fontSize large\">\n <path d=\"M15.5 14h-.79l-.28-.27C15.41 12.59 16 11.11 16 9.5 16 5.91 13.09 3 9.5 3S3 5.91 3 9.5 5.91 16 9.5 16c1.61 0 3.09-.59 4.23-1.57l.27.28v.79l5 4.99L20.49 19l-4.99-5zm-6 0C7.01 14 5 11.99 5 9.5S7.01 5 9.5 5 14 7.01 14 9.5 11.99 14 9.5 14z\"></path><path d=\"M12 10h-2v2H9v-2H7V9h2V7h1v2h2v1z\" id=\"photoswipe-zoom-icon-zoomin-path\"></path><path d=\"M12 10H 7 V 9 H 12 Z\" id=\"photoswipe-zoom-icon-zoomout-path\">\n </svg>`,\n });\n\n images.forEach((image, index) => {\n image.onclick = () => {\n if (dataSourceImages === null) {\n dataSourceImages = images.map(dataSourceImage => {\n return {\n element: dataSourceImage,\n src: dataSourceImage.src,\n msrc: dataSourceImage.src,\n alt: dataSourceImage.alt,\n width: dataSourceImage.clientWidth,\n height: dataSourceImage.clientHeight,\n };\n });\n }\n lightbox?.loadAndOpen(index, dataSourceImages);\n return false;\n };\n });\n lightbox.init();\n\n return () => {\n lightbox?.destroy();\n lightbox = null;\n };\n }, [images]);\n\n return null;\n};\n"],"names":[],"mappings":";;;;;;AAwBO,MAAM,gBAAgB,MAAM;AACjC,EAAA,MAAM,MAAS,GAAA,qBAAA,CAAwC,CAAC,KAAK,CAAC,CAAA;AAE9D,EAAA,SAAA,CAAU,MAAM;AACd,IAAA,IAAI,gBAAsC,GAAA,IAAA;AAE1C,IAAI,IAAA,QAAA,GAAsC,IAAI,kBAAmB,CAAA;AAAA,MAC/D,UAAY,EAAA,UAAA;AAAA,MACZ,gBAAkB,EAAA,CAAA;AAAA,MAClB,kBAAA,EAAoB,CAAC,eAA+B,KAAA;AAGlD,QAAM,MAAA,UAAA,GAAa,gBAAgB,WAAY,CAAA,CAAA;AAC/C,QAAM,MAAA,WAAA,GAAc,gBAAgB,WAAY,CAAA,CAAA;AAChD,QAAM,MAAA,aAAA,GAAgB,gBAAgB,WAAY,CAAA,CAAA;AAClD,QAAM,MAAA,cAAA,GAAiB,gBAAgB,WAAY,CAAA,CAAA;AAEnD,QAAA,MAAM,aAAa,aAAgB,GAAA,UAAA;AACnC,QAAA,MAAM,cAAc,cAAiB,GAAA,WAAA;AAErC,QAAA,MAAM,WAAc,GAAA,IAAA,CAAK,GAAI,CAAA,UAAA,EAAY,WAAW,CAAA;AACpD,QAAO,OAAA,WAAA;AAAA,OACT;AAAA,MACA,WAAa,EAAA,IAAA;AAAA,MACb,YACE,EAAA,mQAAA;AAAA,MACF,YACE,EAAA,iQAAA;AAAA,MACF,QACE,EAAA,8SAAA;AAAA,MACF,OAAS,EAAA,CAAA;AAAA;AAAA,cAAA;AAAA,KAGV,CAAA;AAED,IAAO,MAAA,CAAA,OAAA,CAAQ,CAAC,KAAA,EAAO,KAAU,KAAA;AAC/B,MAAA,KAAA,CAAM,UAAU,MAAM;AACpB,QAAA,IAAI,qBAAqB,IAAM,EAAA;AAC7B,UAAmB,gBAAA,GAAA,MAAA,CAAO,IAAI,CAAmB,eAAA,KAAA;AAC/C,YAAO,OAAA;AAAA,cACL,OAAS,EAAA,eAAA;AAAA,cACT,KAAK,eAAgB,CAAA,GAAA;AAAA,cACrB,MAAM,eAAgB,CAAA,GAAA;AAAA,cACtB,KAAK,eAAgB,CAAA,GAAA;AAAA,cACrB,OAAO,eAAgB,CAAA,WAAA;AAAA,cACvB,QAAQ,eAAgB,CAAA;AAAA,aAC1B;AAAA,WACD,CAAA;AAAA;AAEH,QAAU,QAAA,EAAA,WAAA,CAAY,OAAO,gBAAgB,CAAA;AAC7C,QAAO,OAAA,KAAA;AAAA,OACT;AAAA,KACD,CAAA;AACD,IAAA,QAAA,CAAS,IAAK,EAAA;AAEd,IAAA,OAAO,MAAM;AACX,MAAA,QAAA,EAAU,OAAQ,EAAA;AAClB,MAAW,QAAA,GAAA,IAAA;AAAA,KACb;AAAA,GACF,EAAG,CAAC,MAAM,CAAC,CAAA;AAEX,EAAO,OAAA,IAAA;AACT;;;;"}
|
package/dist/alpha.d.ts
ADDED
|
@@ -0,0 +1,12 @@
|
|
|
1
|
+
import * as _backstage_frontend_plugin_api from '@backstage/frontend-plugin-api';
|
|
2
|
+
|
|
3
|
+
/** @alpha */
|
|
4
|
+
declare const techDocsExpandableNavigationAddonModule: _backstage_frontend_plugin_api.FrontendModule;
|
|
5
|
+
/** @alpha */
|
|
6
|
+
declare const techDocsReportIssueAddonModule: _backstage_frontend_plugin_api.FrontendModule;
|
|
7
|
+
/** @alpha */
|
|
8
|
+
declare const techDocsTextSizeAddonModule: _backstage_frontend_plugin_api.FrontendModule;
|
|
9
|
+
/** @alpha */
|
|
10
|
+
declare const techDocsLightBoxAddonModule: _backstage_frontend_plugin_api.FrontendModule;
|
|
11
|
+
|
|
12
|
+
export { techDocsExpandableNavigationAddonModule, techDocsLightBoxAddonModule, techDocsReportIssueAddonModule, techDocsTextSizeAddonModule };
|
|
@@ -0,0 +1,59 @@
|
|
|
1
|
+
import { TechDocsAddonLocations } from '@backstage/plugin-techdocs-react';
|
|
2
|
+
import { AddonBlueprint } from '@backstage/plugin-techdocs-react/alpha';
|
|
3
|
+
import { TextSizeAddon } from './TextSize/TextSize.esm.js';
|
|
4
|
+
import { ReportIssueAddon } from './ReportIssue/ReportIssue.esm.js';
|
|
5
|
+
import { ExpandableNavigationAddon } from './ExpandableNavigation/ExpandableNavigation.esm.js';
|
|
6
|
+
import { LightBoxAddon } from './LightBox/LightBox.esm.js';
|
|
7
|
+
import { createFrontendModule } from '@backstage/frontend-plugin-api';
|
|
8
|
+
|
|
9
|
+
const techDocsExpandableNavigationAddon = AddonBlueprint.make({
|
|
10
|
+
name: "expandable-navigation",
|
|
11
|
+
params: {
|
|
12
|
+
name: "ExpandableNavigation",
|
|
13
|
+
location: TechDocsAddonLocations.PrimarySidebar,
|
|
14
|
+
component: ExpandableNavigationAddon
|
|
15
|
+
}
|
|
16
|
+
});
|
|
17
|
+
const techDocsExpandableNavigationAddonModule = createFrontendModule({
|
|
18
|
+
pluginId: "techdocs",
|
|
19
|
+
extensions: [techDocsExpandableNavigationAddon]
|
|
20
|
+
});
|
|
21
|
+
const techDocsReportIssueAddon = AddonBlueprint.make({
|
|
22
|
+
name: "report-issue",
|
|
23
|
+
params: {
|
|
24
|
+
name: "ReportIssue",
|
|
25
|
+
location: TechDocsAddonLocations.Content,
|
|
26
|
+
component: ReportIssueAddon
|
|
27
|
+
}
|
|
28
|
+
});
|
|
29
|
+
const techDocsReportIssueAddonModule = createFrontendModule({
|
|
30
|
+
pluginId: "techdocs",
|
|
31
|
+
extensions: [techDocsReportIssueAddon]
|
|
32
|
+
});
|
|
33
|
+
const techDocsTextSizeAddon = AddonBlueprint.make({
|
|
34
|
+
name: "text-size",
|
|
35
|
+
params: {
|
|
36
|
+
name: "TextSize",
|
|
37
|
+
location: TechDocsAddonLocations.Settings,
|
|
38
|
+
component: TextSizeAddon
|
|
39
|
+
}
|
|
40
|
+
});
|
|
41
|
+
const techDocsTextSizeAddonModule = createFrontendModule({
|
|
42
|
+
pluginId: "techdocs",
|
|
43
|
+
extensions: [techDocsTextSizeAddon]
|
|
44
|
+
});
|
|
45
|
+
const techDocsLightBoxAddon = AddonBlueprint.make({
|
|
46
|
+
name: "light-box",
|
|
47
|
+
params: {
|
|
48
|
+
name: "LightBox",
|
|
49
|
+
location: TechDocsAddonLocations.Content,
|
|
50
|
+
component: LightBoxAddon
|
|
51
|
+
}
|
|
52
|
+
});
|
|
53
|
+
const techDocsLightBoxAddonModule = createFrontendModule({
|
|
54
|
+
pluginId: "techdocs",
|
|
55
|
+
extensions: [techDocsLightBoxAddon]
|
|
56
|
+
});
|
|
57
|
+
|
|
58
|
+
export { techDocsExpandableNavigationAddonModule, techDocsLightBoxAddonModule, techDocsReportIssueAddonModule, techDocsTextSizeAddonModule };
|
|
59
|
+
//# sourceMappingURL=alpha.esm.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"alpha.esm.js","sources":["../src/alpha.ts"],"sourcesContent":["/*\n * Copyright 2025 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 { TechDocsAddonLocations } from '@backstage/plugin-techdocs-react';\nimport { AddonBlueprint } from '@backstage/plugin-techdocs-react/alpha';\nimport { TextSizeAddon } from './TextSize';\nimport { ReportIssueAddon } from './ReportIssue';\nimport { ExpandableNavigationAddon } from './ExpandableNavigation';\nimport { LightBoxAddon } from './LightBox';\nimport { createFrontendModule } from '@backstage/frontend-plugin-api';\n\n/** @alpha */\nconst techDocsExpandableNavigationAddon = AddonBlueprint.make({\n name: 'expandable-navigation',\n params: {\n name: 'ExpandableNavigation',\n location: TechDocsAddonLocations.PrimarySidebar,\n component: ExpandableNavigationAddon,\n },\n});\n\n/** @alpha */\nexport const techDocsExpandableNavigationAddonModule = createFrontendModule({\n pluginId: 'techdocs',\n extensions: [techDocsExpandableNavigationAddon],\n});\n\n/** @alpha */\nconst techDocsReportIssueAddon = AddonBlueprint.make({\n name: 'report-issue',\n params: {\n name: 'ReportIssue',\n location: TechDocsAddonLocations.Content,\n component: ReportIssueAddon,\n },\n});\n\n/** @alpha */\nexport const techDocsReportIssueAddonModule = createFrontendModule({\n pluginId: 'techdocs',\n extensions: [techDocsReportIssueAddon],\n});\n\n/** @alpha */\nconst techDocsTextSizeAddon = AddonBlueprint.make({\n name: 'text-size',\n params: {\n name: 'TextSize',\n location: TechDocsAddonLocations.Settings,\n component: TextSizeAddon,\n },\n});\n\n/** @alpha */\nexport const techDocsTextSizeAddonModule = createFrontendModule({\n pluginId: 'techdocs',\n extensions: [techDocsTextSizeAddon],\n});\n\n/** @alpha */\nconst techDocsLightBoxAddon = AddonBlueprint.make({\n name: 'light-box',\n params: {\n name: 'LightBox',\n location: TechDocsAddonLocations.Content,\n component: LightBoxAddon,\n },\n});\n\n/** @alpha */\nexport const techDocsLightBoxAddonModule = createFrontendModule({\n pluginId: 'techdocs',\n extensions: [techDocsLightBoxAddon],\n});\n"],"names":[],"mappings":";;;;;;;;AAwBA,MAAM,iCAAA,GAAoC,eAAe,IAAK,CAAA;AAAA,EAC5D,IAAM,EAAA,uBAAA;AAAA,EACN,MAAQ,EAAA;AAAA,IACN,IAAM,EAAA,sBAAA;AAAA,IACN,UAAU,sBAAuB,CAAA,cAAA;AAAA,IACjC,SAAW,EAAA;AAAA;AAEf,CAAC,CAAA;AAGM,MAAM,0CAA0C,oBAAqB,CAAA;AAAA,EAC1E,QAAU,EAAA,UAAA;AAAA,EACV,UAAA,EAAY,CAAC,iCAAiC;AAChD,CAAC;AAGD,MAAM,wBAAA,GAA2B,eAAe,IAAK,CAAA;AAAA,EACnD,IAAM,EAAA,cAAA;AAAA,EACN,MAAQ,EAAA;AAAA,IACN,IAAM,EAAA,aAAA;AAAA,IACN,UAAU,sBAAuB,CAAA,OAAA;AAAA,IACjC,SAAW,EAAA;AAAA;AAEf,CAAC,CAAA;AAGM,MAAM,iCAAiC,oBAAqB,CAAA;AAAA,EACjE,QAAU,EAAA,UAAA;AAAA,EACV,UAAA,EAAY,CAAC,wBAAwB;AACvC,CAAC;AAGD,MAAM,qBAAA,GAAwB,eAAe,IAAK,CAAA;AAAA,EAChD,IAAM,EAAA,WAAA;AAAA,EACN,MAAQ,EAAA;AAAA,IACN,IAAM,EAAA,UAAA;AAAA,IACN,UAAU,sBAAuB,CAAA,QAAA;AAAA,IACjC,SAAW,EAAA;AAAA;AAEf,CAAC,CAAA;AAGM,MAAM,8BAA8B,oBAAqB,CAAA;AAAA,EAC9D,QAAU,EAAA,UAAA;AAAA,EACV,UAAA,EAAY,CAAC,qBAAqB;AACpC,CAAC;AAGD,MAAM,qBAAA,GAAwB,eAAe,IAAK,CAAA;AAAA,EAChD,IAAM,EAAA,WAAA;AAAA,EACN,MAAQ,EAAA;AAAA,IACN,IAAM,EAAA,UAAA;AAAA,IACN,UAAU,sBAAuB,CAAA,OAAA;AAAA,IACjC,SAAW,EAAA;AAAA;AAEf,CAAC,CAAA;AAGM,MAAM,8BAA8B,oBAAqB,CAAA;AAAA,EAC9D,QAAU,EAAA,UAAA;AAAA,EACV,UAAA,EAAY,CAAC,qBAAqB;AACpC,CAAC;;;;"}
|
package/dist/plugin.esm.js
CHANGED
|
@@ -3,7 +3,7 @@ import { createTechDocsAddonExtension, TechDocsAddonLocations } from '@backstage
|
|
|
3
3
|
import { ExpandableNavigationAddon } from './ExpandableNavigation/ExpandableNavigation.esm.js';
|
|
4
4
|
import { ReportIssueAddon } from './ReportIssue/ReportIssue.esm.js';
|
|
5
5
|
import { TextSizeAddon } from './TextSize/TextSize.esm.js';
|
|
6
|
-
import { LightBoxAddon } from './
|
|
6
|
+
import { LightBoxAddon } from './LightBox/LightBox.esm.js';
|
|
7
7
|
|
|
8
8
|
const techdocsModuleAddonsContribPlugin = createPlugin({
|
|
9
9
|
id: "techdocsModuleAddonsContrib"
|
package/dist/plugin.esm.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"plugin.esm.js","sources":["../src/plugin.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 */\n\nimport { createPlugin } from '@backstage/core-plugin-api';\nimport {\n createTechDocsAddonExtension,\n TechDocsAddonLocations,\n} from '@backstage/plugin-techdocs-react';\nimport { ExpandableNavigationAddon } from './ExpandableNavigation';\nimport { ReportIssueAddon, ReportIssueProps } from './ReportIssue';\nimport { TextSizeAddon } from './TextSize';\nimport { LightBoxAddon } from './
|
|
1
|
+
{"version":3,"file":"plugin.esm.js","sources":["../src/plugin.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 */\n\nimport { createPlugin } from '@backstage/core-plugin-api';\nimport {\n createTechDocsAddonExtension,\n TechDocsAddonLocations,\n} from '@backstage/plugin-techdocs-react';\nimport { ExpandableNavigationAddon } from './ExpandableNavigation';\nimport { ReportIssueAddon, ReportIssueProps } from './ReportIssue';\nimport { TextSizeAddon } from './TextSize';\nimport { LightBoxAddon } from './LightBox';\n\n/**\n * The TechDocs addons contrib plugin\n *\n * @public\n */\n\nexport const techdocsModuleAddonsContribPlugin = createPlugin({\n id: 'techdocsModuleAddonsContrib',\n});\n\n/**\n * TechDocs addon that lets you expand/collapse the TechDocs main navigation\n * and keep the preferred state in local storage. The addon will render as\n * a button next to the site name if the documentation has nested navigation.\n *\n * @example\n * Here's a simple example:\n * ```\n * import {\n * DefaultTechDocsHome,\n * TechDocsIndexPage,\n * TechDocsReaderPage,\n * } from '@backstage/plugin-techdocs';\n * import { TechDocsAddons } from '@backstage/plugin-techdocs-react/alpha';\n * import { ExpandableNavigation } from '@backstage/plugin-techdocs-module-addons-contrib';\n *\n *\n * const AppRoutes = () => {\n * <FlatRoutes>\n * // other plugin routes\n * <Route path=\"/docs\" element={<TechDocsIndexPage />}>\n * <DefaultTechDocsHome />\n * </Route>\n * <Route\n * path=\"/docs/:namespace/:kind/:name/*\"\n * element={<TechDocsReaderPage />}\n * >\n * <TechDocsAddons>\n * <ExpandableNavigation />\n * </TechDocsAddons>\n * </Route>\n * </FlatRoutes>;\n * };\n * ```\n *\n * @public\n */\n\nexport const ExpandableNavigation = techdocsModuleAddonsContribPlugin.provide(\n createTechDocsAddonExtension({\n name: 'ExpandableNavigation',\n location: TechDocsAddonLocations.PrimarySidebar,\n component: ExpandableNavigationAddon,\n }),\n);\n\n/**\n * TechDocs addon that lets you select text and open GitHub/Gitlab issues\n *\n * @remarks\n * Before using it, you should set up an `edit_uri` for your pages as explained {@link https://backstage.io/docs/features/techdocs/faqs#is-it-possible-for-users-to-suggest-changes-or-provide-feedback-on-a-techdocs-page | here} and remember, it only works for Github or Gitlab.\n *\n * @example\n * Here's a simple example:\n * ```\n * import {\n * DefaultTechDocsHome,\n * TechDocsIndexPage,\n * TechDocsReaderPage,\n * } from '@backstage/plugin-techdocs';\n * import { TechDocsAddons } from '@backstage/plugin-techdocs-react';\n * import { ReportIssue } from '@backstage/plugin-techdocs-module-addons-contrib';\n *\n *\n * const AppRoutes = () => {\n * <FlatRoutes>\n * // other plugin routes\n * <Route path=\"/docs\" element={<TechDocsIndexPage />}>\n * <DefaultTechDocsHome />\n * </Route>\n * <Route\n * path=\"/docs/:namespace/:kind/:name/*\"\n * element={<TechDocsReaderPage />}\n * >\n * <TechDocsAddons>\n * <ReportIssue />\n * </TechDocsAddons>\n * </Route>\n * </FlatRoutes>;\n * };\n * ```\n *\n * @example\n * Here's an example with `debounceTime` and `templateBuilder` props:\n * ```\n * import {\n * DefaultTechDocsHome,\n * TechDocsIndexPage,\n * TechDocsReaderPage,\n * } from '@backstage/plugin-techdocs';\n * import { TechDocsAddons } from '@backstage/plugin-techdocs-react';\n * import { ReportIssue } from '@backstage/plugin-techdocs-module-addons-contrib';\n *\n * const templateBuilder = ({ selection }: ReportIssueTemplateBuilder) => (({\n * title: 'Custom issue title',\n * body: `Custom issue body: ${selection.toString()}`\n * }))\n *\n * const AppRoutes = () => {\n * <FlatRoutes>\n * // other plugin routes\n * <Route path=\"/docs\" element={<TechDocsIndexPage />}>\n * <DefaultTechDocsHome />\n * </Route>\n * <Route\n * path=\"/docs/:namespace/:kind/:name/*\"\n * element={<TechDocsReaderPage />}\n * >\n * <TechDocsAddons>\n * <ReportIssue debounceTime={300} templateBuilder={templateBuilder} />\n * </TechDocsAddons>\n * </Route>\n * </FlatRoutes>;\n * ```\n * @param props - Object that can optionally contain `debounceTime` and `templateBuilder` properties.\n * @public\n */\nexport const ReportIssue = techdocsModuleAddonsContribPlugin.provide(\n createTechDocsAddonExtension<ReportIssueProps>({\n name: 'ReportIssue',\n location: TechDocsAddonLocations.Content,\n component: ReportIssueAddon,\n }),\n);\n\n/**\n * This TechDocs addon allows users to customize text size on documentation pages, they can select how much they want to increase or decrease the font size via slider or buttons.\n *\n * @remarks\n * The default value for the font size is 100% of the HTML font size, if the theme does not have a `htmlFontSize` in its typography object, the addon will assume 16px as 100%, and remember, this setting is kept in the browser local storage.\n *\n * @example\n * Here's a simple example:\n * ```\n * import {\n * DefaultTechDocsHome,\n * TechDocsIndexPage,\n * TechDocsReaderPage,\n * } from '@backstage/plugin-techdocs';\n * import { TechDocsAddons } from '@backstage/plugin-techdocs-react';\n * import { TextSize } from '@backstage/plugin-techdocs-module-addons-contrib';\n *\n *\n * const AppRoutes = () => {\n * <FlatRoutes>\n * // other plugin routes\n * <Route path=\"/docs\" element={<TechDocsIndexPage />}>\n * <DefaultTechDocsHome />\n * </Route>\n * <Route\n * path=\"/docs/:namespace/:kind/:name/*\"\n * element={<TechDocsReaderPage />}\n * >\n * <TechDocsAddons>\n * <TextSize />\n * </TechDocsAddons>\n * </Route>\n * </FlatRoutes>;\n * };\n * ```\n *\n * @public\n */\nexport const TextSize = techdocsModuleAddonsContribPlugin.provide(\n createTechDocsAddonExtension({\n name: 'TextSize',\n location: TechDocsAddonLocations.Settings,\n component: TextSizeAddon,\n }),\n);\n\n/**\n * This TechDocs addon allows users to open images in a lightbox on documentation pages, they can navigate between images if there are several on one page.\n *\n * @remarks\n * The image size of the lightbox image is the same as the image size on the document page.\n *\n * @example\n * Here's a simple example:\n * ```\n * import {\n * DefaultTechDocsHome,\n * TechDocsIndexPage,\n * TechDocsReaderPage,\n * } from '@backstage/plugin-techdocs';\n * import { TechDocsAddons } from '@backstage/plugin-techdocs-react';\n * import { LightBox } from '@backstage/plugin-techdocs-module-addons-contrib';\n *\n *\n * const AppRoutes = () => {\n * <FlatRoutes>\n * // other plugin routes\n * <Route path=\"/docs\" element={<TechDocsIndexPage />}>\n * <DefaultTechDocsHome />\n * </Route>\n * <Route\n * path=\"/docs/:namespace/:kind/:name/*\"\n * element={<TechDocsReaderPage />}\n * >\n * <TechDocsAddons>\n * <LightBox />\n * </TechDocsAddons>\n * </Route>\n * </FlatRoutes>;\n * };\n * ```\n *\n * @public\n */\nexport const LightBox = techdocsModuleAddonsContribPlugin.provide(\n createTechDocsAddonExtension({\n name: 'LightBox',\n location: TechDocsAddonLocations.Content,\n component: LightBoxAddon,\n }),\n);\n"],"names":[],"mappings":";;;;;;;AAgCO,MAAM,oCAAoC,YAAa,CAAA;AAAA,EAC5D,EAAI,EAAA;AACN,CAAC;AAwCM,MAAM,uBAAuB,iCAAkC,CAAA,OAAA;AAAA,EACpE,4BAA6B,CAAA;AAAA,IAC3B,IAAM,EAAA,sBAAA;AAAA,IACN,UAAU,sBAAuB,CAAA,cAAA;AAAA,IACjC,SAAW,EAAA;AAAA,GACZ;AACH;AAyEO,MAAM,cAAc,iCAAkC,CAAA,OAAA;AAAA,EAC3D,4BAA+C,CAAA;AAAA,IAC7C,IAAM,EAAA,aAAA;AAAA,IACN,UAAU,sBAAuB,CAAA,OAAA;AAAA,IACjC,SAAW,EAAA;AAAA,GACZ;AACH;AAwCO,MAAM,WAAW,iCAAkC,CAAA,OAAA;AAAA,EACxD,4BAA6B,CAAA;AAAA,IAC3B,IAAM,EAAA,UAAA;AAAA,IACN,UAAU,sBAAuB,CAAA,QAAA;AAAA,IACjC,SAAW,EAAA;AAAA,GACZ;AACH;AAwCO,MAAM,WAAW,iCAAkC,CAAA,OAAA;AAAA,EACxD,4BAA6B,CAAA;AAAA,IAC3B,IAAM,EAAA,UAAA;AAAA,IACN,UAAU,sBAAuB,CAAA,OAAA;AAAA,IACjC,SAAW,EAAA;AAAA,GACZ;AACH;;;;"}
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@backstage/plugin-techdocs-module-addons-contrib",
|
|
3
|
-
"version": "1.1.
|
|
3
|
+
"version": "1.1.22-next.0",
|
|
4
4
|
"description": "Plugin module for contributed TechDocs Addons",
|
|
5
5
|
"backstage": {
|
|
6
6
|
"role": "frontend-plugin-module",
|
|
@@ -8,9 +8,7 @@
|
|
|
8
8
|
"pluginPackage": "@backstage/plugin-techdocs"
|
|
9
9
|
},
|
|
10
10
|
"publishConfig": {
|
|
11
|
-
"access": "public"
|
|
12
|
-
"main": "dist/index.esm.js",
|
|
13
|
-
"types": "dist/index.d.ts"
|
|
11
|
+
"access": "public"
|
|
14
12
|
},
|
|
15
13
|
"keywords": [
|
|
16
14
|
"backstage",
|
|
@@ -24,8 +22,31 @@
|
|
|
24
22
|
},
|
|
25
23
|
"license": "Apache-2.0",
|
|
26
24
|
"sideEffects": false,
|
|
27
|
-
"
|
|
28
|
-
|
|
25
|
+
"exports": {
|
|
26
|
+
".": {
|
|
27
|
+
"import": "./dist/index.esm.js",
|
|
28
|
+
"types": "./dist/index.d.ts",
|
|
29
|
+
"default": "./dist/index.esm.js"
|
|
30
|
+
},
|
|
31
|
+
"./alpha": {
|
|
32
|
+
"import": "./dist/alpha.esm.js",
|
|
33
|
+
"types": "./dist/alpha.d.ts",
|
|
34
|
+
"default": "./dist/alpha.esm.js"
|
|
35
|
+
},
|
|
36
|
+
"./package.json": "./package.json"
|
|
37
|
+
},
|
|
38
|
+
"main": "./dist/index.esm.js",
|
|
39
|
+
"types": "./dist/index.d.ts",
|
|
40
|
+
"typesVersions": {
|
|
41
|
+
"*": {
|
|
42
|
+
"index": [
|
|
43
|
+
"dist/index.d.ts"
|
|
44
|
+
],
|
|
45
|
+
"alpha": [
|
|
46
|
+
"dist/alpha.d.ts"
|
|
47
|
+
]
|
|
48
|
+
}
|
|
49
|
+
},
|
|
29
50
|
"files": [
|
|
30
51
|
"dist"
|
|
31
52
|
],
|
|
@@ -39,11 +60,12 @@
|
|
|
39
60
|
"test": "backstage-cli package test"
|
|
40
61
|
},
|
|
41
62
|
"dependencies": {
|
|
42
|
-
"@backstage/core-components": "
|
|
43
|
-
"@backstage/core-plugin-api": "
|
|
44
|
-
"@backstage/
|
|
45
|
-
"@backstage/integration
|
|
46
|
-
"@backstage/
|
|
63
|
+
"@backstage/core-components": "0.16.4",
|
|
64
|
+
"@backstage/core-plugin-api": "1.10.4",
|
|
65
|
+
"@backstage/frontend-plugin-api": "0.9.6-next.0",
|
|
66
|
+
"@backstage/integration": "1.16.1",
|
|
67
|
+
"@backstage/integration-react": "1.2.4",
|
|
68
|
+
"@backstage/plugin-techdocs-react": "1.2.15-next.0",
|
|
47
69
|
"@material-ui/core": "^4.12.2",
|
|
48
70
|
"@material-ui/icons": "^4.9.1",
|
|
49
71
|
"@react-hookz/web": "^24.0.0",
|
|
@@ -51,9 +73,9 @@
|
|
|
51
73
|
"photoswipe": "^5.3.7"
|
|
52
74
|
},
|
|
53
75
|
"devDependencies": {
|
|
54
|
-
"@backstage/cli": "
|
|
55
|
-
"@backstage/plugin-techdocs-addons-test-utils": "
|
|
56
|
-
"@backstage/test-utils": "
|
|
76
|
+
"@backstage/cli": "0.30.0",
|
|
77
|
+
"@backstage/plugin-techdocs-addons-test-utils": "1.0.46-next.0",
|
|
78
|
+
"@backstage/test-utils": "1.7.5",
|
|
57
79
|
"@testing-library/dom": "^10.0.0",
|
|
58
80
|
"@testing-library/jest-dom": "^6.0.0",
|
|
59
81
|
"@testing-library/react": "^16.0.0",
|
|
@@ -73,12 +95,5 @@
|
|
|
73
95
|
"optional": true
|
|
74
96
|
}
|
|
75
97
|
},
|
|
76
|
-
"typesVersions": {
|
|
77
|
-
"*": {
|
|
78
|
-
"index": [
|
|
79
|
-
"dist/index.d.ts"
|
|
80
|
-
]
|
|
81
|
-
}
|
|
82
|
-
},
|
|
83
98
|
"module": "./dist/index.esm.js"
|
|
84
99
|
}
|
|
File without changes
|