@arc-ui/components 12.0.0-beta.13 → 12.0.0-beta.14.1

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

@@ -1,85 +0,0 @@
-import React from "react";
-import { FormControlProps } from "../FormControl/FormControl";
-/** Use `Select` to choose from a dropdown list of options. */
-export declare const Select: React.FC<SelectProps>;
-export interface SelectProps extends Omit<FormControlProps, "children" | "elementType" | "htmlFor" | "requirementStatus" | "id" | "helperUnderLabel" | "supplementaryInfo"> {
-    /**
-     * Name for the Select.
-     */
-    name: string;
-    /**
-     * Label for the Select.
-     */
-    label: string;
-    /**
-     * Aria label for the Select.
-     */
-    ariaLabel?: string;
-    /**
-     * Placeholder text for the Select.
-     */
-    placeholder: string;
-    /**
-     * Options for the Select.
-     */
-    options: {
-        name: string;
-        value: string;
-    }[];
-    /**
-     * value for the Select. Passing a value makes the Select a controlled component.
-     */
-    value?: string;
-    /**
-     * error message for the Select.
-     */
-    errorMessage?: string;
-    /**
-     * Default value for the Select.
-     */
-    defaultValue?: string;
-    /**
-     * onChange handler for the Select.
-     */
-    onChange?: (value: string) => void;
-    /**
-     * onBlur handler for the Select.
-     */
-    onBlur?: (e: React.FocusEvent<HTMLButtonElement>) => void;
-    /**
-     * onFocus handler for the Select.
-     */
-    onFocus?: (e: React.FocusEvent<HTMLButtonElement>) => void;
-    /**
-     * onOpenChange handler for the Select.
-     */
-    onOpenChange?: (isOpen: boolean) => void;
-    /**
-     * The controlled open state of the select. Must be used in conjunction with onOpenChange.
-     */
-    open?: boolean;
-    /**
-     * select handler for the Select.
-     */
-    selectSize?: "s" | "m" | "l";
-    /**
-     * Sets the Select to 100% width.
-     */
-    isFluid?: boolean;
-    /**
-     * Sets the width of the Select.
-     */
-    width?: string;
-    /**
-     * Disables the Select.
-     */
-    isDisabled?: boolean;
-    /**
-     * Sets the Select to be open by default.
-     */
-    isDefaultOpen?: boolean;
-    /**
-     * Sets the Select to be open by default.
-     */
-    isRequired?: boolean;
-}

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

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

package/dist/types/components/SiteFooter/SiteFooter.d.ts

@@ -1,57 +0,0 @@
-import { FC, ReactNode } from "react";
-/**
- * Use `SiteFooter` to display information at the bottom of a page.
- */
-export declare const SiteFooter: FC<SiteFooterProps> & {
-    Item: typeof SiteFooterItem;
-    ItemGroup: typeof SiteFooterItemGroup;
-};
-export declare const SiteFooterItemGroup: FC<SiteFooterItemGroupProps>;
-export declare const SiteFooterItem: FC<SiteFooterItemProps>;
-export interface SiteFooterItemGroupProps {
-    /**
-     * Contents of the SiteFooterItemGroup. Must be SiteFooter.Item components.
-     */
-    children: ReactNode;
-    /**
-     * Title text for the SiteFooterItemGroup.
-     */
-    title: string;
-}
-export interface SiteFooterItemProps {
-    /**
-     * Contents of the SiteFooterItem.
-     */
-    children: ReactNode;
-    /**
-     * A URL to link to when the Item is clicked or touched.
-     */
-    href: string;
-    /**
-     * On click handler.
-     */
-    onClick?: () => void;
-}
-export interface SiteFooterProps {
-    /**
-     * Secondary content of the SiteFooter. Must be SiteFooter.Item components.
-     */
-    children?: ReactNode;
-    /**
-     * Copyright year.
-     */
-    currentYear?: string;
-    /**
-     * Accessible text for the SiteFooter logo.
-     */
-    logoLabel?: string;
-    /**
-     * Main content of the SiteFooter. Must be SiteFooter.ItemGroup components.
-     */
-    main?: ReactNode;
-    /**
-     * Text that appears at the top of the footer. Can be the name of the site, a
-     * brand strapline, or similar.
-     */
-    siteName?: string;
-}

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

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

