@bcgov/design-system-react-components 0.0.4 → 0.0.6

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,63 @@
+import React from "react";
+import "./Footer.css";
+export interface FooterLinksProps {
+    /**
+     * Title for the list of links - associated to the list of links as a `<figcaption>`
+     */
+    title: string;
+    /**
+     * Array of link elements (`<a>` or `<Link>`)
+     */
+    links: React.ReactElement[];
+}
+/**
+ * A titled list of links for use in the Footer. Rendered inside a `<figure>`
+ * with the `title` prop inside of the `<figcaption>`.
+ * @param {FooterLinksProps} props
+ * @returns {React.ReactElement}
+ */
+export declare function FooterLinks({ title, links }: FooterLinksProps): import("react/jsx-runtime").JSX.Element;
+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).
+     *
+     * Pass the `<FooterLinks>` component for a styles-included 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;
+}
+/**
+ * A `<footer>` element with default content included.
+ *
+ * Passing `children` replaces `logo`, `contact`, and `links`.
+ * @param {FooterProps} props
+ * @returns {React.ReactElement}
+ */
+export default function Footer({ children, acknowledgement, logo, contact, links, copyright, hideAcknowledgement, hideLogoAndLinks, hideCopyright, }: React.PropsWithChildren<FooterProps>): import("react/jsx-runtime").JSX.Element;

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

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

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

@@ -1,11 +1,29 @@
 import React from "react";
 import "./Header.css";
-export declare function SvgBcLogo(): import("react/jsx-runtime").JSX.Element;
 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

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

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({ 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/Tooltip/Tooltip.d.ts

@@ -0,0 +1,5 @@
+import React from "react";
+import { TooltipProps, TooltipTrigger } from "react-aria-components";
+import "./Tooltip.css";
+export default function Tooltip({ children, placement, }: React.PropsWithChildren<TooltipProps>): import("react/jsx-runtime").JSX.Element;
+export { TooltipTrigger };

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

@@ -0,0 +1,2 @@
+export { default, TooltipTrigger } from "./Tooltip";
+export type { TooltipProps } from "./Tooltip";

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

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