feat: Handle full view though URL params

Author: Frida Englund

.changeset/silly-rooms-jog.md

@@ -0,0 +1,5 @@
+---
+'@axis-backstage/plugin-readme': minor
+---
+
+Add URL state management and update fullscreen icon

plugins/readme/media/readme-card.png

@@ -1,29 +1,29 @@
-import React, { useState } from 'react';
+import React from 'react';
 import IconButton from '@mui/material/IconButton';
 import Box from '@mui/material/Box';
+import FullscreenIcon from '@mui/icons-material/Fullscreen';
 import { InfoCard, InfoCardVariants } from '@backstage/core-components';
 import { FetchComponent } from '../FetchComponent';
-import FullscreenIcon from '@mui/icons-material/Fullscreen';
 import { ReadmeDialog } from '../ReadmeDialog/ReadmeDialog';
+import { useFullViewParam } from '../../hooks/useFullViewParam';
 
 /**
  * ReadmeCardProps props.
  *
  * @public
  */
-
 export type ReadmeCardProps = {
   variant?: InfoCardVariants;
   maxHeight?: string | number;
 };
 
 export const ReadmeCard = (props: ReadmeCardProps) => {
   const { variant = 'gridItem', maxHeight: propMaxHeight } = props;
+  const [isFullViewOpen, setIsFullViewOpen] = useFullViewParam();
+
   const maxHeight =
     variant === 'fullHeight' ? 'none' : propMaxHeight ?? '235px';
 
-  const [displayDialog, setDisplayDialog] = useState(false);
-
   return (
     <>
       <InfoCard
@@ -32,9 +32,8 @@ export const ReadmeCard = (props: ReadmeCardProps) => {
         action={
           variant !== 'fullHeight' ? (
             <IconButton
-              onClick={() => setDisplayDialog(true)}
+              onClick={() => setIsFullViewOpen(true)}
               aria-label="Open full view"
-              role="button"
               title="Open full view"
               size="large"
             >
@@ -51,8 +50,8 @@ export const ReadmeCard = (props: ReadmeCardProps) => {
       </InfoCard>
 
       <ReadmeDialog
-        open={displayDialog}
-        onClose={() => setDisplayDialog(false)}
+        open={isFullViewOpen}
+        onClose={() => setIsFullViewOpen(false)}
       />
     </>
   );

plugins/readme/media/readme.png

@@ -0,0 +1,24 @@
+import { useLocation, useNavigate } from 'react-router-dom';
+import { useMemo } from 'react';
+
+export const useFullViewParam = (): [boolean, (open: boolean) => void] => {
+  const location = useLocation();
+  const navigate = useNavigate();
+
+  const isFullView = useMemo(() => {
+    const params = new URLSearchParams(location.search);
+    return params.get('fullView') === 'true';
+  }, [location.search]);
+
+  const setFullView = (open: boolean) => {
+    const params = new URLSearchParams(location.search);
+    if (open) {
+      params.set('fullView', 'true');
+    } else {
+      params.delete('fullView');
+    }
+    navigate({ search: params.toString() }, { replace: true });
+  };
+
+  return [isFullView, setFullView];
+};