@equinor/echo-framework 0.26.9 → 0.26.10

package/package.json

@@ -1,12 +1,12 @@
 {
   "name": "@equinor/echo-framework",
-  "version": "0.26.9",
+  "version": "0.26.10",
   "peerDependencies": {
     "@equinor/echo-base": ">= 0.26.8 < 0.27.0",
     "@equinor/echo-components": ">= 0.26.9 < 0.27.0",
-    "@equinor/echo-core": ">= 0.26.8 < 0.27.0",
+    "@equinor/echo-core": ">= 0.26.9 < 0.27.0",
     "@equinor/echo-search": ">= 0.26.8 < 0.27.0",
-    "@equinor/echo-utils": ">= 0.26.9 < 0.27.0",
+    "@equinor/echo-utils": ">= 0.26.10 < 0.27.0",
     "@equinor/eds-core-react": "0.43.0",
     "@equinor/eds-icons": "0.22.0",
     "react": ">= 17.0.2",

package/src/index.d.ts

@@ -100,6 +100,8 @@ declare const EchoFramework: Readonly<{
             sapPlantId: string | undefined;
         }) => string | undefined;
         useIsFullScreenModeEnabled(): boolean;
+        disableFullScreenMode: () => void;
+        enableFullScreenMode: () => void;
         useOpenPdfFile(): (args: {
             instCode: string;
             docNo: string;

package/src/lib/components/fullScreenButtons/FullScreenModeChip.d.ts

@@ -1,5 +1,14 @@
 interface FullScreenModeChipProps {
     className?: string;
 }
+/**
+ * Renders a chip component that allows users to toggle full screen mode.
+ * This makes the application header and sidebar disappear, providing a more immersive experience.
+ * The chip is only visible when full screen mode is enabled and the chip visibility state is true.
+ *
+ * The chip provides two actions:
+ * - Clicking the chip toggles the full screen mode.
+ * - Deleting the chip hides it from view.
+ */
 export declare const FullScreenModeChip: ({ className }: FullScreenModeChipProps) => false | import("react/jsx-runtime").JSX.Element;
 export {};

package/src/lib/hooks/useIsFullScreenModeEnabled.d.ts

@@ -1 +1,11 @@
+/**
+ * Custom hook that returns whether the full screen mode is enabled.
+ *
+ * Using this mode hides the header and footer of the application, providing a more immersive experience.
+ * Mainly used in PDF viewer and 3D.
+ *
+ * @returns {boolean} `true` if full screen mode is enabled, otherwise `false`.
+ */
 export declare function useIsFullScreenModeEnabled(): boolean;
+export declare const disableFullScreenMode: () => void;
+export declare const enableFullScreenMode: () => void;