package/dist/types/components/SiteHeaderV2/SiteHeaderV2.d.ts

@@ -1,82 +0,0 @@
-import React, { FC, ReactNode } from "react";
-import { subBrands } from "../BrandLogo/BrandLogo";
-import { Column } from "./components/Column";
-import { Item } from "./components/Item";
-import { ItemGroup } from "./components/ItemGroup";
-import { NavItem, NavItemWithSubNav } from "./components/NavItem";
-import { NodeItem } from "./components/NodeItem/NodeItem";
-import { SubNavItem } from "./components/SubNavItem";
-import { VerticalDivider } from "./components/VerticalDivider";
-declare const Context: React.Context<{
-    transparent: boolean;
-    menubarRef: React.MutableRefObject<HTMLUListElement> | null;
-}>;
-/**
- * Use `SiteHeaderV2` to display brand logo and navigation at the top of a page.
- */
-export declare const SiteHeaderV2: FC<SiteHeaderV2Props> & {
-    Column: typeof Column;
-    Item: typeof Item;
-    ItemGroup: typeof ItemGroup;
-    NavItem: typeof NavItem;
-    NodeItem: typeof NodeItem;
-    NavItemWithSubNav: typeof NavItemWithSubNav;
-    SubNavItem: typeof SubNavItem;
-    VerticalDivider: typeof VerticalDivider;
-};
-export declare function useHeaderV2Context(): {
-    transparent: boolean;
-    menubarRef: React.MutableRefObject<HTMLUListElement> | null;
-};
-export interface SiteHeaderV2Props {
-    /**
-     * Contents of the SiteHeaderV2. Must be SiteHeaderV2.NavItem or
-     * SiteHeaderV2.NavItemWithSubNav components.
-     */
-    children?: ReactNode;
-    /**
-     * Basket component for the SiteHeaderV2.
-     */
-    basket?: ReactNode;
-    /**
-     * Should account login links be included in the SiteHeaderV2?
-     */
-    hasLogin?: boolean;
-    /**
-     * Should the SiteHeaderV2 have a transparent background?
-     */
-    isTransparent?: boolean;
-    /**
-     * A URL to link to when SiteHeaderV2 logo is clicked or touched.
-     */
-    loginHref?: string;
-    /**
-     * A Function to run to when SiteHeaderV2 logo is clicked or touched.
-     */
-    logoOnClick?: () => void;
-    /**
-     * A Function to run to when SiteHeaderV2 login links are clicked or touched.
-     */
-    loginOnClick?: () => void;
-    /**
-     * Text to display in SiteHeaderV2 login links.
-     */
-    loginTitle?: string;
-    /**
-     * A URL to link to when the SiteHeaderV2 brand logo link is clicked or touched.
-     */
-    logoHref?: string;
-    /**
-     * Accessible text for the SiteHeaderV2 brand logo link.
-     */
-    logoLabel?: string;
-    /**
-     * Search component for the SiteHeaderV2.
-     */
-    search?: ReactNode;
-    /**
-     * Optional sub-brand variant. Only applies to BT.
-     */
-    subBrand?: (typeof subBrands)[number];
-}
-export { Context as SiteHeaderV2Context };

package/dist/types/components/SiteHeaderV2/components/BackButton/BackButton.d.ts

@@ -1,6 +0,0 @@
-import { FC } from "react";
-export declare const BackButton: FC<BackButtonProps>;
-export interface BackButtonProps {
-    setOpen: (arg0: boolean) => any;
-    setOpenPanelOnFirstClick: (arg0: boolean) => any;
-}

package/dist/types/components/SiteHeaderV2/components/BackButton/index.d.ts

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

package/dist/types/components/SiteHeaderV2/components/Column/Column.d.ts

@@ -1,8 +0,0 @@
-import { FC, ReactNode } from "react";
-export declare const Column: FC<ColumnProps>;
-export interface ColumnProps {
-    /**
-     * Contents of the Column. Must be SiteHeaderV2.ItemGroup components.
-     */
-    children: ReactNode;
-}

package/dist/types/components/SiteHeaderV2/components/Column/index.d.ts

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

package/dist/types/components/SiteHeaderV2/components/HorizontalPanel/HorizontalPanel.d.ts

