@bcgov/design-system-react-components 0.0.3 → 0.0.5

package/dist/cjs/types/components/Button/Button.d.ts

@@ -1,9 +1,21 @@
 import { ButtonProps as ReactAriaButtonProps } from "react-aria-components";
 import "./Button.css";
 export interface ButtonProps extends ReactAriaButtonProps {
+    /**
+     * Defaults to `medium`. `small` is shorter vertically.
+     */
     size?: "small" | "medium";
+    /**
+     * Defaults to `primary`.
+     */
     variant?: "primary" | "secondary" | "tertiary" | "link";
+    /**
+     * For destructive/deletion actions.
+     */
     danger?: boolean;
+    /**
+     * If true, renders a square button intended for a single icon.
+     */
     isIconButton?: boolean;
 }
 export default function Button({ size, variant, danger, isIconButton, ...props }: ButtonProps): import("react/jsx-runtime").JSX.Element;

package/dist/cjs/types/components/Footer/Footer.d.ts

@@ -0,0 +1,37 @@
+import React from "react";
+import "./Footer.css";
+export interface FooterProps {
+    /**
+     * Land acknowledgement block (defaults to Gov.bc.ca land acknowledgement)
+     */
+    acknowledgement?: React.ReactElement;
+    /**
+     * Logo slot (defaults to BC Gov horizontal logo)
+     */
+    logo?: React.ReactElement;
+    /**
+     * Contact information block (defaults to Gov.bc.ca contact information)
+     */
+    contact?: React.ReactElement;
+    /**
+     * Link list block (defaults to Gov.bc.ca link list)
+     */
+    links?: React.ReactElement;
+    /**
+     * Copyright string (defaults to current year)
+     */
+    copyright?: string;
+    /**
+     * Hide the acknowledgement section
+     */
+    hideAcknowledgement?: boolean;
+    /**
+     * Hide the logo, contact information, and links section
+     */
+    hideLogoAndLinks?: boolean;
+    /**
+     * Hide the copyright string
+     */
+    hideCopyright?: boolean;
+}
+export default function Footer({ acknowledgement, logo, contact, links, copyright, hideAcknowledgement, hideLogoAndLinks, hideCopyright, }: FooterProps): import("react/jsx-runtime").JSX.Element;

package/dist/cjs/types/components/Footer/index.d.ts

@@ -0,0 +1,2 @@
+export { default } from "./Footer";
+export type { FooterProps } from "./Footer";

package/dist/cjs/types/components/Header/Header.d.ts

@@ -0,0 +1,29 @@
+import React from "react";
+import "./Header.css";
+export interface HeaderProps {
+    /**
+     * Link element that surrounds the logo. Use what's appropriate for your
+     * router, like a `<Link>`. Defaults to a generic HTML link element like
+     * `<a href="/" title="Government of British Columbia">`.
+     */
+    logoLinkElement?: React.ReactElement;
+    /**
+     * Image used for the logo. Defaults to an SVG of the Government of B.C. logo.
+     */
+    logoImage?: JSX.Element;
+    /**
+     * Array of link elements that are not visible until they are focused. Used
+     * for accessibility for keyboard users, to let them easily skip to main
+     * content, navigation, etc.
+     */
+    skipLinks?: React.ReactElement[];
+    /**
+     * Header title text that appears to the right of the logo.
+     */
+    title?: string;
+    /**
+     * Desired element that renders the `title` string. Defaults to `<span>`.
+     */
+    titleElement?: "h1" | "h2" | "h3" | "h4" | "h5" | "h6" | "span" | "p";
+}
+export default function Header({ children, logoLinkElement, logoImage, skipLinks, title, titleElement, }: React.PropsWithChildren<HeaderProps>): import("react/jsx-runtime").JSX.Element;

package/dist/cjs/types/components/Header/index.d.ts

@@ -0,0 +1,2 @@
+export { default } from "./Header";
+export type { HeaderProps } from "./Header";

package/dist/cjs/types/components/Select/Select.d.ts

