@abgov/react-components 6.7.1-alpha.5 → 6.8.0-alpha.2

package/lib/badge/badge.d.ts

@@ -1,4 +1,4 @@
-import { GoabBadgeType, Margins } from '@abgov/ui-components-common';
+import { GoabBadgeType, Margins, GoabIconType } from '@abgov/ui-components-common';
 import { JSX } from 'react';
 interface WCProps extends Margins {
     type: GoabBadgeType;
@@ -6,6 +6,7 @@ interface WCProps extends Margins {
     content?: string;
     arialabel?: string;
     testid?: string;
+    icontype?: GoabIconType;
 }
 declare module "react" {
     namespace JSX {
@@ -20,8 +21,9 @@ export interface GoabBadgeProps extends Margins {
     content?: string;
     testId?: string;
     ariaLabel?: string;
+    iconType?: GoabIconType;
 }
-export declare function GoabBadge({ type, content, icon, testId, mt, mr, mb, ml, ariaLabel, }: GoabBadgeProps): JSX.Element;
+export declare function GoabBadge({ type, content, icon, testId, mt, mr, mb, ml, ariaLabel, iconType, }: GoabBadgeProps): JSX.Element;
 /**
  * @deprecated
  */

package/lib/checkbox/checkbox.d.ts

@@ -12,6 +12,7 @@ interface WCProps extends Margins {
     id?: string;
     name: string;
     checked?: string;
+    indeterminate?: string;
     disabled?: string;
     error?: string;
     text?: string;
@@ -27,6 +28,7 @@ export interface GoabCheckboxProps extends Margins {
     id?: string;
     name: string;
     checked?: boolean;
+    indeterminate?: boolean;
     disabled?: boolean;
     error?: boolean;
     text?: string;
@@ -41,5 +43,5 @@ export interface GoabCheckboxProps extends Margins {
     onChange?: (detail: GoabCheckboxOnChangeDetail) => void;
 }
 export type Props = GoabCheckboxProps;
-export declare function GoabCheckbox({ id, name, testId, error, disabled, checked, value, text, description, reveal, revealAriaLabel, maxWidth, children, onChange, ariaLabel, mt, mr, mb, ml, }: GoabCheckboxProps): JSX.Element;
+export declare function GoabCheckbox({ id, name, testId, error, disabled, checked, indeterminate, value, text, description, reveal, revealAriaLabel, maxWidth, children, onChange, ariaLabel, mt, mr, mb, ml, }: GoabCheckboxProps): JSX.Element;
 export default GoabCheckbox;

package/lib/checkbox-list/checkbox-list.d.ts

@@ -0,0 +1,30 @@
+import { GoabCheckboxListOnChangeDetail, Margins } from '@abgov/ui-components-common';
+import { JSX } from 'react';
+declare module "react" {
+    namespace JSX {
+        interface IntrinsicElements {
+            "goa-checkbox-list": WCProps & React.HTMLAttributes<HTMLElement>;
+        }
+    }
+}
+interface WCProps extends Margins {
+    ref: React.RefObject<HTMLElement | null>;
+    name: string;
+    value?: string[];
+    disabled?: string;
+    error?: string;
+    testid?: string;
+    maxwidth?: string;
+}
+export interface GoabCheckboxListProps extends Margins {
+    name: string;
+    value?: string[];
+    disabled?: boolean;
+    error?: boolean;
+    testId?: string;
+    maxWidth?: string;
+    children?: React.ReactNode;
+    onChange?: (detail: GoabCheckboxListOnChangeDetail) => void;
+}
+export declare function GoabCheckboxList({ name, value, disabled, error, testId, maxWidth, children, onChange, mt, mr, mb, ml, }: GoabCheckboxListProps): JSX.Element;
+export default GoabCheckboxList;

package/lib/menu-button/menu-action.d.ts

@@ -0,0 +1,23 @@
+import { GoabIconType } from '@abgov/ui-components-common';
+import { JSX } from 'react';
+interface WCProps {
+    text: string;
+    action: string;
+    icon?: GoabIconType;
+    testid?: string;
+}
+declare module "react" {
+    namespace JSX {
+        interface IntrinsicElements {
+            "goa-menu-action": WCProps & React.HTMLAttributes<HTMLElement>;
+        }
+    }
+}
+export interface GoabMenuActionProps {
+    text: string;
+    action: string;
+    icon?: GoabIconType;
+    testId?: string;
+}
+export declare function GoabMenuAction({ text, icon, action, testId }: GoabMenuActionProps): JSX.Element;
+export default GoabMenuAction;

package/lib/menu-button/menu-button.d.ts

@@ -0,0 +1,71 @@
+import { GoabButtonType } from '@abgov/ui-components-common';
+import { ReactNode, JSX } from 'react';
+/**
+ * Props definition for the `goab-menu-button` Web Component.
+ * @typedef {Object} WCProps
+ *
+ * @property {string} text - The text label to be displayed on the button.
+ * @property {GoabButtonType} type - The button type, e.g., "primary", "secondary", etc.
+ * @property {string} [testid] - A test identifier for automated testing purposes.
+ * @property {React.RefObject<HTMLElement | null>} ref - A reference object pointing to the Web Component's DOM element.
+ */
+interface WCProps {
+    text: string;
+    type: GoabButtonType;
+    testid?: string;
+    ref: React.RefObject<HTMLElement | null>;
+}
+/**
+ * Extends React's `JSX` namespace to include the custom `goa-menu-button` Web Component.
+ * The `goa-menu-button` supports additional React-specific props.
+ */
+declare module "react" {
+    namespace JSX {
+        interface IntrinsicElements {
+            "goa-menu-button": WCProps & React.HTMLAttributes<HTMLElement>;
+        }
+    }
+}
+/**
+ * Props for the `GoabMenuButton` React component.
+ *
+ * @typedef {Object} GoabMenuButtonProps
+ *
+ * @property {string} text - The text label to display on the button.
+ * @property {GoabButtonType} [type="primary"] - The button type, e.g., "primary", "secondary". Defaults to "primary".
+ * @property {string} [testId] - A test identifier for automated testing purposes.
+ * @property {Function} [onAction] - Callback function invoked when an action event is emitted by the component.
+ * @property {ReactNode} [children] - Optional child elements to be rendered inside the button.
+ */
+export interface GoabMenuButtonProps {
+    text: string;
+    type?: GoabButtonType;
+    testId?: string;
+    onAction?: (action: string) => void;
+    children?: ReactNode;
+}
+/**
+ * A React wrapper component for the `goa-menu-button` Web Component.
+ *
+ * This component provides seamless integration of the Web Component into a React application, including React-specific props and event handling.
+ *
+ * @function GoabMenuButton
+ * @param {GoabMenuButtonProps} props - The props for the component.
+ *
+ * @returns {JSX.Element} A JSX element wrapping the `goa-menu-button` Web Component.
+ *
+ * @example
+ * ```tsx
+ * <GoabMenuButton
+ *   text="Example Button"
+ *   type="secondary"
+ *   onAction={(action) => console.log(`Action: ${action}`)}
+ * >
+ *   <GoabMenuAction text="Option 1" action="option1" />
+ *   <GoabMenuAction text="Option 2" action="option2" />
+ *   <GoabMenuAction text="Option 3" action="option3" />
+ * </GoabMenuButton>
+ * ```
+ */
+export declare function GoabMenuButton({ text, type, testId, onAction, children, }: GoabMenuButtonProps): JSX.Element;
+export default GoabMenuButton;

package/lib/popover/popover.d.ts

@@ -7,6 +7,7 @@ interface WCProps extends Margins {
     position?: GoabPopoverPosition;
     relative?: string;
     testid?: string;
+    tabindex?: number;
 }
 declare module "react" {
     namespace JSX {
@@ -23,10 +24,11 @@ export interface GoabPopoverProps extends Margins {
     padded?: boolean;
     position?: GoabPopoverPosition;
     children: ReactNode;
+    tabIndex?: number;
     /***
      * @deprecated This property has no effect and will be removed in a future version
      */
     relative?: boolean;
 }
-export declare function GoabPopover({ target, testId, maxWidth, minWidth, padded, position, relative, children, mt, mr, mb, ml, }: GoabPopoverProps): JSX.Element;
+export declare function GoabPopover({ target, testId, maxWidth, minWidth, padded, position, relative, children, tabIndex, mt, mr, mb, ml, }: GoabPopoverProps): JSX.Element;
 export default GoabPopover;

package/package.json

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