@abgov/react-components 7.0.0-dev.5 → 7.0.0-dev.6

package/lib/two-column-layout/two-column-layout.d.ts

@@ -11,12 +11,19 @@ declare module "react" {
     }
 }
 export interface GoabTwoColumnLayoutProps {
-    navColumnWidth?: string;
-    maxContentWidth?: string;
+    /** Content rendered in the page header slot. */
     header: ReactNode;
+    /** Content rendered in the page footer slot. */
     footer: ReactNode;
+    /** Content rendered in the navigation column slot. */
     nav: ReactNode;
+    /** @required Main content rendered in the body of the layout. */
     children: ReactNode;
+    /** Sets the width of the navigation column. */
+    navColumnWidth?: string;
+    /** Sets the maximum width of the content area. */
+    maxContentWidth?: string;
 }
+/** Organizes page content in two responsive columns. */
 export declare function GoabTwoColumnLayout(props: GoabTwoColumnLayoutProps): import("react/jsx-runtime").JSX.Element;
 export default GoabTwoColumnLayout;

package/lib/work-side-menu/work-side-menu.d.ts

@@ -19,17 +19,29 @@ declare module "react" {
     }
 }
 export interface GoabWorkSideMenuProps {
+    /** @required The application name displayed in the header. */
     heading: string;
+    /** @required URL for the header link. Clicking the logo/heading navigates to this URL. */
     url: string;
+    /** User's name displayed in the profile section. */
     userName?: string;
+    /** Secondary text displayed below the user's name, such as role or email. */
     userSecondaryText?: string;
+    /** Sets a data-testid attribute for automated testing. */
     testId?: string;
+    /** Content rendered in the primary navigation slot. */
     primaryContent?: ReactNode;
+    /** Content rendered in the secondary navigation slot. */
     secondaryContent?: ReactNode;
+    /** Content rendered in the account/profile slot. */
     accountContent?: ReactNode;
+    /** Controls whether the side menu is expanded or collapsed. */
     open?: boolean;
+    /** Callback fired when the side menu is toggled open or closed. */
     onToggle?: () => void;
+    /** Callback fired when a menu item is navigated, providing the target URL path. */
     onNavigate?: (path: string) => void;
 }
+/** Side menu variant for worker applications. */
 export declare function GoabWorkSideMenu({ heading, url, userName, userSecondaryText, testId, primaryContent, secondaryContent, accountContent, open, onToggle, onNavigate, }: GoabWorkSideMenuProps): JSX.Element;
 export default GoabWorkSideMenu;

package/lib/work-side-menu-group/work-side-menu-group.d.ts

@@ -14,11 +14,17 @@ declare module "react" {
     }
 }
 export interface GoabWorkSideMenuGroupProps {
+    /** @required The text displayed in the group heading. */
     heading: string;
+    /** Icon displayed before the group label. When omitted, no icon is rendered and no space is reserved. */
     icon?: GoabIconType;
+    /** Whether the group is open. */
     open?: boolean;
+    /** Sets a data-testid attribute for automated testing. */
     testId?: string;
+    /** Content rendered inside the group, typically WorkSideMenuItem components. */
     children?: React.ReactNode;
 }
+/** Collapsible group of items within the work side menu. */
 export declare function GoabWorkSideMenuGroup(props: GoabWorkSideMenuGroupProps): JSX.Element;
 export default GoabWorkSideMenuGroup;

package/lib/work-side-menu-item/work-side-menu-item.d.ts

@@ -18,16 +18,27 @@ declare module "react" {
     }
 }
 export interface GoabWorkSideMenuItemProps {
+    /** @required The text label displayed for the menu item. */
     label: string;
+    /** The URL the menu item links to. When absent, renders as a button instead of a link. */
     url?: string;
+    /** Badge text displayed alongside the menu item (e.g., notification count). */
     badge?: string;
+    /** When true, indicates this is the currently active menu item. */
     current?: boolean;
+    /** When true, displays a divider line above this menu item. */
     divider?: boolean;
+    /** Icon displayed before the menu item label. */
     icon?: string;
+    /** Sets a data-testid attribute for automated testing. */
     testId?: string;
+    /** Sets the visual style of the badge. Use "emergency" for urgent items, "success" for positive status. @default "normal" */
     type?: GoabWorkSideMenuItemType;
+    /** Content rendered inside the menu item. */
     children?: React.ReactNode;
+    /** Content rendered inside the popover panel attached to this menu item. */
     popoverContent?: React.ReactNode;
 }
+/** Individual menu item within the work side menu. */
 export declare function GoabWorkSideMenuItem(props: GoabWorkSideMenuItemProps): JSX.Element;
 export default GoabWorkSideMenuItem;

package/lib/work-side-notification-item/work-side-notification-item.d.ts

@@ -18,14 +18,23 @@ declare module "react" {
     }
 }
 export interface GoabWorkSideNotificationItemProps {
+    /** @required The body text content of the notification card. */
+    description: string;
+    /** Sets the visual type/style of the notification item. @default "default" */
     type?: GoabWorkSideNotificationItemType;
+    /** ISO timestamp string representing when the notification occurred. */
     timestamp?: string;
+    /** Title text displayed in the notification card header. */
     title?: string;
-    description: string;
+    /** Indicates whether the notification has been read or is unread. @default "unread" */
     readStatus?: GoabWorkSideNotificationReadStatus;
+    /** Sets the urgency level of the notification. @default "normal" */
     priority?: GoabWorkSideNotificationPriority;
+    /** Sets a data-testid attribute for automated testing. */
     testId?: string;
+    /** Callback fired when the notification item is clicked. */
     onClick?: () => void;
 }
+/** Displays an individual notification item in the work-side notification panel. */
 export declare function GoabWorkSideNotificationItem({ type, timestamp, title, description, readStatus, priority, testId, onClick, }: GoabWorkSideNotificationItemProps): JSX.Element;
 export default GoabWorkSideNotificationItem;

package/lib/work-side-notification-panel/work-side-notification-panel.d.ts

@@ -14,12 +14,19 @@ declare module "react" {
     }
 }
 export interface GoabWorkSideNotificationPanelProps {
+    /** Sets the panel heading text. @default "Notifications" */
     heading?: string;
+    /** Sets the initially active tab. @default "unread" */
     activeTab?: GoabWorkSideNotificationActiveTabType;
+    /** Sets a data-testid attribute for automated testing. */
     testId?: string;
+    /** Notification item content rendered inside the panel. */
     children?: ReactNode;
+    /** Callback fired when the "Mark all as read" button is clicked. */
     onMarkAllRead?: () => void;
+    /** Callback fired when the "View all" button is clicked. */
     onViewAll?: () => void;
 }
+/** Displays a panel of work-side notifications. */
 export declare function GoabWorkSideNotificationPanel({ heading, activeTab, testId, children, onMarkAllRead, onViewAll, }: GoabWorkSideNotificationPanelProps): JSX.Element;
 export default GoabWorkSideNotificationPanel;

package/package.json

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