@arc-ui/components 11.8.0 → 11.10.0

package/dist/_shared/cjs/NavItem-df20237c.d.ts

@@ -1,43 +0,0 @@
-import { FC, ReactNode } from "react";
-declare const NavItem: FC<NavItemProps>;
-interface NavItemProps {
-    /**
-     * Contents of the NavItem. Must be SiteHeader.ItemGroup or
-     * SiteHeader.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;
-    /**
-     * Content to display in the NavItem panel promo area.
-     */
-    promo?: ReactNode;
-    /**
-     * Top-level text to display in the NavItem.
-     */
-    title: string;
-    /**
-     * Text to display in top-level link inside the NavItem 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;
-    /**
-     * On click handler.
-     */
-    onClick?: () => void;
-}
-export { NavItem, NavItemProps };

package/dist/_shared/cjs/NavItemWithSubNav-65f21828.d.ts

@@ -1,49 +0,0 @@
-/// <reference types="react" />
-import React from "react";
-import { FC, ReactElement, ReactNode } from "react";
-declare const Context: React.Context<{
-    navItem: React.MutableRefObject<HTMLLIElement> | null;
-    subTitle: string | null;
-}>;
-declare const NavItemWithSubNav: FC<NavItemWithSubNavProps>;
-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 SiteHeader.SubNavItem component.
-     */
-    slot1: ReactElement;
-    /**
-     * Content to be displayed in the second slot of the NavItemWithSubNav. Must
-     * be a single SiteHeader.SubNavItem component.
-     */
-    slot2: ReactNode;
-    /**
-     * Content to be displayed in the third slot of the NavItemWithSubNav. Must be
-     * a single SiteHeader.SubNavItem component.
-     */
-    slot3?: 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;
-}
-export { NavItemWithSubNav, NavItemWithSubNavProps, Context as NavItemContext };

package/dist/_shared/cjs/Poster-faea1ad3.d.ts

@@ -1,81 +0,0 @@
-import React from "react";
-import { FC, ReactNode } from "react";
-import { anchorPoints } from "./index-9483ad5f";
-import { loadingOptions } from "./Image-0e393cbf";
-declare const PosterVideo: FC<PosterVideoProps>;
-interface PosterVideoProps {
-    /**
-     * Anchor point for the Poster.Video,
-     */
-    anchor?: typeof anchorPoints[number];
-    /**
-     * Should the Poster.Video autoplay?
-     */
-    autoPlay?: boolean;
-    /**
-     * HTML video sources for the Poster.Video. [See MDN](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/video).
-     */
-    children: ReactNode;
-    /**
-     * Should the Poster.Video loop?
-     */
-    loop?: boolean;
-}
-declare const PosterImage: FC<PosterImageProps>;
-interface PosterImageProps {
-    /**
-     * Alternative text for the Poster.Image, shown if the image cannot be displayed. Consider avoiding this prop if the image is for decorative purposes only.
-     */
-    alt?: string;
-    /**
-     * Anchor point for the Poster.Image.
-     */
-    anchor?: typeof anchorPoints[number];
-    /**
-     * Loading behaviour of the Poster.Image.
-     */
-    loading?: typeof loadingOptions[number];
-    /**
-     * The HTML [sizes](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/img#Example_4_Using_the_srcset_and_sizes_attributes) attribute for the Poster.Image. Required if `srcSet` is defined.
-     */
-    sizes?: string;
-    /**
-     * The `src` for the Poster.Image. Used if srcSet is not defined, or as a fallback.
-     */
-    src: string;
-    /**
-     * A comma-separated list indicating a set of possible sources for the user agent to use for different screen sizes for the Poster.Image. Same format as [srcSet](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/img#Example_4_Using_the_srcset_and_sizes_attributes), i.e. `my-image-200.png 200w, my-image-200.png 200w`.
-     */
-    srcSet?: string;
-    /**
-     * Contents of the PosterImage.
-     */
-    children?: React.ReactNode;
-}
-/**
- * Use `Poster` to compose content on an image or video background.
- */
-declare const Poster: FC<PosterProps> & {
-    Image: typeof PosterImage;
-    Video: typeof PosterVideo;
-};
-interface PosterProps {
-    /**
-     * Poster background to overlay content on top of. Must be one of Poster.Image or Poster.Video.
-     */
-    background: ReactNode;
-    /**
-     * Contents of the Poster. Each item will be wrapped in an PosterItem component.
-     */
-    children: ReactNode;
-    /**
-     * Apply an overlay to the Poster background, e.g. a scrim gradient for text legibility.
-     */
-    overlay?: boolean;
-    /**
-     * The background surface colour to show behind the Poster content before it loads.
-     * If using `overlay`, the gradient will match the surface.
-     */
-    surface?: "darker" | "lighter";
-}
-export { PosterVideo, PosterVideoProps, PosterImage, PosterImageProps, Poster, PosterProps };

