@axis-backstage/plugin-readme 0.14.0 → 0.16.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
CHANGED
|
@@ -1,5 +1,17 @@
|
|
|
1
1
|
# @axis-backstage/plugin-readme
|
|
2
2
|
|
|
3
|
+
## 0.16.0
|
|
4
|
+
|
|
5
|
+
### Minor Changes
|
|
6
|
+
|
|
7
|
+
- db452c4: Updated to Backstage v1.42.5
|
|
8
|
+
|
|
9
|
+
## 0.15.0
|
|
10
|
+
|
|
11
|
+
### Minor Changes
|
|
12
|
+
|
|
13
|
+
- 2a2afb8: Add URL state management and update fullscreen icon
|
|
14
|
+
|
|
3
15
|
## 0.14.0
|
|
4
16
|
|
|
5
17
|
### Minor Changes
|
|
@@ -1,16 +1,16 @@
|
|
|
1
1
|
import { jsxs, Fragment, jsx } from 'react/jsx-runtime';
|
|
2
|
-
import { useState } from 'react';
|
|
3
2
|
import IconButton from '@mui/material/IconButton';
|
|
4
3
|
import Box from '@mui/material/Box';
|
|
4
|
+
import FullscreenIcon from '@mui/icons-material/Fullscreen';
|
|
5
5
|
import { InfoCard } from '@backstage/core-components';
|
|
6
6
|
import { FetchComponent } from '../FetchComponent/FetchComponent.esm.js';
|
|
7
|
-
import OpenInNewIcon from '@mui/icons-material/OpenInNew';
|
|
8
7
|
import { ReadmeDialog } from '../ReadmeDialog/ReadmeDialog.esm.js';
|
|
8
|
+
import { useFullViewParam } from '../../hooks/useFullViewParam.esm.js';
|
|
9
9
|
|
|
10
10
|
const ReadmeCard = (props) => {
|
|
11
11
|
const { variant = "gridItem", maxHeight: propMaxHeight } = props;
|
|
12
|
+
const [isFullViewOpen, setIsFullViewOpen] = useFullViewParam();
|
|
12
13
|
const maxHeight = variant === "fullHeight" ? "none" : propMaxHeight ?? "235px";
|
|
13
|
-
const [displayDialog, setDisplayDialog] = useState(false);
|
|
14
14
|
return /* @__PURE__ */ jsxs(Fragment, { children: [
|
|
15
15
|
/* @__PURE__ */ jsx(
|
|
16
16
|
InfoCard,
|
|
@@ -20,12 +20,11 @@ const ReadmeCard = (props) => {
|
|
|
20
20
|
action: variant !== "fullHeight" ? /* @__PURE__ */ jsx(
|
|
21
21
|
IconButton,
|
|
22
22
|
{
|
|
23
|
-
onClick: () =>
|
|
24
|
-
"aria-label": "
|
|
25
|
-
|
|
26
|
-
title: "Open in dialog",
|
|
23
|
+
onClick: () => setIsFullViewOpen(true),
|
|
24
|
+
"aria-label": "Open full view",
|
|
25
|
+
title: "Open full view",
|
|
27
26
|
size: "large",
|
|
28
|
-
children: /* @__PURE__ */ jsx(
|
|
27
|
+
children: /* @__PURE__ */ jsx(FullscreenIcon, {})
|
|
29
28
|
}
|
|
30
29
|
) : void 0,
|
|
31
30
|
children: /* @__PURE__ */ jsx("div", { style: { overflow: "auto" }, children: /* @__PURE__ */ jsx(Box, { maxHeight, children: /* @__PURE__ */ jsx(FetchComponent, {}) }) })
|
|
@@ -34,8 +33,8 @@ const ReadmeCard = (props) => {
|
|
|
34
33
|
/* @__PURE__ */ jsx(
|
|
35
34
|
ReadmeDialog,
|
|
36
35
|
{
|
|
37
|
-
open:
|
|
38
|
-
onClose: () =>
|
|
36
|
+
open: isFullViewOpen,
|
|
37
|
+
onClose: () => setIsFullViewOpen(false)
|
|
39
38
|
}
|
|
40
39
|
)
|
|
41
40
|
] });
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"ReadmeCard.esm.js","sources":["../../../src/components/ReadmeCard/ReadmeCard.tsx"],"sourcesContent":["import
|
|
1
|
+
{"version":3,"file":"ReadmeCard.esm.js","sources":["../../../src/components/ReadmeCard/ReadmeCard.tsx"],"sourcesContent":["import IconButton from '@mui/material/IconButton';\nimport Box from '@mui/material/Box';\nimport FullscreenIcon from '@mui/icons-material/Fullscreen';\nimport { InfoCard, InfoCardVariants } from '@backstage/core-components';\nimport { FetchComponent } from '../FetchComponent';\nimport { ReadmeDialog } from '../ReadmeDialog/ReadmeDialog';\nimport { useFullViewParam } from '../../hooks/useFullViewParam';\n\n/**\n * ReadmeCardProps props.\n *\n * @public\n */\nexport type ReadmeCardProps = {\n variant?: InfoCardVariants;\n maxHeight?: string | number;\n};\n\nexport const ReadmeCard = (props: ReadmeCardProps) => {\n const { variant = 'gridItem', maxHeight: propMaxHeight } = props;\n const [isFullViewOpen, setIsFullViewOpen] = useFullViewParam();\n\n const maxHeight =\n variant === 'fullHeight' ? 'none' : propMaxHeight ?? '235px';\n\n return (\n <>\n <InfoCard\n title=\"README\"\n variant={variant}\n action={\n variant !== 'fullHeight' ? (\n <IconButton\n onClick={() => setIsFullViewOpen(true)}\n aria-label=\"Open full view\"\n title=\"Open full view\"\n size=\"large\"\n >\n <FullscreenIcon />\n </IconButton>\n ) : undefined\n }\n >\n <div style={{ overflow: 'auto' }}>\n <Box maxHeight={maxHeight}>\n <FetchComponent />\n </Box>\n </div>\n </InfoCard>\n\n <ReadmeDialog\n open={isFullViewOpen}\n onClose={() => setIsFullViewOpen(false)}\n />\n </>\n );\n};\n"],"names":[],"mappings":";;;;;;;;;AAkBa,MAAA,UAAA,GAAa,CAAC,KAA2B,KAAA;AACpD,EAAA,MAAM,EAAE,OAAA,GAAU,UAAY,EAAA,SAAA,EAAW,eAAkB,GAAA,KAAA;AAC3D,EAAA,MAAM,CAAC,cAAA,EAAgB,iBAAiB,CAAA,GAAI,gBAAiB,EAAA;AAE7D,EAAA,MAAM,SACJ,GAAA,OAAA,KAAY,YAAe,GAAA,MAAA,GAAS,aAAiB,IAAA,OAAA;AAEvD,EAAA,uBAEI,IAAA,CAAA,QAAA,EAAA,EAAA,QAAA,EAAA;AAAA,oBAAA,GAAA;AAAA,MAAC,QAAA;AAAA,MAAA;AAAA,QACC,KAAM,EAAA,QAAA;AAAA,QACN,OAAA;AAAA,QACA,MAAA,EACE,YAAY,YACV,mBAAA,GAAA;AAAA,UAAC,UAAA;AAAA,UAAA;AAAA,YACC,OAAA,EAAS,MAAM,iBAAA,CAAkB,IAAI,CAAA;AAAA,YACrC,YAAW,EAAA,gBAAA;AAAA,YACX,KAAM,EAAA,gBAAA;AAAA,YACN,IAAK,EAAA,OAAA;AAAA,YAEL,8BAAC,cAAe,EAAA,EAAA;AAAA;AAAA,SAEhB,GAAA,MAAA;AAAA,QAGN,QAAC,kBAAA,GAAA,CAAA,KAAA,EAAA,EAAI,KAAO,EAAA,EAAE,QAAU,EAAA,MAAA,EACtB,EAAA,QAAA,kBAAA,GAAA,CAAC,GAAI,EAAA,EAAA,SAAA,EACH,QAAC,kBAAA,GAAA,CAAA,cAAA,EAAA,EAAe,GAClB,CACF,EAAA;AAAA;AAAA,KACF;AAAA,oBAEA,GAAA;AAAA,MAAC,YAAA;AAAA,MAAA;AAAA,QACC,IAAM,EAAA,cAAA;AAAA,QACN,OAAA,EAAS,MAAM,iBAAA,CAAkB,KAAK;AAAA;AAAA;AACxC,GACF,EAAA,CAAA;AAEJ;;;;"}
|
|
@@ -0,0 +1,24 @@
|
|
|
1
|
+
import { useLocation, useNavigate } from 'react-router-dom';
|
|
2
|
+
import { useMemo } from 'react';
|
|
3
|
+
|
|
4
|
+
const useFullViewParam = () => {
|
|
5
|
+
const location = useLocation();
|
|
6
|
+
const navigate = useNavigate();
|
|
7
|
+
const isFullView = useMemo(() => {
|
|
8
|
+
const params = new URLSearchParams(location.search);
|
|
9
|
+
return params.get("fullView") === "true";
|
|
10
|
+
}, [location.search]);
|
|
11
|
+
const setFullView = (open) => {
|
|
12
|
+
const params = new URLSearchParams(location.search);
|
|
13
|
+
if (open) {
|
|
14
|
+
params.set("fullView", "true");
|
|
15
|
+
} else {
|
|
16
|
+
params.delete("fullView");
|
|
17
|
+
}
|
|
18
|
+
navigate({ search: params.toString() }, { replace: true });
|
|
19
|
+
};
|
|
20
|
+
return [isFullView, setFullView];
|
|
21
|
+
};
|
|
22
|
+
|
|
23
|
+
export { useFullViewParam };
|
|
24
|
+
//# sourceMappingURL=useFullViewParam.esm.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"useFullViewParam.esm.js","sources":["../../src/hooks/useFullViewParam.ts"],"sourcesContent":["import { useLocation, useNavigate } from 'react-router-dom';\nimport { useMemo } from 'react';\n\nexport const useFullViewParam = (): [boolean, (open: boolean) => void] => {\n const location = useLocation();\n const navigate = useNavigate();\n\n const isFullView = useMemo(() => {\n const params = new URLSearchParams(location.search);\n return params.get('fullView') === 'true';\n }, [location.search]);\n\n const setFullView = (open: boolean) => {\n const params = new URLSearchParams(location.search);\n if (open) {\n params.set('fullView', 'true');\n } else {\n params.delete('fullView');\n }\n navigate({ search: params.toString() }, { replace: true });\n };\n\n return [isFullView, setFullView];\n};\n"],"names":[],"mappings":";;;AAGO,MAAM,mBAAmB,MAA0C;AACxE,EAAA,MAAM,WAAW,WAAY,EAAA;AAC7B,EAAA,MAAM,WAAW,WAAY,EAAA;AAE7B,EAAM,MAAA,UAAA,GAAa,QAAQ,MAAM;AAC/B,IAAA,MAAM,MAAS,GAAA,IAAI,eAAgB,CAAA,QAAA,CAAS,MAAM,CAAA;AAClD,IAAO,OAAA,MAAA,CAAO,GAAI,CAAA,UAAU,CAAM,KAAA,MAAA;AAAA,GACjC,EAAA,CAAC,QAAS,CAAA,MAAM,CAAC,CAAA;AAEpB,EAAM,MAAA,WAAA,GAAc,CAAC,IAAkB,KAAA;AACrC,IAAA,MAAM,MAAS,GAAA,IAAI,eAAgB,CAAA,QAAA,CAAS,MAAM,CAAA;AAClD,IAAA,IAAI,IAAM,EAAA;AACR,MAAO,MAAA,CAAA,GAAA,CAAI,YAAY,MAAM,CAAA;AAAA,KACxB,MAAA;AACL,MAAA,MAAA,CAAO,OAAO,UAAU,CAAA;AAAA;AAE1B,IAAS,QAAA,CAAA,EAAE,QAAQ,MAAO,CAAA,QAAA,IAAc,EAAA,EAAE,OAAS,EAAA,IAAA,EAAM,CAAA;AAAA,GAC3D;AAEA,EAAO,OAAA,CAAC,YAAY,WAAW,CAAA;AACjC;;;;"}
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@axis-backstage/plugin-readme",
|
|
3
|
-
"version": "0.
|
|
3
|
+
"version": "0.16.0",
|
|
4
4
|
"main": "dist/index.esm.js",
|
|
5
5
|
"types": "dist/index.d.ts",
|
|
6
6
|
"license": "Apache-2.0",
|
|
@@ -29,12 +29,12 @@
|
|
|
29
29
|
"postpack": "backstage-cli package postpack"
|
|
30
30
|
},
|
|
31
31
|
"dependencies": {
|
|
32
|
-
"@backstage/catalog-model": "^1.7.
|
|
33
|
-
"@backstage/core-components": "^0.17.
|
|
34
|
-
"@backstage/core-plugin-api": "^1.10.
|
|
32
|
+
"@backstage/catalog-model": "^1.7.5",
|
|
33
|
+
"@backstage/core-components": "^0.17.5",
|
|
34
|
+
"@backstage/core-plugin-api": "^1.10.9",
|
|
35
35
|
"@backstage/errors": "^1.2.7",
|
|
36
|
-
"@backstage/plugin-catalog-react": "^1.
|
|
37
|
-
"@backstage/theme": "^0.6.
|
|
36
|
+
"@backstage/plugin-catalog-react": "^1.20.1",
|
|
37
|
+
"@backstage/theme": "^0.6.8",
|
|
38
38
|
"@mui/icons-material": "^5.15.7",
|
|
39
39
|
"@mui/material": "^5.15.7",
|
|
40
40
|
"react-use": "^17.2.4"
|
|
@@ -46,10 +46,10 @@
|
|
|
46
46
|
"react-router-dom": "^6.3.0"
|
|
47
47
|
},
|
|
48
48
|
"devDependencies": {
|
|
49
|
-
"@backstage/cli": "^0.
|
|
50
|
-
"@backstage/core-app-api": "^1.
|
|
51
|
-
"@backstage/dev-utils": "^1.1.
|
|
52
|
-
"@backstage/test-utils": "^1.7.
|
|
49
|
+
"@backstage/cli": "^0.34.1",
|
|
50
|
+
"@backstage/core-app-api": "^1.18.0",
|
|
51
|
+
"@backstage/dev-utils": "^1.1.13",
|
|
52
|
+
"@backstage/test-utils": "^1.7.11",
|
|
53
53
|
"@testing-library/dom": "^10.0.0",
|
|
54
54
|
"@testing-library/jest-dom": "^6.0.0",
|
|
55
55
|
"@testing-library/react": "^16.0.0",
|