@abgov/react-components 7.2.0-dev.11 → 7.2.0-dev.13

package/lib/scroll-panel/scroll-panel.d.ts

@@ -0,0 +1,32 @@
+import { DataAttributes } from '@abgov/ui-components-common';
+import { default as React, ReactNode, JSX } from 'react';
+interface WCProps {
+    height?: string;
+    testid?: string;
+}
+declare module "react" {
+    namespace JSX {
+        interface IntrinsicElements {
+            "goa-scroll-panel": WCProps & React.HTMLAttributes<HTMLElement>;
+        }
+    }
+}
+export interface GoabScrollPanelProps extends DataAttributes {
+    /** Content rendered in the sticky header region. */
+    header?: ReactNode;
+    /** Content rendered in the scrollable body region. */
+    children?: ReactNode;
+    /** Content rendered in the sticky footer region. */
+    footer?: ReactNode;
+    /**
+     * Sets the height of the panel. Accepts any valid CSS height value, including
+     * calc()/min()/clamp() and viewport units (e.g. "400px", "100%", "100vh",
+     * "calc(100vh - 4rem)"). Invalid values fall back to "100%". Defaults to "100%".
+     * The parent element must establish a height context for "100%" to resolve.
+     */
+    height?: string;
+    /** Sets a data-testid attribute for automated testing. */
+    testId?: string;
+}
+export declare function GoabScrollPanel({ header, children, footer, height, testId, ...rest }: GoabScrollPanelProps): JSX.Element;
+export default GoabScrollPanel;

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

@@ -0,0 +1,22 @@
+import { GoabWorkspaceLayoutScrollState } from '@abgov/ui-components-common';
+export interface GoabWorkspaceLayoutScrollStateValue {
+    scrollPosition: GoabWorkspaceLayoutScrollState;
+    isScrollable: boolean;
+}
+export declare const GoabWorkspaceLayoutScrollStateDefault: GoabWorkspaceLayoutScrollStateValue;
+/** @internal — provided by GoabWorkspaceLayout, consumed via the hook below. */
+export declare const GoabWorkspaceLayoutScrollStateContext: import('react').Context<GoabWorkspaceLayoutScrollStateValue>;
+/**
+ * Hook that returns the current scroll state of the nearest enclosing
+ * GoabWorkspaceLayout. Returns `{ scrollPosition: 'no-scroll', isScrollable: false }`
+ * if no layout is mounted.
+ *
+ * @example
+ * ```tsx
+ * const { scrollPosition, isScrollable } = useGoabWorkspaceLayoutScrollState();
+ * const isCollapsed =
+ *   scrollPosition === GoabWorkspaceLayoutScrollState.MIDDLE ||
+ *   scrollPosition === GoabWorkspaceLayoutScrollState.AT_BOTTOM;
+ * ```
+ */
+export declare function useGoabWorkspaceLayoutScrollState(): GoabWorkspaceLayoutScrollStateValue;

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.11",
+  "version": "7.2.0-dev.13",
   "description": "Government of Alberta - UI components for React",
   "bugs": {
     "url": "https://github.com/GovAlta/ui-components/issues"