package/dist/_shared/cjs/RadioGroup-d7664b0c.d.ts

@@ -1,97 +0,0 @@
-/// <reference types="react" />
-import React from "react";
-import { FC } from "react";
-import { FormControlProps } from "./FormControl-1e1bf2bf";
-/**
- * Radio Button component.
- */
-declare const RadioButton: FC<RadioButtonProps>;
-interface RadioButtonProps {
-    /**
-     * ID for the Radio Button.
-     */
-    id: string;
-    /**
-     * Should the RadioButton be disabled?
-     */
-    isDisabled?: boolean;
-    /**
-     * Helper text for the RadioButton, shown below the label.
-     */
-    helper?: string;
-    /**
-     * Label for the RadioButton.
-     */
-    label: string;
-    /**
-     * Current value (controlled).
-     */
-    value: string;
-}
-type EventType = React.ChangeEvent<HTMLInputElement>;
-type ContextProps = {
-    blurEvent: (event: EventType) => void;
-    changeEvent: (event: EventType) => void;
-    groupDisabled: boolean;
-    checkedValue: string;
-    labelSize: "s" | "l";
-    name: string;
-    size: "s" | "l";
-};
-declare const Provider: React.Provider<ContextProps>;
-declare const useRadioContext: () => ContextProps;
-type EventType$0 = React.ChangeEvent<HTMLInputElement>;
-/**
- * Use `RadioGroup` to wrap and control radio buttons and apply default values
- */
-declare const RadioGroup: FC<RadioGroupProps> & {
-    RadioButton: typeof RadioButton;
-};
-interface RadioGroupProps extends Omit<FormControlProps, "children" | "elementType" | "errorMessage" | "htmlFor" | "labelSize" | "requirementStatus" | "disclosureText" | "disclosureTitle" | "onClickDisclosure" | "helperUnderLabel" | "supplementaryInfo"> {
-    /**
-     * Contents of the RadioGroup. Should only contain `RadioGroup.RadioButton`
-     */
-    children?: React.ReactNode;
-    /**
-     * Value of the RadioButton that should be checked by default.
-     */
-    checkedValue: string;
-    /**
-     * Should all controls be disabled?
-     */
-    isDisabled?: boolean;
-    /**
-     * Helper message for the RadioGroup.
-     */
-    helper?: string;
-    /**
-     * ID for the RadioGroup.
-     */
-    id: string;
-    /**
-     * Label for the RadioGroup.
-     */
-    label: string;
-    /**
-     * Label size for the RadioGroup
-     */
-    labelSize?: "s" | "l";
-    /**
-     * Name for the RadioGroup.
-     */
-    name: string;
-    /**
-     * Function to call when the RadioGroup loses focus.
-     */
-    onBlur?: (e: EventType$0) => void;
-    /**
-     * Callback function to update the RadioGroup's controlled `checkedValue` prop,
-     * for example `e => setCheckedValue(e.target.value)`.
-     */
-    onChange?: (event: EventType$0) => void;
-    /**
-     * Size of the RadioGroup.
-     */
-    size?: "s" | "l";
-}
-export { RadioButton, RadioButtonProps, Provider, useRadioContext, RadioGroup, RadioGroupProps };

package/dist/_shared/cjs/Section-48aca5f5.d.ts