@@ -1,12 +0,0 @@
-import React, { FC, ReactNode } from "react";
-export declare const HorizontalPanel: FC<PanelProps>;
-export interface PanelProps {
-    children: ReactNode;
-    navItemRef: React.MutableRefObject<HTMLElement> | null;
-    open: boolean;
-    setOpen: (arg0: boolean) => any;
-    subNavItemRef?: React.MutableRefObject<HTMLElement>;
-    subNavLink?: string;
-    title?: ReactNode;
-    withSubNav?: boolean;
-}

package/dist/types/components/SiteHeaderV2/components/HorizontalPanel/index.d.ts

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

package/dist/types/components/SiteHeaderV2/components/Item/Item.d.ts

@@ -1,16 +0,0 @@
-import { FC, ReactNode } from "react";
-export declare const Item: FC<ItemProps>;
-export interface ItemProps {
-    /**
-     * Contents of the Item. Usually text to be displayed in the Item link.
-     */
-    children: ReactNode;
-    /**
-     * A URL to link to when the Item is clicked or touched.
-     */
-    href: string;
-    /**
-     * On click handler.
-     */
-    onClick?: () => void;
-}

package/dist/types/components/SiteHeaderV2/components/Item/index.d.ts

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

package/dist/types/components/SiteHeaderV2/components/ItemGroup/ItemGroup.d.ts

@@ -1,27 +0,0 @@
-import { FC, ReactNode } from "react";
-export declare const ItemGroup: FC<ItemGroupProps>;
-export interface ItemGroupProps {
-    /**
-     * Contents of the ItemGroup. Must be Item components.
-     */
-    children: ReactNode;
-    subtitle?: string;
-    /**
-     * A top-level URL for the ItemGroup to link to.
-     */
-    href?: string;
-    /**
-     * Title text to be displayed in the ItemGroup summary.
-     */
-    title?: string;
-    /**
-     * Text to display in top-level link inside the ItemGroup in narrow viewports.
-     * Only applies if `href` is present. If not provided, top-level link text
-     * will be automatically generated from `title`.
-     */
-    viewAllTitle?: string;
-    /**
-     * On click handler.
-     */
-    onClick?: () => void;
-}

package/dist/types/components/SiteHeaderV2/components/ItemGroup/index.d.ts

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

package/dist/types/components/SiteHeaderV2/components/MenuButton/MenuButton.d.ts

@@ -1,6 +0,0 @@
-import { FC } from "react";
-export declare const MenuButton: FC<MenuButtonProps>;
-export interface MenuButtonProps {
-    menuOpen: boolean;
-    setMenuOpen: (arg0: boolean) => any;
-}

package/dist/types/components/SiteHeaderV2/components/MenuButton/index.d.ts

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

package/dist/types/components/SiteHeaderV2/components/NavItem/NavItem.d.ts

@@ -1,35 +0,0 @@
-import { FC, ReactNode } from "react";
-export declare const NavItem: FC<NavItemProps>;
-export interface NavItemProps {
-    /**
-     * Contents of the NavItem. Must be SiteHeaderV2.ItemGroup or
-     * SiteHeaderV2.Column components.
-     */
-    children?: ReactNode;
-    /**
-     * A top-level URL for the NavItem to link to.
-     *
-     * When `children` are not present, the URL to link to when the NavItem is
-     * clicked or touched.
-     *
-     * When `children` are present, the URL to link to when a top-level link
-     * inside the NavItem panel is clicked or touched.
-     */
-    href?: string;
-    /**
-     * Should the NavItem be highlighted as the current item/page? Only applies if
-     * `children` are not present (and `href` is present).
-     */
-    isCurrent?: boolean;
-    /**
-     * Top-level text to display in the NavItem.
-     */
-    title: string;
-    /**
-     * On click handler.
-     */
-    onClick?: () => void;
-    isPrimary?: boolean;
-    opensFirstWithPanel?: boolean;
-    subTitle?: string;
-}

package/dist/types/components/SiteHeaderV2/components/NavItem/NavItemWithSubNav.d.ts

