@abgov/react-components 7.2.0-dev.4 → 7.2.0-dev.40

package/lib/workspace-layout/workspace-layout.d.ts

@@ -0,0 +1,42 @@
+import { DataAttributes, GoabWorkspaceLayoutOnScrollStateChangeDetail } from '@abgov/ui-components-common';
+import { default as React, ReactNode, JSX } from 'react';
+interface WCProps {
+    testid?: string;
+}
+declare module "react" {
+    namespace JSX {
+        interface IntrinsicElements {
+            "goa-workspace-layout": WCProps & React.HTMLAttributes<HTMLElement> & {
+                ref: React.RefObject<HTMLElement | null>;
+            };
+        }
+    }
+}
+export interface GoabWorkspaceLayoutProps extends DataAttributes {
+    /** Content rendered in the side navigation region (e.g. work-side-menu). */
+    sideMenu?: ReactNode;
+    /** Content rendered in the sticky page header region. */
+    pageHeader?: ReactNode;
+    /** Content rendered in the sticky page footer region. */
+    pageFooter?: ReactNode;
+    /**
+     * A GoabPushDrawer rendered as a sibling of the main card, inside the same
+     * workspace shell. Use this slot when the page needs a push drawer alongside
+     * the workspace layout — it gives the drawer the shell-level height and flex
+     * context it expects, so the consumer does not have to wrap the layout in
+     * their own flex container. The side menu is not pushed; only the card is.
+     */
+    pushDrawer?: ReactNode;
+    /** Main scrollable content. */
+    children?: ReactNode;
+    /** Sets a data-testid attribute for automated testing. */
+    testId?: string;
+    /**
+     * Called whenever the internal scroll state changes (no-scroll → at-top →
+     * middle → at-bottom)
+     */
+    onScrollStateChange?: (detail: GoabWorkspaceLayoutOnScrollStateChangeDetail) => void;
+}
+export declare function GoabWorkspaceLayout({ sideMenu, pageHeader, pageFooter, pushDrawer, children, testId, onScrollStateChange, ...rest }: GoabWorkspaceLayoutProps): JSX.Element;
+export default GoabWorkspaceLayout;
+export { useGoabWorkspaceLayoutScrollState, type GoabWorkspaceLayoutScrollStateValue, } from './workspace-layout-scroll-state';

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@abgov/react-components",
-  "version": "7.2.0-dev.4",
+  "version": "7.2.0-dev.40",
   "description": "Government of Alberta - UI components for React",
   "bugs": {
     "url": "https://github.com/GovAlta/ui-components/issues"