@@ -1,21 +0,0 @@
-import { FC, ReactNode } from "react";
-/**
- * Use `Section` to compose content into vertical page layouts.
- */
-declare const Section: FC<SectionProps>;
-interface SectionProps {
-    /**
-     * Content to display in the Section.
-     */
-    children: ReactNode;
-    /**
-     * Should the Section be visible for debugging and documentation
-     * purposes?
-     */
-    isDebugVisible?: boolean;
-    /**
-     * Should the width of this Section be unconstrained (filling the viewport)?
-     */
-    isFullWidth?: boolean;
-}
-export { Section, SectionProps };

package/dist/_shared/cjs/SiteFooter-5da774e1.d.ts

@@ -1,62 +0,0 @@
-import { FC, ReactNode } from "react";
-/**
- * Use `SiteFooter` to display information at the bottom of a page.
- */
-declare const SiteFooter: FC<SiteFooterProps> & {
-    Item: typeof SiteFooterItem;
-    ItemGroup: typeof SiteFooterItemGroup;
-};
-declare const SiteFooterItemGroup: FC<SiteFooterItemGroupProps>;
-declare const SiteFooterItem: FC<SiteFooterItemProps>;
-interface SiteFooterItemGroupProps {
-    /**
-     * Contents of the SiteFooterItemGroup. Must be SiteFooter.Item components.
-     */
-    children: ReactNode;
-    /**
-     * Title text for the SiteFooterItemGroup.
-     */
-    title: string;
-}
-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;
-}
-interface SiteFooterProps {
-    /**
-     * Secondary content of the SiteFooter. Must be SiteFooter.Item components.
-     */
-    children?: ReactNode;
-    /**
-     * Copyright year.
-     */
-    currentYear?: string;
-    /**
-     * Should the SiteFooter include a Curve?
-     */
-    curve?: boolean;
-    /**
-     * 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;
-}
-export { SiteFooter, SiteFooterItemGroup, SiteFooterItem, SiteFooterItemGroupProps, SiteFooterItemProps, SiteFooterProps };

package/dist/_shared/cjs/SiteHeader-c25ee36e.d.ts

@@ -1,78 +0,0 @@
-/// <reference types="react" />
-import React from "react";
-import { FC, ReactNode } from "react";
-import { subBrands } from "./BrandLogo-8107d59f";
-import { Column } from "./index-f419cf04";
-import { Item } from "./index-699086a7";
-import { ItemGroup } from "./index-e340924e";
-import { NavItem, NavItemWithSubNav } from "./index-e6d20018";
-import { NodeItem } from "./SiteHeader.rehydrator-acc9d8c4";
-import { SubNavItem } from "./index-74488a9f";
-declare const Context: React.Context<{
-    transparent: boolean;
-}>;
-/**
- * Use `SiteHeader` to display brand logo and navigation at the top of a page.
- */
-declare const SiteHeader: FC<SiteHeaderProps> & {
-    Column: typeof Column;
-    Item: typeof Item;
-    ItemGroup: typeof ItemGroup;
-    NavItem: typeof NavItem;
-    NodeItem: typeof NodeItem;
-    NavItemWithSubNav: typeof NavItemWithSubNav;
-    SubNavItem: typeof SubNavItem;
-};
-interface SiteHeaderProps {
-    /**
-     * Contents of the SiteHeader. Must be SiteHeader.NavItem or
-     * SiteHeader.NavItemWithSubNav components.
-     */
-    children?: ReactNode;
-    /**
-     * Basket component for the SiteHeader.
-     */
-    basket?: ReactNode;
-    /**
-     * Should account login links be included in the SiteHeader?
-     */
-    hasLogin?: boolean;
-    /**
-     * Should the SiteHeader have a transparent background?
-     */
-    isTransparent?: boolean;
-    /**
-     * A URL to link to when SiteHeader logo is clicked or touched.
-     */
-    loginHref?: string;
-    /**
-     * A Function to run to when SiteHeader logo is clicked or touched.
-     */
-    logoOnClick?: () => void;
-    /**
-     * A Function to run to when SiteHeader login links are clicked or touched.
-     */
-    loginOnClick?: () => void;
-    /**
-     * Text to display in SiteHeader login links.
-     */
-    loginTitle?: string;
-    /**
-     * A URL to link to when the SiteHeader brand logo link is clicked or touched.
-     */
-    logoHref?: string;
-    /**
-     * Accessible text for the SiteHeader brand logo link.
-     */
-    logoLabel?: string;
-    /**
-     * Search component for the SiteHeader.
-     */
-    search?: ReactNode;
-    /**
-     * Optional sub-brand variant. Only applies to BT.
-     */
-    subBrand?: typeof subBrands[number];
-}
-export { MenuButton } from "./SiteHeader.rehydrator-acc9d8c4";
-export { SiteHeader, SiteHeaderProps, Context as SiteHeaderContext };

package/dist/_shared/cjs/SiteHeader.rehydrator-acc9d8c4.d.ts

@@ -1,78 +0,0 @@
-/// <reference types="react" />
-import React from "react";
-import { FC, ReactNode, ReactElement } from "react";
-declare const MenuButton: FC<MenuButtonProps>;
-interface MenuButtonProps {
-    menuOpen: boolean;
-    setMenuOpen: (arg0: boolean) => any;
-}
-declare const NodeItem: FC<NodeItemProps>;
-interface NodeItemProps {
-    /**
-     * Content to display with `SiteHeader.NodeItem`
-     */
-    children?: ReactNode;
-}
-declare const _default: (el: HTMLLIElement, hydrate: any) => Promise<JSX.Element>;
-declare const _default: (el: HTMLDivElement, hydrate: any) => Promise<JSX.Element>;
-declare const _default: (el: HTMLLIElement, hydrate: any) => Promise<JSX.Element>;
-declare const Panel: FC<PanelProps> & {
-    ViewAll: typeof ViewAll;
-};
-declare const ViewAll: FC<ViewAllProps>;
-interface ViewAllProps {
-    href: string;
-    title: string;
-    onClick?: () => void;
-}
-interface PanelProps {
-    children: ReactNode;
-    navItemRef: React.MutableRefObject<HTMLElement> | null;
-    open: boolean;
-    promo?: ReactNode;
-    setOpen: (arg0: boolean) => any;
-    subNavItemRef?: React.MutableRefObject<HTMLElement>;
-    subNavLink?: string;
-    title?: ReactNode;
-    viewAll?: ReactElement;
-    withSubNav?: boolean;
-}
-declare const BackButton: FC<BackButtonProps>;
-interface BackButtonProps {
-    setOpen: (arg0: boolean) => any;
-}
-declare const Column: FC<ColumnProps>;
-interface ColumnProps {
-    /**
-     * Contents of the Column. Must be SiteHeader.ItemGroup components.
-     */
-    children: ReactNode;
-}
-declare const _default: (el: HTMLLIElement, hydrate: any) => Promise<JSX.Element>;
-declare const Item: FC<ItemProps>;
-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;
-    /**
-     * Should the Item be emphasised?
-     */
-    isEmphasised?: boolean;
-    /**
-     * On click handler.
-     */
-    onClick?: () => void;
-}
-declare const SiteHeaderRehydrator: {
-    (el: HTMLDivElement, hydrate: any): Promise<JSX.Element>;
-    ItemGroupRehydrator: (el: HTMLLIElement, hydrate: any) => Promise<JSX.Element>;
-    NavItemRehydrator: (el: HTMLLIElement, hydrate: any) => Promise<JSX.Element>;
-    NavItemWithSubNavRehydrator: (el: HTMLLIElement, hydrate: any) => Promise<JSX.Element>;
-    SubNavItemRehydrator: (el: HTMLDivElement, hydrate: any) => Promise<JSX.Element>;
-};
-export { _default as default, MenuButton, MenuButtonProps, NodeItem, NodeItemProps, Panel, ViewAll, ViewAllProps, PanelProps, BackButton, BackButtonProps, Column, ColumnProps, Item, ItemProps };