@@ -1,56 +0,0 @@
-import React, { FC, ReactElement, ReactNode } from "react";
-declare const Context: React.Context<{
-    navItem: React.MutableRefObject<HTMLLIElement> | null;
-    subTitle: string | null;
-}>;
-export declare const NavItemWithSubNav: FC<NavItemWithSubNavProps>;
-export interface NavItemWithSubNavProps {
-    /**
-     * The URL to link to when a top-level link inside the NavItemWithSubNav panel
-     * is clicked or touched.
-     */
-    href?: string;
-    /**
-     * Content to be displayed in the first slot of the NavItemWithSubNav. Must be
-     * a single SiteHeaderV2.SubNavItem component.
-     */
-    slot1: ReactElement;
-    /**
-     * Content to be displayed in the second slot of the NavItemWithSubNav. Must
-     * be a single SiteHeaderV2.SubNavItem component.
-     */
-    slot2?: ReactNode;
-    /**
-     * Content to be displayed in the third slot of the NavItemWithSubNav. Must be
-     * a single SiteHeaderV2.SubNavItem component.
-     */
-    slot3?: ReactNode;
-    /**
-     * Content to be displayed in the fourth slot of the NavItemWithSubNav. Must be
-     * a single SiteHeaderV2.SubNavItem component.
-     */
-    slot4?: ReactNode;
-    slot5?: ReactNode;
-    slot6?: ReactNode;
-    /**
-     * Title text to display inside the NavItemWithSubNav panel.
-     */
-    subTitle?: string;
-    /**
-     * Top-level text to display in the NavItemWithSubNav.
-     */
-    title: string;
-    /**
-     * Text to display in top-level link inside the NavItemWithSubNav panel. Only
-     * applies if `href` is true. If not provided, text will be automatically
-     * generated from `title`.
-     */
-    viewAllTitle?: string;
-    /**
-     * view all click handler.
-     */
-    onViewAllClick?: () => void;
-    isPrimary?: boolean;
-    opensFirstWithPanel?: boolean;
-}
-export { Context as NavItemContext };

package/dist/types/components/SiteHeaderV2/components/NavItem/index.d.ts

@@ -1,2 +0,0 @@
-export { NavItem } from "./NavItem";
-export { NavItemWithSubNav } from "./NavItemWithSubNav";

package/dist/types/components/SiteHeaderV2/components/NodeItem/NodeItem.d.ts

@@ -1,8 +0,0 @@
-import { FC, ReactNode } from "react";
-export declare const NodeItem: FC<NodeItemProps>;
-export interface NodeItemProps {
-    /**
-     * Content to display with `SiteHeaderV2.NodeItem`
-     */
-    children?: ReactNode;
-}

package/dist/types/components/SiteHeaderV2/components/Panel/Panel.d.ts

@@ -1,26 +0,0 @@
-import React, { FC, ReactElement, ReactNode } from "react";
-export declare const Panel: FC<PanelProps> & {
-    ViewAll: typeof ViewAll;
-};
-export declare const ViewAll: FC<ViewAllProps>;
-export interface ViewAllProps {
-    href: string;
-    title?: string;
-    onClick?: () => void;
-    buttonStyle: "primary" | "secondary" | "tertiary" | "warning" | undefined;
-}
-export interface PanelProps {
-    children: ReactNode;
-    navItemRef: React.MutableRefObject<HTMLElement> | null;
-    isNavItem: boolean;
-    open: boolean;
-    setOpen: (arg0: boolean) => any;
-    setOpenPanelOnFirstClick: (arg0: boolean) => any;
-    subNavItemRef?: React.MutableRefObject<HTMLElement>;
-    subNavLink?: string;
-    title?: ReactNode;
-    viewAll?: ReactElement;
-    withSubNav?: boolean;
-    subtitle?: ReactNode;
-    isPrimary?: boolean;
-}

package/dist/types/components/SiteHeaderV2/components/Panel/index.d.ts

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

package/dist/types/components/SiteHeaderV2/components/SubNavItem/SubNavItem.d.ts