@@ -6,7 +6,7 @@ export interface ListBoxItemProps extends ReactAriaListBoxItemProps {
     label: string;
     /** Descriptive text that appears below the option's label */
     description?: string;
-    /** Marks an option visually with red text to indicate danger */
+    /** Marks an option visually with red text to indicate a destructive/dangerous option */
     isDestructive?: boolean;
     /** Left icon slot */
     iconLeft?: React.ReactElement;
@@ -14,17 +14,23 @@ export interface ListBoxItemProps extends ReactAriaListBoxItemProps {
     iconRight?: React.ReactElement;
 }
 export interface SelectionSectionProps {
-    /** Display name for the section */
     id: Key;
+    /** Label for the section */
     header?: string;
+    /** Flat list of options within the section */
     items: ListBoxItemProps[];
 }
 export interface SelectProps<T extends object> extends ReactAriaSelectProps<T> {
+    /** Use `items` for a flat list of options */
     items?: ListBoxItemProps[];
+    /** Use `sections` for a sectioned list with `items` options in each section */
     sections?: SelectionSectionProps[];
     /** Text label for the Select component */
     label?: string;
+    /** Temporary text that occupies the select input when no option has been selected. */
+    placeholder?: string;
     /** Defaults to `medium` */
     size?: "small" | "medium";
 }
-export default function Select<T extends object>({ items, sections, label, size, ...props }: SelectProps<T>): import("react/jsx-runtime").JSX.Element;
+/** Select displays a collapsible list of options and allows a user to select one of them. */
+export default function Select<T extends object>({ items, sections, label, placeholder, size, ...props }: SelectProps<T>): import("react/jsx-runtime").JSX.Element;

package/dist/cjs/types/components/SvgBcLogo/SvgBcLogo.d.ts

@@ -0,0 +1,3 @@
+export default function SvgBcLogo({ id }: {
+    id?: string | undefined;
+}): import("react/jsx-runtime").JSX.Element;

package/dist/cjs/types/components/SvgBcLogo/index.d.ts

@@ -0,0 +1 @@
+export { default } from "./SvgBcLogo";

package/dist/cjs/types/components/Tag/Tag.d.ts

@@ -2,7 +2,13 @@
 import { TagProps as ReactAriaTagProps } from "react-aria-components";
 import "./Tag.css";
 export interface TagProps extends ReactAriaTagProps {
+    /**
+     * Icon that appears to the left of the `textValue` field
+     */
     icon?: React.ReactNode;
+    /**
+     * Background color
+     */
     color?: "bc-blue" | "bc-gold" | "blue" | "dark" | "gray" | "grey" | "green" | "red" | "yellow";
 }
-export default function Tag({ className, color, icon, id, textValue, }: TagProps): import("react/jsx-runtime").JSX.Element;
+export default function Tag({ color, icon, id, textValue }: TagProps): import("react/jsx-runtime").JSX.Element;

package/dist/cjs/types/components/TagGroup/TagGroup.d.ts

@@ -1,8 +1,17 @@
 import { TagGroupProps as ReactAriaTagGroupProps } from "react-aria-components";
 import "./TagGroup.css";
 export interface TagGroupProps extends ReactAriaTagGroupProps {
+    /**
+     * Labels the TagGroup, appears above the tags.
+     */
     label?: string;
+    /**
+     * Extended description of the TagGroup, appears below the tags.
+     */
     description?: string;
+    /**
+     * Error message, appears below the tags and below the optional description.
+     */
     errorMessage?: string;
 }
 export default function TagGroup({ children, label, description, errorMessage, ...props }: TagGroupProps): import("react/jsx-runtime").JSX.Element;

package/dist/cjs/types/components/TagList/TagList.d.ts

@@ -3,6 +3,9 @@ import { TagProps } from "../Tag";
 import "./TagList.css";
 export interface TagListProps<T> extends Pick<ReactAriaTagListProps<T>, "children" | "renderEmptyState"> {
     items: TagProps[];
+    /**
+     * Used to set the `flex-direction` on the TagList.
+     */
     orientation?: "horizontal" | "vertical";
 }
 export default function TagList<T extends object>({ items, orientation, renderEmptyState, ...props }: TagListProps<T>): import("react/jsx-runtime").JSX.Element;

package/dist/cjs/types/components/index.d.ts

@@ -1,7 +1,9 @@
 import "@bcgov/design-tokens/css/variables.css";
 export { default as Button } from "./Button";
+export { default as Header } from "./Header";
+export { default as Footer } from "./Footer";
 export { default as Select } from "./Select";
-export { default as SelectItem } from "./SelectItem";
+export { default as SvgBcLogo } from "./SvgBcLogo";
 export { default as Tag } from "./Tag";
 export { default as TagGroup } from "./TagGroup";
 export { default as TagList } from "./TagList";