@abgov/react-components 7.1.0 → 7.2.0-dev.2

package/lib/chip/chip.d.ts

@@ -18,19 +18,19 @@ declare module "react" {
     }
 }
 export interface GoabChipProps extends Margins, DataAttributes {
-    /** @required @deprecated Use GoAFilterChip instead. The text content displayed in the chip. */
+    /** @required @deprecated Use GoabFilterChip instead. The text content displayed in the chip. */
     content: string;
-    /** @deprecated Use GoAFilterChip instead. When true, shows a delete icon and makes chip clickable. */
+    /** @deprecated Use GoabFilterChip instead. When true, shows a delete icon and makes chip clickable. */
     deletable?: boolean;
-    /** @deprecated Use GoAFilterChip instead. Icon displayed at the start of the chip. */
+    /** @deprecated Use GoabFilterChip instead. Icon displayed at the start of the chip. */
     leadingIcon?: string;
-    /** @deprecated Use GoAFilterChip instead. The icon theme - outline or filled. */
+    /** @deprecated Use GoabFilterChip instead. The icon theme - outline or filled. */
     iconTheme?: GoabChipTheme;
-    /** @deprecated Use GoAFilterChip instead. Shows an error state on the chip. */
+    /** @deprecated Use GoabFilterChip instead. Shows an error state on the chip. */
     error?: boolean;
-    /** @deprecated Use GoAFilterChip instead. The chip variant style. */
+    /** @deprecated Use GoabFilterChip instead. The chip variant style. */
     variant?: GoabChipVariant;
-    /** @deprecated Use GoAFilterChip instead. Sets a data-testid attribute for automated testing. */
+    /** @deprecated Use GoabFilterChip instead. Sets a data-testid attribute for automated testing. */
     testId?: string;
     /** Callback fired when the chip is clicked or deleted. */
     onClick?: () => void;

package/lib/container/container.d.ts

@@ -34,9 +34,9 @@ export interface GoabContainerProps extends Margins, DataAttributes {
     maxHeight?: string;
     /** Sets a data-testid attribute for automated testing. */
     testId?: string;
-    /** Content rendered in the container's title/heading area. */
+    /** @deprecated Use title instead. Alias for the title prop. */
     heading?: ReactNode;
-    /** @deprecated Use heading instead. Alias for the heading prop. */
+    /** Content rendered in the container's title/heading area. */
     title?: ReactNode;
     /** Content rendered in the container's actions area, typically buttons or controls. */
     actions?: ReactNode;

package/lib/dropdown/dropdown.d.ts

@@ -56,7 +56,7 @@ export interface GoabDropdownProps extends Margins, DataAttributes {
     leadingIcon?: GoabIconType;
     /** Maximum height of the dropdown menu. Non-native only. @default "276px" */
     maxHeight?: string;
-    /** When true, allows multiple items to be selected. */
+    /** When true, allows multiple items to be selected. @internal */
     multiselect?: boolean;
     /** When true, renders the native select HTML element. */
     native?: boolean;

package/lib/hero-banner/hero-banner.d.ts

@@ -26,6 +26,8 @@ export interface GoabHeroBannerProps {
     testId?: string;
     /** Content rendered inside the hero banner body. */
     children?: React.ReactNode;
+    /** Content rendered in the actions slot. */
+    actions?: React.ReactNode;
     /** Maximum width of the content area. @default "100%" */
     maxContentWidth?: string;
     /** Hero Banner background color when no background image is provided. @default "#f8f8f8" */
@@ -34,5 +36,5 @@ export interface GoabHeroBannerProps {
     textColor?: string;
 }
 /** A visual band of text, including an image and a call to action. */
-export declare function GoabHeroBanner({ heading, backgroundUrl, minHeight, maxContentWidth, backgroundColor, textColor, children, testId, }: GoabHeroBannerProps): JSX.Element;
+export declare function GoabHeroBanner({ heading, backgroundUrl, minHeight, maxContentWidth, backgroundColor, textColor, children, actions, testId, }: GoabHeroBannerProps): JSX.Element;
 export default GoabHeroBanner;

package/lib/input/input.d.ts

@@ -136,6 +136,7 @@ interface GoabDateInputProps extends BaseProps {
 }
 /** A single-line field where users can input and edit text. */
 export declare function GoabInput({ variant, textAlign, size, focused, disabled, readonly, error, leadingContent, trailingContent, onTrailingIconClick, onChange, onFocus, onBlur, onKeyPress, ...rest }: GoabInputProps & {
+    /** Sets the type of the input field. @default "text" */
     type?: GoabInputType;
 }): JSX.Element;
 /** A single-line field where users can input and edit text. */

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

@@ -21,7 +21,7 @@ interface WCProps {
 export interface GoabHeaderProps {
     /** @required The service type which determines the badge style. "live" shows official government site text, "alpha" and "beta" show development stage badges. */
     type: GoabServiceLevel;
-    /** App or service version displayed on the right side of the header. Accepts a string or custom ReactNode for rich content. */
+    /** App or service version displayed on the right side of the header. */
     version?: string | React.ReactNode;
     /** URL to a feedback page displayed when provided. */
     feedbackUrl?: string;

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

@@ -39,7 +39,7 @@ export interface GoabRadioItemProps extends Margins {
     maxWidth?: string;
     /** Disables this radio option. Also disabled if the parent RadioGroup is disabled. */
     disabled?: boolean;
-    /** Sets this radio option as checked/selected. */
+    /** @internal Sets this radio option as checked/selected. */
     checked?: boolean;
     /** Shows an error state on this radio option. */
     error?: boolean;

package/lib/tab/tab.d.ts

@@ -1,6 +1,6 @@
 import { JSX } from 'react';
 interface WCProps {
-    heading?: React.ReactNode;
+    heading?: string | React.ReactNode;
     disabled?: string;
     slug?: string;
 }
@@ -13,7 +13,7 @@ declare module "react" {
 }
 export interface GoabTabItemProps {
     /** The text label for this tab. Can also pass React nodes for custom heading content. */
-    heading?: React.ReactNode;
+    heading?: string | React.ReactNode;
     /** When true, disables the tab so it cannot be selected. */
     disabled?: boolean;
     /** Content rendered inside the tab panel. */

package/lib/table/table.d.ts

@@ -3,7 +3,6 @@ import { ReactNode } from 'react';
 interface WCProps extends Margins {
     ref?: React.RefObject<HTMLElement | null>;
     width?: string;
-    stickyheader?: string;
     variant?: GoabTableVariant;
     "sort-mode"?: GoabTableSortMode;
     testid?: string;

package/lib/tooltip/tooltip.d.ts

@@ -17,7 +17,7 @@ declare module "react" {
 export interface GoabTooltipProps extends Margins, DataAttributes {
     /** Position of the tooltip with respect to the child element. @default "top" */
     position?: GoabTooltipPosition;
-    /** The content of the tooltip. Accepts a string or a ReactNode. */
+    /** The content of the tooltip. Accepts plain text or rich content. */
     content?: string | ReactNode;
     /** Horizontal alignment of the tooltip relative to the child element. @default "center" */
     hAlign?: GoabTooltipHorizontalAlignment;

package/package.json

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