@@ -1,45 +0,0 @@
-import { FC, ReactNode } from "react";
-import { ArcIcon } from "../../../../types/arc-icon";
-export declare const SubNavItem: FC<SubNavItemProps>;
-export interface SubNavItemProps {
-    /**
-     * Contents of the SubNavItem. Must be SiteHeaderV2.ItemGroup or
-     * SiteHeaderV2.Column components.
-     */
-    children?: ReactNode;
-    /**
-     * Should the SubNavItem be the default open item in a
-     * SiteHeaderV2.NavItemWithSubNav? If not specified, the default open item will
-     * be set automatically.
-     */
-    isDefaultItem?: boolean;
-    /**
-     * Optionally shift the SubNavItem-link upwards (in "desktop" viewports only)
-     * to close off any empty space between items due to content size.
-     */
-    offsetXL?: "24" | "48";
-    /**
-     * A URL to link to when the SubNavItem is clicked or touched. Only applies if
-     * `children` are not present.
-     */
-    href?: string;
-    /**
-     * Optional subtitle text for the SubNavItem.
-     */
-    subTitle?: string;
-    /**
-     * Title text for the SubNavItem.
-     */
-    title: string;
-    /**
-     * Text to display in top-level link inside the SubNavItem panel. Only
-     * applies if both `children` are present and `href` is true. If not
-     * provided, top-level link text will be automatically generated from `title`.
-     */
-    viewAllTitle?: string;
-    icon?: ArcIcon;
-    /**
-     * On click handler.
-     */
-    onClick?: () => void;
-}

package/dist/types/components/SiteHeaderV2/components/SubNavItem/index.d.ts

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

package/dist/types/components/SiteHeaderV2/components/VerticalDivider/VerticalDivider.d.ts

@@ -1,2 +0,0 @@
-/// <reference types="react" />
-export declare const VerticalDivider: () => JSX.Element;

package/dist/types/components/SiteHeaderV2/components/VerticalDivider/index.d.ts

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

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

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

package/dist/types/components/Skeleton/Skeleton.d.ts

@@ -1,23 +0,0 @@
-import { FC } from "react";
-/**
- * Use `Skeleton` to display a placeholder preview of your page before the data gets loaded to reduce load-time frustration.
- */
-export declare const Skeleton: FC<SkeletonProps>;
-export interface SkeletonProps {
-    /**
-     * Animation for `Skeleton`.
-     */
-    animation?: "pulse" | "shimmer" | "none";
-    /**
-     * Make `Skeleton` a circle.
-     */
-    isCircle?: boolean;
-    /**
-     * Width of `Skeleton`.
-     */
-    width?: string | number;
-    /**
-     * Height of `Skeleton`.
-     */
-    height?: string | number;
-}

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

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

package/dist/types/components/SkipLink/SkipLink.d.ts

@@ -1,12 +0,0 @@
-import { FC, ReactNode } from "react";
-import { SkipLinkItem } from "./SkipLinkItem/SkipLinkItem";
-/** Use `SkipLink` to help keyboard-only users skip to the main content on a page. */
-export declare const SkipLink: FC<SkipLinkProps> & {
-    Item: typeof SkipLinkItem;
-};
-export interface SkipLinkProps {
-    /**
-     * Links to display in the SkipLink.Item.
-     */
-    children?: ReactNode;
-}

package/dist/types/components/SkipLink/SkipLinkItem/SkipLinkItem.d.ts

@@ -1,16 +0,0 @@
-import { FC } from "react";
-export declare const SkipLinkItem: FC<SkipLinkItemProps>;
-export interface SkipLinkItemProps {
-    /**
-     * The label to display for SkipLink.Item.
-     */
-    label: string;
-    /**
-     * The URL the skip link navigates to.
-     */
-    href?: string;
-    /**
-     * The ID attribute of the target element the skip link navigates to.
-     */
-    id?: string;
-}

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

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

package/dist/types/components/Spinner/Spinner.d.ts

@@ -1,16 +0,0 @@
-import { FC } from "react";
-/**
- * Use `Spinner` to display a loading state.
- */
-export declare const Spinner: FC<SpinnerProps>;
-export type SpinnerSize = "s" | "m" | "l" | "xl" | "xxl";
-export interface SpinnerProps {
-    /**
-     * Colour options. If no `color` option defined, the colour will use currentColor.
-     */
-    color?: "light" | "dark" | undefined;
-    /**
-     * Set sizes of spinner `s`, `m`, `l`, `xl`, `xxl` or a custom number value e.g. `100`px.
-     */
-    size?: SpinnerSize | number | null;
-}

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

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