@abgov/react-components 7.5.0 → 8.0.0-dev.1

package/lib/accordion/accordion.d.ts

@@ -3,7 +3,7 @@ import { GoabAccordionHeadingSize, GoabAccordionIconPosition, GoabAccordionHeadi
 interface WCProps extends Margins {
     open?: string;
     headingsize?: GoabAccordionHeadingSize;
-    heading?: string;
+    heading: string;
     secondarytext?: string;
     headingContent?: ReactNode;
     maxwidth?: string;
@@ -21,8 +21,8 @@ declare module "react" {
     }
 }
 export interface GoabAccordionProps extends Margins, DataAttributes {
-    /** Sets the heading text. */
-    heading?: string;
+    /** @required Sets the heading text. */
+    heading: string;
     /** Sets the state of the accordion container open or closed. */
     open?: boolean;
     /** Sets the heading size of the accordion container heading. @default "small" */

package/lib/app-header/app-header.d.ts

@@ -5,17 +5,12 @@ interface WCProps {
     secondarytext?: string;
     url?: string;
     maxcontentwidth?: string;
-    fullmenubreakpoint?: number;
-    hasmenuclickhandler?: string;
     testid?: string;
-    version?: string;
 }
 declare module "react" {
     namespace JSX {
         interface IntrinsicElements {
-            "goa-app-header": WCProps & React.HTMLAttributes<HTMLElement> & {
-                ref: React.RefObject<HTMLElement | null>;
-            };
+            "goa-app-header": WCProps & React.HTMLAttributes<HTMLElement>;
         }
     }
 }
@@ -28,12 +23,8 @@ export interface GoabAppHeaderProps extends DataAttributes {
     url?: string;
     /** Maximum width of the content area. */
     maxContentWidth?: string;
-    /** Sets the breakpoint in px for the full menu to display. */
-    fullMenuBreakpoint?: number;
     /** Content rendered inside the app header, typically navigation links. */
     children?: ReactNode;
-    /** Callback fired when the menu button is clicked. When provided, clicking the menu button dispatches a custom event instead of toggling the menu. */
-    onMenuClick?: () => void;
     /** Sets a data-testid attribute for automated testing. */
     testId?: string;
     /** Banner content displayed above the header. */
@@ -46,5 +37,5 @@ export interface GoabAppHeaderProps extends DataAttributes {
     utilities?: ReactNode;
 }
 /** Provide structure to help users find their way around the service. */
-export declare function GoabAppHeader({ onMenuClick, children, secondaryText, banner, phase, navigation, utilities, ...rest }: GoabAppHeaderProps): JSX.Element;
+export declare function GoabAppHeader({ children, secondaryText, banner, phase, navigation, utilities, ...rest }: GoabAppHeaderProps): JSX.Element;
 export {};

package/lib/badge/badge.d.ts

@@ -9,7 +9,6 @@ interface WCProps extends Margins {
     icontype?: GoabIconType;
     size?: GoabBadgeSize;
     emphasis?: GoabBadgeEmphasis;
-    version?: string;
 }
 declare module "react" {
     namespace JSX {

package/lib/button/button.d.ts

@@ -13,7 +13,6 @@ interface WCProps extends Margins {
     action?: string;
     actionArgs?: string;
     actionArg?: string;
-    version?: string;
 }
 declare module "react" {
     namespace JSX {

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

@@ -13,8 +13,8 @@ declare module "react" {
     }
 }
 export interface GoabButtonGroupProps extends Margins, DataAttributes {
-    /** @required Positions the button group in the page layout. */
-    alignment: GoabButtonGroupAlignment;
+    /** Positions the button group in the page layout. @default "start" */
+    alignment?: GoabButtonGroupAlignment;
     /** Sets the spacing between buttons in the button group. @default "relaxed" */
     gap?: GoabButtonGroupGap;
     /** Sets a data-testid attribute for automated testing. */
@@ -23,5 +23,5 @@ export interface GoabButtonGroupProps extends Margins, DataAttributes {
     children?: React.ReactNode;
 }
 /** Display multiple related actions stacked or in a horizontal row to help with arrangement and spacing. */
-export declare function GoabButtonGroup({ children, ...rest }: GoabButtonGroupProps): JSX.Element;
+export declare function GoabButtonGroup({ children, alignment, ...rest }: GoabButtonGroupProps): JSX.Element;
 export default GoabButtonGroup;

package/lib/calendar/calendar.d.ts

@@ -6,7 +6,6 @@ interface WCProps extends Margins {
     min?: string;
     max?: string;
     testid?: string;
-    version?: string;
 }
 declare module "react" {
     namespace JSX {

package/lib/callout/callout.d.ts

@@ -1,14 +1,12 @@
-import { GoabCalloutAriaLive, GoabCalloutEmphasis, GoabCalloutSize, GoabCalloutType, GoabCalloutIconTheme, Margins, DataAttributes } from '@abgov/ui-components-common';
+import { GoabCalloutAriaLive, GoabCalloutEmphasis, GoabCalloutType, GoabCalloutIconTheme, Margins, DataAttributes } from '@abgov/ui-components-common';
 interface WCProps extends Margins {
     heading?: string;
     type?: GoabCalloutType;
-    size?: GoabCalloutSize;
     arialive?: GoabCalloutAriaLive;
     maxwidth?: string;
     icontheme?: GoabCalloutIconTheme;
     emphasis?: GoabCalloutEmphasis;
     testid?: string;
-    version?: string;
 }
 declare module "react" {
     namespace JSX {
@@ -22,8 +20,6 @@ export interface GoabCalloutProps extends Margins, DataAttributes {
     heading?: string;
     /** Sets the context and colour of the callout. @default "information" */
     type?: GoabCalloutType;
-    /** Sets the size of the callout. 'medium' has reduced padding and type size for compact areas. @default "large" */
-    size?: GoabCalloutSize;
     /** Sets the icon theme. 'outline' for stroked icons, 'filled' for solid icons. @default "outline" */
     iconTheme?: GoabCalloutIconTheme;
     /** Sets the visual prominence. 'high' for full background, 'medium' for subtle, 'low' for minimal. @default "medium" */
@@ -38,5 +34,5 @@ export interface GoabCalloutProps extends Margins, DataAttributes {
     children?: React.ReactNode;
 }
 /** Communicate important information through a strong visual emphasis. */
-export declare const GoabCallout: ({ type, iconTheme, size, ariaLive, emphasis, children, ...rest }: GoabCalloutProps) => import("react/jsx-runtime").JSX.Element;
+export declare const GoabCallout: ({ type, iconTheme, ariaLive, emphasis, children, ...rest }: GoabCalloutProps) => import("react/jsx-runtime").JSX.Element;
 export default GoabCallout;

package/lib/checkbox/checkbox.d.ts

@@ -11,7 +11,7 @@ declare module "react" {
 }
 interface WCProps extends Margins {
     id?: string;
-    name: string;
+    name?: string;
     checked?: string;
     indeterminate?: string;
     disabled?: string;
@@ -25,11 +25,10 @@ interface WCProps extends Margins {
     maxwidth?: string;
     testid?: string;
     size?: GoabCheckboxSize;
-    version?: string;
 }
 export interface GoabCheckboxProps extends Margins, DataAttributes {
-    /** @required Unique name to identify the checkbox. */
-    name: string;
+    /** Unique name to identify the checkbox. If omitted, a unique name is generated. */
+    name?: string;
     /** Sets a unique id for the checkbox element. */
     id?: string;
     /** Marks the checkbox item as selected. */
@@ -48,7 +47,7 @@ export interface GoabCheckboxProps extends Margins, DataAttributes {
     children?: React.ReactNode;
     /** Sets a data-testid attribute for automated testing. */
     testId?: string;
-    /** Defines how the text will be translated for the screen reader. If not specified it will fall back to the name. */
+    /** Defines how the text will be translated for the screen reader. If not specified it will fall back to the checkbox text. */
     ariaLabel?: string;
     /** Additional description text displayed below the checkbox label. */
     description?: string | React.ReactNode;

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

@@ -2,14 +2,14 @@ import { GoabCheckboxListOnBlurDetail, GoabCheckboxListOnChangeDetail, GoabCheck
 import { JSX } from 'react';
 interface WCProps extends Margins {
     ref: React.RefObject<HTMLElement | null>;
-    name: string;
+    name?: string;
     value?: string[];
     disabled?: string;
     error?: string;
     testid?: string;
     maxwidth?: string;
-    version?: string;
     size?: string;
+    arialabel?: string;
 }
 declare module "react" {
     namespace JSX {
@@ -19,8 +19,8 @@ declare module "react" {
     }
 }
 export interface GoabCheckboxListProps extends Margins {
-    /** @required The name for the checkbox list group. Used as group identifier in change events. */
-    name: string;
+    /** The name for the checkbox list group. Used as group identifier in change events. If omitted, a unique name is generated. */
+    name?: string;
     /** Array of currently selected checkbox values. */
     value?: string[];
     /** Disables all checkboxes in the list. */
@@ -33,6 +33,8 @@ export interface GoabCheckboxListProps extends Margins {
     maxWidth?: string;
     /** Sets the size of the checkbox list. 'compact' reduces spacing between items. @default "default" */
     size?: "default" | "compact";
+    /** Defines how the input will be translated for the screen reader. */
+    ariaLabel?: string;
     /** Content rendered inside the checkbox list. */
     children?: React.ReactNode;
     /** Callback fired when the selected values change. */
@@ -43,5 +45,5 @@ export interface GoabCheckboxListProps extends Margins {
     onBlur?: (detail: GoabCheckboxListOnBlurDetail) => void;
 }
 /** A multiple selection input. */
-export declare function GoabCheckboxList({ name, value, disabled, error, testId, maxWidth, size, children, onChange, onFocus, onBlur, mt, mr, mb, ml, }: GoabCheckboxListProps): JSX.Element;
+export declare function GoabCheckboxList({ name, value, disabled, error, testId, maxWidth, size, ariaLabel, children, onChange, onFocus, onBlur, mt, mr, mb, ml, }: GoabCheckboxListProps): JSX.Element;
 export default GoabCheckboxList;

package/lib/data-grid/data-grid.d.ts

@@ -12,8 +12,8 @@ declare module "react" {
     }
 }
 export interface GoabDataGridProps {
-    /** @required Navigation mode. 'table' navigates like a table (up/down between rows), 'layout' allows wrapping between rows with left/right arrows. */
-    keyboardNav: "layout" | "table";
+    /** Navigation mode. 'table' navigates like a table (up/down between rows), 'layout' allows wrapping between rows with left/right arrows. @default "table" */
+    keyboardNav?: "layout" | "table";
     /** Controls visibility of the keyboard navigation indicator icon. @default "visible" */
     keyboardIconVisibility?: "visible" | "hidden";
     /** Position of the keyboard navigation indicator icon. @default "left" */

package/lib/date-picker/date-picker.d.ts

@@ -11,7 +11,6 @@ interface WCProps extends Margins {
     disabled?: string;
     testid?: string;
     width?: string;
-    version?: string;
 }
 declare module "react" {
     namespace JSX {

package/lib/drawer/drawer.d.ts

@@ -7,7 +7,6 @@ interface WCProps {
     maxsize?: GoabDrawerSize;
     testid?: string;
     ref: React.RefObject<HTMLElement | null>;
-    version?: string;
 }
 declare module "react" {
     namespace JSX {
@@ -23,7 +22,7 @@ export interface GoabDrawerProps {
     children: ReactNode;
     /** @required Callback fired when the drawer requests to be closed. */
     onClose: () => void;
-    /** Whether the drawer is open. */
+    /** Whether the drawer is open. @default false */
     open?: boolean;
     /** The heading text displayed at the top of the drawer. Accepts a string or a ReactNode for custom heading content. */
     heading?: string | ReactNode;

package/lib/dropdown/dropdown-item.d.ts

@@ -15,7 +15,7 @@ declare module "react" {
     }
 }
 export interface GoabDropdownItemProps {
-    /** @required The value submitted when this item is selected. */
+    /** @required The value submitted when this item is selected. Set to an empty string (`""`) to make this item the default selected value. */
     value: string;
     /** Display label for the dropdown item. */
     label?: string;

package/lib/dropdown/dropdown.d.ts

@@ -21,7 +21,6 @@ interface WCProps extends Margins {
     autocomplete?: string;
     testid?: string;
     size?: GoabDropdownSize;
-    version?: string;
 }
 declare module "react" {
     namespace JSX {
@@ -33,7 +32,7 @@ declare module "react" {
     }
 }
 export interface GoabDropdownProps extends Margins, DataAttributes {
-    /** Identifier for the dropdown. Should be unique. */
+    /** Identifier for the dropdown. If omitted, a unique name is generated. */
     name?: string;
     /** The currently selected value(s) of the dropdown. */
     value?: string[] | string;
@@ -43,7 +42,7 @@ export interface GoabDropdownProps extends Margins, DataAttributes {
     onFocus?: (detail: GoabDropdownOnFocusDetail) => void;
     /** Callback fired when the dropdown loses focus. */
     onBlur?: (detail: GoabDropdownOnBlurDetail) => void;
-    /** Defines how the selected value will be translated for the screen reader. If not specified it will fall back to the name. */
+    /** Defines how the selected value will be translated for the screen reader. */
     ariaLabel?: string;
     /** The aria-labelledby attribute identifies the element that labels the dropdown. Normally it is the id of the label. */
     ariaLabelledBy?: string;

package/lib/file-upload-card/file-upload-card.d.ts

@@ -6,7 +6,6 @@ interface WCProps {
     progress?: number;
     error?: string;
     testid?: string;
-    version?: string;
 }
 declare module "react" {
     namespace JSX {

package/lib/file-upload-input/file-upload-input.d.ts

@@ -4,7 +4,6 @@ interface WCProps {
     accept?: string;
     maxfilesize?: string;
     testid?: string;
-    version?: string;
 }
 declare module "react" {
     namespace JSX {

package/lib/filter-chip/filter-chip.d.ts

@@ -8,7 +8,6 @@ interface WCProps extends Margins {
     secondarytext?: string;
     leadingicon?: GoabIconType;
     testid?: string;
-    version?: string;
 }
 declare module "react" {
     namespace JSX {

package/lib/footer/footer.d.ts

@@ -3,8 +3,6 @@ import { DataAttributes } from '@abgov/ui-components-common';
 interface WCProps {
     maxcontentwidth?: string;
     testid?: string;
-    url?: string;
-    version?: string;
 }
 declare module "react" {
     namespace JSX {
@@ -16,8 +14,6 @@ declare module "react" {
 export interface GoabAppFooterProps extends DataAttributes {
     /** The maximum width of the main content area. */
     maxContentWidth?: string;
-    /** URL for the Government of Alberta logo link. Set to empty string to disable the link. @default "https://alberta.ca" */
-    url?: string;
     /** Sets a data-testid attribute for automated testing. */
     testId?: string;
     /** Content rendered inside the footer, typically navigation and meta sections. */

package/lib/form-item/form-item.d.ts

@@ -12,7 +12,6 @@ interface WCProps extends Margins {
     id?: string;
     testid?: string;
     type?: GoabFormItemType;
-    version?: string;
 }
 declare module "react" {
     namespace JSX {

package/lib/input/input.d.ts

@@ -2,7 +2,7 @@ import { JSX } from 'react';
 import { GoabAutoCapitalize, GoabDate, GoabIconType, GoabInputOnBlurDetail, GoabInputOnChangeDetail, GoabInputOnFocusDetail, GoabInputOnKeyPressDetail, GoabInputSize, GoabInputType, Margins, DataAttributes } from '@abgov/ui-components-common';
 interface WCProps extends Margins {
     type?: GoabInputType;
-    name: string;
+    name?: string;
     value?: string;
     id?: string;
     autocapitalize?: GoabAutoCapitalize;
@@ -29,7 +29,6 @@ interface WCProps extends Margins {
     max?: string | number;
     step?: number;
     maxlength?: number;
-    version?: string;
     trailingiconarialabel?: string;
 }
 declare module "react" {
@@ -42,8 +41,8 @@ declare module "react" {
     }
 }
 interface BaseProps extends Margins, DataAttributes {
-    /** Name of input value that is received in event detail payloads. */
-    name: string;
+    /** Name of input value that is received in event detail payloads. If omitted, a unique name is generated. */
+    name?: string;
     /** Sets the id attribute of the input element. */
     id?: string;
     /** Debounce delay in milliseconds before firing the change event. 0 means no debounce. */

package/lib/modal/modal.d.ts

@@ -14,7 +14,6 @@ interface WCProps {
     transition?: GoabModalTransition;
     calloutvariant?: GoabModalCalloutVariant;
     testid?: string;
-    version?: string;
 }
 declare module "react" {
     namespace JSX {

package/lib/notification/notification.d.ts

@@ -7,7 +7,6 @@ interface WCProps {
     testid?: string;
     emphasis?: GoabNotificationEmphasis;
     compact?: string;
-    version?: string;
 }
 declare module "react" {
     namespace JSX {

package/lib/pagination/pagination.d.ts

@@ -6,7 +6,6 @@ interface WCProps extends Margins {
     pagenumber: number;
     variant?: "all" | "links-only";
     testid?: string;
-    version?: string;
 }
 declare module "react" {
     namespace JSX {

package/lib/push-drawer/push-drawer.d.ts

@@ -4,7 +4,6 @@ interface WCProps {
     heading?: string;
     width?: string;
     testid?: string;
-    version?: string;
     ref: React.RefObject<HTMLElement | null>;
 }
 declare module "react" {

package/lib/radio-group/radio-group.d.ts

@@ -2,7 +2,7 @@ import { JSX } from 'react';
 import { GoabRadioGroupOnBlurDetail, GoabRadioGroupOnChangeDetail, GoabRadioGroupOnFocusDetail, GoabRadioGroupOrientation, GoabRadioGroupSize, Margins, DataAttributes } from '@abgov/ui-components-common';
 export * from './radio';
 interface WCProps extends Margins {
-    name: string;
+    name?: string;
     value?: string;
     id?: string;
     orientation?: GoabRadioGroupOrientation;
@@ -11,7 +11,6 @@ interface WCProps extends Margins {
     arialabel?: string;
     testid?: string;
     size?: GoabRadioGroupSize;
-    version?: string;
 }
 declare module "react" {
     namespace JSX {
@@ -23,8 +22,8 @@ declare module "react" {
     }
 }
 export interface GoabRadioGroupProps extends Margins, DataAttributes {
-    /** @required The name for the radio group. Used for accessibility and change events. */
-    name: string;
+    /** The name for the radio group. Used for accessibility and change events. If omitted, a unique name is generated. */
+    name?: string;
     /** The currently selected value in the radio group. */
     value?: string;
     /** The identifier for the radio group element. */

package/lib/radio-group/radio.d.ts

@@ -2,7 +2,7 @@ import { Margins } from '@abgov/ui-components-common';
 import { JSX } from 'react';
 interface WCProps extends Margins {
     name?: string;
-    value?: string;
+    value: string;
     description?: string | React.ReactNode;
     reveal?: React.ReactNode;
     revealarialabel?: string;
@@ -13,7 +13,6 @@ interface WCProps extends Margins {
     error?: string;
     arialabel?: string;
     compact?: string;
-    version?: string;
 }
 declare module "react" {
     namespace JSX {
@@ -23,8 +22,8 @@ declare module "react" {
     }
 }
 export interface GoabRadioItemProps extends Margins {
-    /** The value of this radio option. Will be emitted when selected. */
-    value?: string;
+    /** @required The value of this radio option. Will be emitted when selected. */
+    value: string;
     /** The display label for this radio option. Falls back to value if not provided. */
     label?: string;
     /** The name of the radio group. Inherited from the parent RadioGroup if not set. */

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

@@ -1,7 +1,6 @@
 import { ReactNode, JSX } from 'react';
 interface WCProps {
     testid?: string;
-    version?: string;
 }
 declare module "react" {
     namespace JSX {

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

@@ -4,7 +4,6 @@ interface WCProps extends Margins {
     heading: string;
     icon?: GoabIconType;
     testid?: string;
-    version?: string;
 }
 declare module "react" {
     namespace JSX {

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

@@ -3,7 +3,6 @@ import { ReactNode } from 'react';
 interface WCProps {
     testid?: string;
     icon?: GoabIconType;
-    version?: string;
 }
 declare module "react" {
     namespace JSX {

package/lib/table/table-sort-header.d.ts

@@ -4,7 +4,6 @@ interface WCProps {
     name?: string;
     direction?: GoabTableSortDirection;
     "sort-order"?: GoabTableSortOrder;
-    version?: "1" | "2";
 }
 declare module "react" {
     namespace JSX {

package/lib/table/table.d.ts

@@ -7,7 +7,6 @@ interface WCProps extends Margins {
     "sort-mode"?: GoabTableSortMode;
     testid?: string;
     striped?: string;
-    version?: string;
 }
 declare module "react" {
     namespace JSX {

package/lib/tabs/tabs.d.ts

@@ -7,7 +7,6 @@ interface WCProps {
     testid?: string;
     variant?: GoabTabsVariant;
     navigation?: GoabTabsNavigation;
-    version?: string;
     orientation?: string;
 }
 declare module "react" {

package/lib/textarea/textarea.d.ts

@@ -1,7 +1,7 @@
 import { GoabTextAreaCountBy, GoabTextAreaOnChangeDetail, GoabTextAreaOnKeyPressDetail, GoabTextAreaOnBlurDetail, GoabTextAreaOnFocusDetail, GoabTextAreaSize, Margins, DataAttributes } from '@abgov/ui-components-common';
 import { JSX } from 'react';
 interface WCProps extends Margins {
-    name: string;
+    name?: string;
     value?: string;
     placeholder?: string;
     rows?: number;
@@ -16,7 +16,6 @@ interface WCProps extends Margins {
     autocomplete?: string;
     testid?: string;
     size?: GoabTextAreaSize;
-    version?: string;
 }
 declare module "react" {
     namespace JSX {
@@ -28,8 +27,8 @@ declare module "react" {
     }
 }
 export interface GoabTextAreaProps extends Margins, DataAttributes {
-    /** @required Name of the input value that is received in the change event. */
-    name: string;
+    /** Name of the input value that is received in the change event. If omitted, a unique name is generated. */
+    name?: string;
     /** Bound to the current value of the textarea. */
     value?: string;
     /** Sets the id attribute on the textarea element. */
@@ -50,7 +49,7 @@ export interface GoabTextAreaProps extends Margins, DataAttributes {
     maxWidth?: string;
     /** Sets a data-testid attribute for automated testing. */
     testId?: string;
-    /** Defines how the text will be translated for the screen reader. If not specified it will fall back to the name. */
+    /** Defines how the text will be translated for the screen reader. */
     ariaLabel?: string;
     /** Counting interval for characters or words, specifying whether to count every character or word. */
     countBy?: GoabTextAreaCountBy;

package/package.json

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