@backstage/plugin-techdocs 1.0.0 → 1.0.1-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 CHANGED
@@ -1,5 +1,53 @@
1
1
  # @backstage/plugin-techdocs
2
2
 
3
+ ## 1.0.1-next.2
4
+
5
+ ### Patch Changes
6
+
7
+ - f0fb9153b7: Fix broken query selectors on techdocs
8
+ - 9975ff9852: Applied the fix from version 1.0.1 of this package, which is part of the v1.0.2 release of Backstage.
9
+ - Updated dependencies
10
+ - @backstage/core-components@0.9.3-next.1
11
+ - @backstage/plugin-catalog-react@1.0.1-next.2
12
+ - @backstage/catalog-model@1.0.1-next.1
13
+
14
+ ## 1.0.1
15
+
16
+ ### Patch Changes
17
+
18
+ - Pin the `event-source-polyfill` dependency to version 1.0.25
19
+
20
+ ## 1.0.1-next.1
21
+
22
+ ### Patch Changes
23
+
24
+ - 0152c0de22: Some documentation layout tweaks:
25
+
26
+ - drawer toggle margins
27
+ - code block margins
28
+ - sidebar drawer width
29
+ - inner content width
30
+ - footer link width
31
+ - sidebar table of contents scroll
32
+
33
+ - Updated dependencies
34
+ - @backstage/integration@1.1.0-next.1
35
+ - @backstage/plugin-catalog-react@1.0.1-next.1
36
+ - @backstage/integration-react@1.0.1-next.1
37
+
38
+ ## 1.0.1-next.0
39
+
40
+ ### Patch Changes
41
+
42
+ - fe53fe97d7: Fix permalink scrolling for anchors where the id starts with a number.
43
+ - Updated dependencies
44
+ - @backstage/catalog-model@1.0.1-next.0
45
+ - @backstage/plugin-search@0.7.5-next.0
46
+ - @backstage/integration@1.0.1-next.0
47
+ - @backstage/plugin-catalog-react@1.0.1-next.0
48
+ - @backstage/core-components@0.9.3-next.0
49
+ - @backstage/integration-react@1.0.1-next.0
50
+
3
51
  ## 1.0.0
4
52
 
5
53
  ### Major Changes
@@ -128,4 +128,4 @@ const TechDocsCustomHome = (props) => {
128
128
  };
129
129
 
130
130
  export { TechDocsCustomHome };