package/dist/_shared/cjs/SubNavItem-a84d1bf4.d.ts

@@ -1,48 +0,0 @@
-import { FC, ReactNode } from "react";
-declare const SubNavItem: FC<SubNavItemProps>;
-interface SubNavItemProps {
-    /**
-     * Contents of the SubNavItem. Must be SiteHeader.ItemGroup or
-     * SiteHeader.Column components.
-     */
-    children?: ReactNode;
-    /**
-     * Should the SubNavItem be the default open item in a
-     * SiteHeader.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";
-    /**
-     * Content to display in the SubNavItem panel promo area.
-     */
-    promo?: ReactNode;
-    /**
-     * 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;
-    /**
-     * On click handler.
-     */
-    onClick?: () => void;
-}
-export { SubNavItem, SubNavItemProps };

package/dist/_shared/cjs/Surface-b7c51b2b.d.ts

@@ -1,51 +0,0 @@
-/// <reference types="react" />
-import React from "react";
-import { FC, HTMLAttributes } from "react";
-type SurfaceBackground = "light" | "dark";
-declare const Context: React.Context<{
-    surface: SurfaceBackground;
-}>;
-/**
- * Use `Surface` to compose content using the Arc system.
- */
-declare const Surface: FC<SurfaceProps>;
-declare const backgrounds: readonly ["black", "brand", "brand-flat", "dark", "darker", "coral", "turquoise", "light", "lighter", "white"];
-declare const backgroundsBT: readonly ["black", "brand", "brand-flat", "dark", "darker", "coral", "turquoise", "light", "lighter", "white"];
-type SurfacePadding = "8" | "12" | "16" | "24" | "32" | "48" | "64";
-type SurfaceBackgroundColor = "black" | "brand" | "brand-flat" | "dark" | "darker" | "coral" | "turquoise" | "light" | "lighter" | "white";
-interface SurfaceProps extends HTMLAttributes<HTMLElement> {
-    /**
-     * Background colour of the Surface. Contents will change colour to meet
-     * accessibility requirements.
-     */
-    background?: SurfaceBackgroundColor;
-    /**
-     * Content to display on the Surface.
-     */
-    children?: any;
-    /**
-     * Should the Surface grow to take up all the available vertical space? Most
-     * of the time this should not be required, but useful to fix issues in
-     * certain layout combinations.
-     */
-    growVertically?: boolean;
-    /**
-     * _Caution: This is an experimental property and may be removed at any time._
-     *
-     * Size of the padding applied to all sides of the Surface. Use to prevent margin collapsing issues.
-     */
-    padding?: SurfacePadding;
-    /**
-     * _Caution: This is an experimental property and may be removed at any time._
-     *
-     * Size of the horizontal padding applied to the left and right of the Surface.
-     */
-    paddingHorizontal?: SurfacePadding;
-    /**
-     * _Caution: This is an experimental property and may be removed at any time._
-     *
-     * Size of the vertical padding applied to the top and bottom of the Surface.
-     */
-    paddingVertical?: SurfacePadding;
-}
-export { Surface, backgrounds, backgroundsBT, SurfacePadding, SurfaceBackgroundColor, SurfaceProps, Context as SurfaceContext };

package/dist/_shared/cjs/Text-fa447e2d.d.ts

@@ -1,38 +0,0 @@
-import { FC, ReactNode } from "react";
-/**
- * Use `Text` to display text.
- */
-declare const Text: FC<TextProps>;
-type Tone = "default" | "supporting" | "muted";
-type TextSize = "xs" | "s" | "m" | "l";
-interface TextProps {
-    /**
-     * Alignment of the Text.
-     */
-    align?: "left" | "center" | "right";
-    /**
-     * Text and inline markup to display.
-     */
-    children: ReactNode;
-    /**
-     * Should the Text component be styled as an inline element?
-     */
-    isInline?: boolean;
-    /**
-     * Should the Text width be constrained to a typographic measure?
-     */
-    isMeasured?: boolean;
-    /**
-     * Typographic Text size.
-     */
-    size?: TextSize;
-    /**
-     * Visual emphasis of the Text.
-     */
-    tone?: Tone;
-    /**
-     * Id for the Text.
-     */
-    id?: string;
-}
-export { Text, Tone, TextSize, TextProps };