131
- //# sourceMappingURL=TechDocsCustomHome-174c6f0d.esm.js.map
131
+ //# sourceMappingURL=TechDocsCustomHome-e38e305b.esm.js.map
@@ -1 +1 @@
1
- {"version":3,"file":"TechDocsCustomHome-174c6f0d.esm.js","sources":["../../src/home/components/TechDocsCustomHome.tsx"],"sourcesContent":["/*\n * Copyright 2021 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 React, { useState } from 'react';\nimport useAsync from 'react-use/lib/useAsync';\nimport { makeStyles } from '@material-ui/core';\nimport { CSSProperties } from '@material-ui/styles';\nimport {\n CATALOG_FILTER_EXISTS,\n catalogApiRef,\n CatalogApi,\n useEntityOwnership,\n} from '@backstage/plugin-catalog-react';\nimport { Entity } from '@backstage/catalog-model';\nimport { DocsTable } from './Tables';\nimport { DocsCardGrid } from './Grids';\nimport { TechDocsPageWrapper } from './TechDocsPageWrapper';\n\nimport {\n CodeSnippet,\n Content,\n HeaderTabs,\n Progress,\n WarningPanel,\n SupportButton,\n ContentHeader,\n} from '@backstage/core-components';\nimport { useApi } from '@backstage/core-plugin-api';\n\nconst panels = {\n DocsTable: DocsTable,\n DocsCardGrid: DocsCardGrid,\n};\n\n/**\n * Available panel types\n *\n * @public\n */\nexport type PanelType = 'DocsCardGrid' | 'DocsTable';\n\n/**\n * Type representing a TechDocsCustomHome panel.\n *\n * @public\n */\nexport interface PanelConfig {\n title: string;\n description: string;\n panelType: PanelType;\n panelCSS?: CSSProperties;\n filterPredicate: ((entity: Entity) => boolean) | string;\n}\n\n/**\n * Type representing a TechDocsCustomHome tab.\n *\n * @public\n */\nexport interface TabConfig {\n label: string;\n panels: PanelConfig[];\n}\n\n/**\n * Type representing a list of TechDocsCustomHome tabs.\n *\n * @public\n */\nexport type TabsConfig = TabConfig[];\n\nconst CustomPanel = ({\n config,\n entities,\n index,\n}: {\n config: PanelConfig;\n entities: Entity[];\n index: number;\n}) => {\n const useStyles = makeStyles({\n panelContainer: {\n marginBottom: '2rem',\n ...(config.panelCSS ? config.panelCSS : {}),\n },\n });\n const classes = useStyles();\n const { loading: loadingOwnership, isOwnedEntity } = useEntityOwnership();\n\n const Panel = panels[config.panelType];\n\n const shownEntities = entities.filter(entity => {\n if (config.filterPredicate === 'ownedByUser') {\n if (loadingOwnership) {\n return false;\n }\n return isOwnedEntity(entity);\n }\n\n return (\n typeof config.filterPredicate === 'function' &&\n config.filterPredicate(entity)\n );\n });\n\n return (\n <>\n <ContentHeader title={config.title} description={config.description}>\n {index === 0 ? (\n <SupportButton>\n Discover documentation in your ecosystem.\n </SupportButton>\n ) : null}\n </ContentHeader>\n <div className={classes.panelContainer}>\n <Panel data-testid=\"techdocs-custom-panel\" entities={shownEntities} />\n </div>\n </>\n );\n};\n\n/**\n * Props for {@link TechDocsCustomHome}\n *\n * @public\n */\nexport type TechDocsCustomHomeProps = {\n tabsConfig: TabsConfig;\n};\n\nexport const TechDocsCustomHome = (props: TechDocsCustomHomeProps) => {\n const { tabsConfig } = props;\n const [selectedTab, setSelectedTab] = useState<number>(0);\n const catalogApi: CatalogApi = useApi(catalogApiRef);\n\n const {\n value: entities,\n loading,\n error,\n } = useAsync(async () => {\n const response = await catalogApi.getEntities({\n filter: {\n 'metadata.annotations.backstage.io/techdocs-ref': CATALOG_FILTER_EXISTS,\n },\n fields: [\n 'apiVersion',\n 'kind',\n 'metadata',\n 'relations',\n 'spec.owner',\n 'spec.type',\n ],\n });\n return response.items.filter((entity: Entity) => {\n return !!entity.metadata.annotations?.['backstage.io/techdocs-ref'];\n });\n });\n\n const currentTabConfig = tabsConfig[selectedTab];\n\n if (loading) {\n return (\n <TechDocsPageWrapper>\n <Content>\n <Progress />\n </Content>\n </TechDocsPageWrapper>\n );\n }\n\n if (error) {\n return (\n <TechDocsPageWrapper>\n <Content>\n <WarningPanel\n severity=\"error\"\n title=\"Could not load available documentation.\"\n >\n <CodeSnippet language=\"text\" text={error.toString()} />\n </WarningPanel>\n </Content>\n </TechDocsPageWrapper>\n );\n }\n\n return (\n <TechDocsPageWrapper>\n <HeaderTabs\n selectedIndex={selectedTab}\n onChange={index => setSelectedTab(index)}\n tabs={tabsConfig.map(({ label }, index) => ({\n id: index.toString(),\n label,\n }))}\n />\n <Content data-testid=\"techdocs-content\">\n {currentTabConfig.panels.map((config, index) => (\n <CustomPanel\n key={index}\n config={config}\n entities={!!entities ? entities : []}\n index={index}\n />\n ))}\n </Content>\n </TechDocsPageWrapper>\n );\n};\n"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AA0CA,MAAM,MAAS,GAAA;AAAA,EACb,SAAA;AAAA,EACA,YAAA;AAAA,CAAA,CAAA;AAwCF,MAAM,cAAc,CAAC;AAAA,EACnB,MAAA;AAAA,EACA,QAAA;AAAA,EACA,KAAA;AAAA,CAKI,KAAA;AACJ,EAAA,MAAM,YAAY,UAAW,CAAA;AAAA,IAC3B,cAAgB,EAAA;AAAA,MACd,YAAc,EAAA,MAAA;AAAA,MACV,GAAA,MAAA,CAAO,QAAW,GAAA,MAAA,CAAO,QAAW,GAAA,EAAA;AAAA,KAAA;AAAA,GAAA,CAAA,CAAA;AAG5C,EAAA,MAAM,OAAU,GAAA,SAAA,EAAA,CAAA;AAChB,EAAM,MAAA,EAAE,OAAS,EAAA,gBAAA,EAAkB,aAAkB,EAAA,GAAA,kBAAA,EAAA,CAAA;AAErD,EAAM,MAAA,KAAA,GAAQ,OAAO,MAAO,CAAA,SAAA,CAAA,CAAA;AAE5B,EAAM,MAAA,aAAA,GAAgB,QAAS,CAAA,MAAA,CAAO,CAAU,MAAA,KAAA;AAC9C,IAAI,IAAA,MAAA,CAAO,oBAAoB,aAAe,EAAA;AAC5C,MAAA,IAAI,gBAAkB,EAAA;AACpB,QAAO,OAAA,KAAA,CAAA;AAAA,OAAA;AAET,MAAA,OAAO,aAAc,CAAA,MAAA,CAAA,CAAA;AAAA,KAAA;AAGvB,IAAA,OACE,OAAO,MAAA,CAAO,eAAoB,KAAA,UAAA,IAClC,OAAO,eAAgB,CAAA,MAAA,CAAA,CAAA;AAAA,GAAA,CAAA,CAAA;AAI3B,EACE,uBAAA,KAAA,CAAA,aAAA,CAAA,KAAA,CAAA,QAAA,EAAA,IAAA,sCACG,aAAD,EAAA;AAAA,IAAe,OAAO,MAAO,CAAA,KAAA;AAAA,IAAO,aAAa,MAAO,CAAA,WAAA;AAAA,GACrD,EAAA,KAAA,KAAU,oBACR,KAAA,CAAA,aAAA,CAAA,aAAA,EAAD,MAAe,2CAGb,CAAA,GAAA,IAAA,CAAA,sCAEL,KAAD,EAAA;AAAA,IAAK,WAAW,OAAQ,CAAA,cAAA;AAAA,GAAA,sCACrB,KAAD,EAAA;AAAA,IAAO,aAAY,EAAA,uBAAA;AAAA,IAAwB,QAAU,EAAA,aAAA;AAAA,GAAA,CAAA,CAAA,CAAA,CAAA;AAAA,CAAA,CAAA;AAehD,MAAA,kBAAA,GAAqB,CAAC,KAAmC,KAAA;AACpE,EAAA,MAAM,EAAE,UAAe,EAAA,GAAA,KAAA,CAAA;AACvB,EAAM,MAAA,CAAC,WAAa,EAAA,cAAA,CAAA,GAAkB,QAAiB,CAAA,CAAA,CAAA,CAAA;AACvD,EAAA,MAAM,aAAyB,MAAO,CAAA,aAAA,CAAA,CAAA;AAEtC,EAAM,MAAA;AAAA,IACJ,KAAO,EAAA,QAAA;AAAA,IACP,OAAA;AAAA,IACA,KAAA;AAAA,GAAA,GACE,SAAS,YAAY;AACvB,IAAM,MAAA,QAAA,GAAW,MAAM,UAAA,CAAW,WAAY,CAAA;AAAA,MAC5C,MAAQ,EAAA;AAAA,QACN,gDAAkD,EAAA,qBAAA;AAAA,OAAA;AAAA,MAEpD,MAAQ,EAAA;AAAA,QACN,YAAA;AAAA,QACA,MAAA;AAAA,QACA,UAAA;AAAA,QACA,WAAA;AAAA,QACA,YAAA;AAAA,QACA,WAAA;AAAA,OAAA;AAAA,KAAA,CAAA,CAAA;AAGJ,IAAA,OAAO,QAAS,CAAA,KAAA,CAAM,MAAO,CAAA,CAAC,MAAmB,KAAA;AAtKrD,MAAA,IAAA,EAAA,CAAA;AAuKM,MAAA,OAAO,CAAC,EAAQ,CAAA,EAAA,GAAA,MAAA,CAAA,QAAA,CAAS,gBAAhB,IAA8B,GAAA,KAAA,CAAA,GAAA,EAAA,CAAA,2BAAA,CAAA,CAAA,CAAA;AAAA,KAAA,CAAA,CAAA;AAAA,GAAA,CAAA,CAAA;AAI3C,EAAA,MAAM,mBAAmB,UAAW,CAAA,WAAA,CAAA,CAAA;AAEpC,EAAA,IAAI,OAAS,EAAA;AACX,IAAA,2CACG,mBAAD,EAAA,IAAA,sCACG,OAAD,EAAA,IAAA,sCACG,QAAD,EAAA,IAAA,CAAA,CAAA,CAAA,CAAA;AAAA,GAAA;AAMR,EAAA,IAAI,KAAO,EAAA;AACT,IAAA,2CACG,mBAAD,EAAA,IAAA,sCACG,OAAD,EAAA,IAAA,sCACG,YAAD,EAAA;AAAA,MACE,QAAS,EAAA,OAAA;AAAA,MACT,KAAM,EAAA,yCAAA;AAAA,KAAA,sCAEL,WAAD,EAAA;AAAA,MAAa,QAAS,EAAA,MAAA;AAAA,MAAO,MAAM,KAAM,CAAA,QAAA,EAAA;AAAA,KAAA,CAAA,CAAA,CAAA,CAAA,CAAA;AAAA,GAAA;AAOnD,EAAA,uBACG,KAAA,CAAA,aAAA,CAAA,mBAAA,EAAD,IACE,kBAAA,KAAA,CAAA,aAAA,CAAC,UAAD,EAAA;AAAA,IACE,aAAe,EAAA,WAAA;AAAA,IACf,QAAA,EAAU,WAAS,cAAe,CAAA,KAAA,CAAA;AAAA,IAClC,MAAM,UAAW,CAAA,GAAA,CAAI,CAAC,EAAE,SAAS,KAAW,MAAA;AAAA,MAC1C,IAAI,KAAM,CAAA,QAAA,EAAA;AAAA,MACV,KAAA;AAAA,KAAA,CAAA,CAAA;AAAA,GAAA,CAAA,sCAGH,OAAD,EAAA;AAAA,IAAS,aAAY,EAAA,kBAAA;AAAA,GAAA,EAClB,iBAAiB,MAAO,CAAA,GAAA,CAAI,CAAC,MAAQ,EAAA,KAAA,yCACnC,WAAD,EAAA;AAAA,IACE,GAAK,EAAA,KAAA;AAAA,IACL,MAAA;AAAA,IACA,QAAU,EAAA,CAAC,CAAC,QAAA,GAAW,QAAW,GAAA,EAAA;AAAA,IAClC,KAAA;AAAA,GAAA,CAAA,CAAA,CAAA,CAAA,CAAA;AAAA;;;;"}
1
+ {"version":3,"file":"TechDocsCustomHome-e38e305b.esm.js","sources":["../../src/home/components/TechDocsCustomHome.tsx"],"sourcesContent":["/*\n * Copyright 2021 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 React, { useState } from 'react';\nimport useAsync from 'react-use/lib/useAsync';\nimport { makeStyles } from '@material-ui/core';\nimport { CSSProperties } from '@material-ui/styles';\nimport {\n CATALOG_FILTER_EXISTS,\n catalogApiRef,\n CatalogApi,\n useEntityOwnership,\n} from '@backstage/plugin-catalog-react';\nimport { Entity } from '@backstage/catalog-model';\nimport { DocsTable } from './Tables';\nimport { DocsCardGrid } from './Grids';\nimport { TechDocsPageWrapper } from './TechDocsPageWrapper';\n\nimport {\n CodeSnippet,\n Content,\n HeaderTabs,\n Progress,\n WarningPanel,\n SupportButton,\n ContentHeader,\n} from '@backstage/core-components';\nimport { useApi } from '@backstage/core-plugin-api';\n\nconst panels = {\n DocsTable: DocsTable,\n DocsCardGrid: DocsCardGrid,\n};\n\n/**\n * Available panel types\n *\n * @public\n */\nexport type PanelType = 'DocsCardGrid' | 'DocsTable';\n\n/**\n * Type representing a TechDocsCustomHome panel.\n *\n * @public\n */\nexport interface PanelConfig {\n title: string;\n description: string;\n panelType: PanelType;\n panelCSS?: CSSProperties;\n filterPredicate: ((entity: Entity) => boolean) | string;\n}\n\n/**\n * Type representing a TechDocsCustomHome tab.\n *\n * @public\n */\nexport interface TabConfig {\n label: string;\n panels: PanelConfig[];\n}\n\n/**\n * Type representing a list of TechDocsCustomHome tabs.\n *\n * @public\n */\nexport type TabsConfig = TabConfig[];\n\nconst CustomPanel = ({\n config,\n entities,\n index,\n}: {\n config: PanelConfig;\n entities: Entity[];\n index: number;\n}) => {\n const useStyles = makeStyles({\n panelContainer: {\n marginBottom: '2rem',\n ...(config.panelCSS ? config.panelCSS : {}),\n },\n });\n const classes = useStyles();\n const { loading: loadingOwnership, isOwnedEntity } = useEntityOwnership();\n\n const Panel = panels[config.panelType];\n\n const shownEntities = entities.filter(entity => {\n if (config.filterPredicate === 'ownedByUser') {\n if (loadingOwnership) {\n return false;\n }\n return isOwnedEntity(entity);\n }\n\n return (\n typeof config.filterPredicate === 'function' &&\n config.filterPredicate(entity)\n );\n });\n\n return (\n <>\n <ContentHeader title={config.title} description={config.description}>\n {index === 0 ? (\n <SupportButton>\n Discover documentation in your ecosystem.\n </SupportButton>\n ) : null}\n </ContentHeader>\n <div className={classes.panelContainer}>\n <Panel data-testid=\"techdocs-custom-panel\" entities={shownEntities} />\n </div>\n </>\n );\n};\n\n/**\n * Props for {@link TechDocsCustomHome}\n *\n * @public\n */\nexport type TechDocsCustomHomeProps = {\n tabsConfig: TabsConfig;\n};\n\nexport const TechDocsCustomHome = (props: TechDocsCustomHomeProps) => {\n const { tabsConfig } = props;\n const [selectedTab, setSelectedTab] = useState<number>(0);\n const catalogApi: CatalogApi = useApi(catalogApiRef);\n\n const {\n value: entities,\n loading,\n error,\n } = useAsync(async () => {\n const response = await catalogApi.getEntities({\n filter: {\n 'metadata.annotations.backstage.io/techdocs-ref': CATALOG_FILTER_EXISTS,\n },\n fields: [\n 'apiVersion',\n 'kind',\n 'metadata',\n 'relations',\n 'spec.owner',\n 'spec.type',\n ],\n });\n return response.items.filter((entity: Entity) => {\n return !!entity.metadata.annotations?.['backstage.io/techdocs-ref'];\n });\n });\n\n const currentTabConfig = tabsConfig[selectedTab];\n\n if (loading) {\n return (\n <TechDocsPageWrapper>\n <Content>\n <Progress />\n </Content>\n </TechDocsPageWrapper>\n );\n }\n\n if (error) {\n return (\n <TechDocsPageWrapper>\n <Content>\n <WarningPanel\n severity=\"error\"\n title=\"Could not load available documentation.\"\n >\n <CodeSnippet language=\"text\" text={error.toString()} />\n </WarningPanel>\n </Content>\n </TechDocsPageWrapper>\n );\n }\n\n return (\n <TechDocsPageWrapper>\n <HeaderTabs\n selectedIndex={selectedTab}\n onChange={index => setSelectedTab(index)}\n tabs={tabsConfig.map(({ label }, index) => ({\n id: index.toString(),\n label,\n }))}\n />\n <Content data-testid=\"techdocs-content\">\n {currentTabConfig.panels.map((config, index) => (\n <CustomPanel\n key={index}\n config={config}\n entities={!!entities ? entities : []}\n index={index}\n />\n ))}\n </Content>\n </TechDocsPageWrapper>\n );\n};\n"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AA0CA,MAAM,MAAS,GAAA;AAAA,EACb,SAAA;AAAA,EACA,YAAA;AACF,CAAA,CAAA;AAuCA,MAAM,cAAc,CAAC;AAAA,EACnB,MAAA;AAAA,EACA,QAAA;AAAA,EACA,KAAA;AAAA,CAKI,KAAA;AACJ,EAAA,MAAM,YAAY,UAAW,CAAA;AAAA,IAC3B,cAAgB,EAAA;AAAA,MACd,YAAc,EAAA,MAAA;AAAA,MAAA,GACV,MAAO,CAAA,QAAA,GAAW,MAAO,CAAA,QAAA,GAAW,EAAC;AAAA,KAC3C;AAAA,GACD,CAAA,CAAA;AACD,EAAA,MAAM,UAAU,SAAU,EAAA,CAAA;AAC1B,EAAA,MAAM,EAAE,OAAA,EAAS,gBAAkB,EAAA,aAAA,EAAA,GAAkB,kBAAmB,EAAA,CAAA;AAExE,EAAM,MAAA,KAAA,GAAQ,OAAO,MAAO,CAAA,SAAA,CAAA,CAAA;AAE5B,EAAM,MAAA,aAAA,GAAgB,QAAS,CAAA,MAAA,CAAO,CAAU,MAAA,KAAA;AAC9C,IAAI,IAAA,MAAA,CAAO,oBAAoB,aAAe,EAAA;AAC5C,MAAA,IAAI,gBAAkB,EAAA;AACpB,QAAO,OAAA,KAAA,CAAA;AAAA,OACT;AACA,MAAA,OAAO,cAAc,MAAM,CAAA,CAAA;AAAA,KAC7B;AAEA,IAAA,OACE,OAAO,MAAO,CAAA,eAAA,KAAoB,UAClC,IAAA,MAAA,CAAO,gBAAgB,MAAM,CAAA,CAAA;AAAA,GAEhC,CAAA,CAAA;AAED,EAAA,iFAEK,KAAA,CAAA,aAAA,CAAA,aAAA,EAAA;AAAA,IAAc,OAAO,MAAO,CAAA,KAAA;AAAA,IAAO,aAAa,MAAO,CAAA,WAAA;AAAA,GACrD,EAAA,KAAA,KAAU,oBACR,KAAA,CAAA,aAAA,CAAA,aAAA,EAAA,IAAA,EAAc,2CAEf,CACE,GAAA,IACN,mBACC,KAAA,CAAA,aAAA,CAAA,KAAA,EAAA;AAAA,IAAI,WAAW,OAAQ,CAAA,cAAA;AAAA,GAAA,kBACrB,KAAA,CAAA,aAAA,CAAA,KAAA,EAAA;AAAA,IAAM,aAAY,EAAA,uBAAA;AAAA,IAAwB,QAAU,EAAA,aAAA;AAAA,GAAe,CACtE,CACF,CAAA,CAAA;AAEJ,CAAA,CAAA;AAWa,MAAA,kBAAA,GAAqB,CAAC,KAAmC,KAAA;AACpE,EAAA,MAAM,EAAE,UAAe,EAAA,GAAA,KAAA,CAAA;AACvB,EAAA,MAAM,CAAC,WAAA,EAAa,cAAkB,CAAA,GAAA,QAAA,CAAiB,CAAC,CAAA,CAAA;AACxD,EAAM,MAAA,UAAA,GAAyB,OAAO,aAAa,CAAA,CAAA;AAEnD,EAAM,MAAA;AAAA,IACJ,KAAO,EAAA,QAAA;AAAA,IACP,OAAA;AAAA,IACA,KAAA;AAAA,GAAA,GACE,SAAS,YAAY;AACvB,IAAM,MAAA,QAAA,GAAW,MAAM,UAAA,CAAW,WAAY,CAAA;AAAA,MAC5C,MAAQ,EAAA;AAAA,QACN,gDAAkD,EAAA,qBAAA;AAAA,OACpD;AAAA,MACA,MAAQ,EAAA;AAAA,QACN,YAAA;AAAA,QACA,MAAA;AAAA,QACA,UAAA;AAAA,QACA,WAAA;AAAA,QACA,YAAA;AAAA,QACA,WAAA;AAAA,OACF;AAAA,KACD,CAAA,CAAA;AACD,IAAA,OAAO,QAAS,CAAA,KAAA,CAAM,MAAO,CAAA,CAAC,MAAmB,KAAA;AAtKrD,MAAA,IAAA,EAAA,CAAA;AAuKM,MAAA,OAAO,CAAC,EAAQ,CAAA,EAAA,GAAA,MAAA,CAAA,QAAA,CAAS,gBAAhB,IAA8B,GAAA,KAAA,CAAA,GAAA,EAAA,CAAA,2BAAA,CAAA,CAAA,CAAA;AAAA,KACxC,CAAA,CAAA;AAAA,GACF,CAAA,CAAA;AAED,EAAA,MAAM,mBAAmB,UAAW,CAAA,WAAA,CAAA,CAAA;AAEpC,EAAA,IAAI,OAAS,EAAA;AACX,IAAA,2CACG,mBACC,EAAA,IAAA,kBAAA,KAAA,CAAA,aAAA,CAAC,+BACE,KAAA,CAAA,aAAA,CAAA,QAAA,EAAA,IAAS,CACZ,CACF,CAAA,CAAA;AAAA,GAEJ;AAEA,EAAA,IAAI,KAAO,EAAA;AACT,IAAA,uBACG,KAAA,CAAA,aAAA,CAAA,mBAAA,EAAA,IAAA,kBACE,KAAA,CAAA,aAAA,CAAA,OAAA,EAAA,IAAA,kBACE,KAAA,CAAA,aAAA,CAAA,YAAA,EAAA;AAAA,MACC,QAAS,EAAA,OAAA;AAAA,MACT,KAAM,EAAA,yCAAA;AAAA,KAAA,kBAEL,KAAA,CAAA,aAAA,CAAA,WAAA,EAAA;AAAA,MAAY,QAAS,EAAA,MAAA;AAAA,MAAO,IAAA,EAAM,MAAM,QAAS,EAAA;AAAA,KAAG,CACvD,CACF,CACF,CAAA,CAAA;AAAA,GAEJ;AAEA,EACE,uBAAA,KAAA,CAAA,aAAA,CAAC,2CACE,KAAA,CAAA,aAAA,CAAA,UAAA,EAAA;AAAA,IACC,aAAe,EAAA,WAAA;AAAA,IACf,QAAA,EAAU,CAAS,KAAA,KAAA,cAAA,CAAe,KAAK,CAAA;AAAA,IACvC,MAAM,UAAW,CAAA,GAAA,CAAI,CAAC,EAAE,SAAS,KAAW,MAAA;AAAA,MAC1C,EAAA,EAAI,MAAM,QAAS,EAAA;AAAA,MACnB,KAAA;AAAA,KACA,CAAA,CAAA;AAAA,GACJ,mBACC,KAAA,CAAA,aAAA,CAAA,OAAA,EAAA;AAAA,IAAQ,aAAY,EAAA,kBAAA;AAAA,GAAA,EAClB,iBAAiB,MAAO,CAAA,GAAA,CAAI,CAAC,MAAA,EAAQ,0BACnC,KAAA,CAAA,aAAA,CAAA,WAAA,EAAA;AAAA,IACC,GAAK,EAAA,KAAA;AAAA,IACL,MAAA;AAAA,IACA,QAAU,EAAA,CAAC,CAAC,QAAA,GAAW,WAAW,EAAC;AAAA,IACnC,KAAA;AAAA,GACF,CACD,CACH,CACF,CAAA,CAAA;AAEJ;;;;"}
package/dist/index.esm.js CHANGED
@@ -5,7 +5,7 @@ import React, { useState, useCallback, useEffect, useReducer, useRef, useMemo, c
5
5
  import { useNavigate as useNavigate$1, useParams, Routes, Route } from 'react-router-dom';
6
6
  import { withStyles, Tooltip, ThemeProvider, SvgIcon, makeStyles, ListItemText, ListItem, Divider, TextField, InputAdornment, IconButton, CircularProgress, createStyles, Button, Drawer, Grid, Typography, useTheme, lighten, alpha, Card, CardMedia, CardContent, CardActions } from '@material-ui/core';
7
7
  import { scmIntegrationsApiRef } from '@backstage/integration-react';
8
- import { Link, LogViewer, ErrorPage, Progress, SidebarPinStateContext, HeaderLabel, Header, ItemCardGrid, ItemCardHeader, Button as Button$1, WarningPanel, CodeSnippet, SubvalueCell, Table, EmptyState, PageWithHeader, Content, ContentHeader, SupportButton, Page, MissingAnnotationEmptyState } from '@backstage/core-components';
8
+ import { Link, LogViewer, ErrorPage, Progress, SidebarPinStateContext, sidebarConfig, HeaderLabel, Header, ItemCardGrid, ItemCardHeader, Button as Button$1, WarningPanel, CodeSnippet, SubvalueCell, Table, EmptyState, PageWithHeader, Content, ContentHeader, SupportButton, Page, MissingAnnotationEmptyState } from '@backstage/core-components';
9
9
  import { replaceGitHubUrlType } from '@backstage/integration';
10
10
  import FeedbackOutlinedIcon from '@material-ui/icons/FeedbackOutlined';
11
11
  import ReactDOM from 'react-dom';
@@ -243,10 +243,11 @@ const addSidebarToggle = () => {
243
243
  }
244
244
  const toggleSidebar = mkdocsToggleSidebar.cloneNode();
245
245
  ReactDOM.render(React.createElement(MenuIcon), toggleSidebar);
246
- toggleSidebar.style.paddingLeft = "5px";
247
- toggleSidebar.classList.add("md-content__button");
248
- toggleSidebar.title = "Toggle Sidebar";
249
246
  toggleSidebar.id = "toggle-sidebar";
247
+ toggleSidebar.title = "Toggle Sidebar";
248
+ toggleSidebar.classList.add("md-content__button");
249
+ toggleSidebar.style.setProperty("padding", "0 0 0 5px");
250
+ toggleSidebar.style.setProperty("margin", "0.4rem 0 0.4rem 0.4rem");
250
251
  article == null ? void 0 : article.prepend(toggleSidebar);
251
252
  return dom;
252
253
  };
@@ -464,7 +465,7 @@ const scrollIntoAnchor = () => {
464
465
  var _a;
465
466
  if (window.location.hash) {
466
467
  const hash = window.location.hash.slice(1);
467
- (_a = dom == null ? void 0 : dom.querySelector(`#${hash}`)) == null ? void 0 : _a.scrollIntoView();
468
+ (_a = dom == null ? void 0 : dom.querySelector(`[id="${hash}"]`)) == null ? void 0 : _a.scrollIntoView();
468
469
  }
469
470
  }, 200);
470
471
  return dom;
@@ -1218,12 +1219,6 @@ const useTechDocsReaderDom = (entityRef) => {
1218
1219
  scrollbar-color: rgb(193, 193, 193) #eee;
1219
1220
  scrollbar-width: thin;
1220
1221
  }
1221
- .md-sidebar .md-sidebar__scrollwrap {
1222
- width: calc(16rem - 10px);
1223
- }
1224
- .md-sidebar--secondary {
1225
- right: ${theme.spacing(3)}px;
1226
- }
1227
1222
  .md-sidebar::-webkit-scrollbar {
1228
1223
  width: 5px;
1229
1224
  }
@@ -1246,6 +1241,12 @@ const useTechDocsReaderDom = (entityRef) => {
1246
1241
  .md-sidebar::-webkit-scrollbar-thumb:hover {
1247
1242
  background: rgb(125, 125, 125);
1248
1243
  }
1244
+ .md-sidebar--secondary {
1245
+ right: ${theme.spacing(3)}px;
1246
+ }
1247
+ .md-sidebar__scrollwrap {
1248
+ overflow: unset !important;
1249
+ }
1249
1250
 
1250
1251
  .md-content {
1251
1252
  max-width: calc(100% - 16rem * 2);
@@ -1260,7 +1261,7 @@ const useTechDocsReaderDom = (entityRef) => {
1260
1261
  .md-footer__title {
1261
1262
  background-color: unset;
1262
1263
  }
1263
- .md-footer-nav__link {
1264
+ .md-footer__link, .md-footer-nav__link {
1264
1265
  width: 16rem;
1265
1266
  }
1266
1267
 
@@ -1324,18 +1325,28 @@ const useTechDocsReaderDom = (entityRef) => {
1324
1325
  height: 100%;
1325
1326
  }
1326
1327
  .md-sidebar--primary {
1327
- width: 12.1rem !important;
1328
+ width: 16rem !important;
1328
1329
  z-index: 200;
1329
- left: ${isPinned ? "calc(-12.1rem + 242px)" : "calc(-12.1rem + 72px)"} !important;
1330
+ left: ${isPinned ? `calc(-16rem + ${sidebarConfig.drawerWidthOpen}px)` : `calc(-16rem + ${sidebarConfig.drawerWidthClosed}px)`} !important;
1330
1331
  }
1331
1332
  .md-sidebar--secondary:not([hidden]) {
1332
1333
  display: none;
1333
1334
  }
1335
+ [data-md-toggle=drawer]:checked~.md-container .md-sidebar--primary {
1336
+ transform: translateX(16rem);
1337
+ }
1334
1338
 
1335
1339
  .md-content {
1336
1340
  max-width: 100%;
1337
1341
  margin-left: 0;
1338
1342
  }
1343
+ .md-content__inner {
1344
+ margin: 0;
1345
+ }
1346
+ .md-content__inner .highlighttable {
1347
+ max-width: 100%;
1348
+ margin: 1em 0;
1349
+ }
1339
1350
 
1340
1351
  .md-header__button {
1341
1352
  margin: 0.4rem 0;
@@ -1351,7 +1362,7 @@ const useTechDocsReaderDom = (entityRef) => {
1351
1362
  position: static;
1352
1363
  padding-left: 0;
1353
1364
  }
1354
- .md-footer-nav__link {
1365
+ .md-footer__link, .md-footer-nav__link {
1355
1366
  /* footer links begin to overlap at small sizes without setting width */
1356
1367
  width: 50%;
1357
1368
  }
@@ -1359,8 +1370,11 @@ const useTechDocsReaderDom = (entityRef) => {
1359
1370
 
1360
1371
  @media screen and (max-width: 600px) {
1361
1372
  .md-sidebar--primary {
1362
- left: -12.1rem !important;
1363
- width: 12.1rem;
1373
+ left: -16rem !important;
1374
+ width: 16rem;
1375
+ }
1376
+ .md-sidebar--primary .md-sidebar__scrollwrap {
1377
+ bottom: ${sidebarConfig.mobileSidebarHeight}px;
1364
1378
  }
1365
1379
  }
1366
1380
  `
@@ -1463,7 +1477,7 @@ const useTechDocsReaderDom = (entityRef) => {
1463
1477
  .highlight .md-clipboard:after {
1464
1478
  content: unset;
1465
1479
  }
1466
-
1480
+
1467
1481
  .highlight .nx {
1468
1482
  color: ${isDarkTheme ? "#ff53a3" : "#ec407a"};
1469
1483
  }
@@ -1551,7 +1565,7 @@ const useTechDocsReaderDom = (entityRef) => {
1551
1565
  window.open(`${parsedUrl.pathname}${parsedUrl.hash}`, "_blank");
1552
1566
  } else {
1553
1567
  navigate(`${parsedUrl.pathname}${parsedUrl.hash}`);
1554
- (_a = transformedElement == null ? void 0 : transformedElement.querySelector(`#${parsedUrl.hash.slice(1)}`)) == null ? void 0 : _a.scrollIntoView();
1568
+ (_a = transformedElement == null ? void 0 : transformedElement.querySelector(`[id='${parsedUrl.hash.slice(1)}']`)) == null ? void 0 : _a.scrollIntoView();
1555
1569
  }
1556
1570
  } else {
1557
1571
  if (modifierActive) {
@@ -1995,7 +2009,7 @@ const EntityTechdocsContent = techdocsPlugin.provide(createRoutableExtension({
1995
2009
  }));
1996
2010
  const TechDocsCustomHome = techdocsPlugin.provide(createRoutableExtension({
1997
2011
  name: "TechDocsCustomHome",
1998
- component: () => import('./esm/TechDocsCustomHome-174c6f0d.esm.js').then((m) => m.TechDocsCustomHome),
2012
+ component: () => import('./esm/TechDocsCustomHome-e38e305b.esm.js').then((m) => m.TechDocsCustomHome),
1999
2013
  mountPoint: rootRouteRef
2000
2014
  }));
2001
2015
  const TechDocsIndexPage$2 = techdocsPlugin.provide(createRoutableExtension({