@royaloperahouse/chord 2.5.0 → 2.5.1-a-chord-development

package/dist/components/atoms/AriaAlternativeDescription/AriaAlternative.d.ts

@@ -0,0 +1,5 @@
+import { FunctionComponent } from 'react';
+import { IAriaAlternativeProps, IAriaHideProps } from '../../../types/ariaAlternative';
+/** A temporary screen-reader accessibility workaround for components with issues that can't be resolved quickly. Allows us to use aria-hidden on components with stuctural HTML markup issues until they can be rebuilt to be screen-reader compatible, or on components whose data does not translate well to screen-reader users. **/
+export declare const AriaHide: FunctionComponent<IAriaHideProps>;
+export declare const AriaAlternative: FunctionComponent<IAriaAlternativeProps>;

package/dist/components/atoms/AriaAlternativeDescription/AriaAlternative.style.d.ts

@@ -0,0 +1,3 @@
+import { IAriaHideProps } from '../../../types/ariaAlternative';
+export declare const AriaAlternativeDescription: import("styled-components").StyledComponent<"a", any, {}, never>;
+export declare const AriaHideOnDevice: import("styled-components").StyledComponent<"div", any, IAriaHideProps, never>;

package/dist/components/atoms/AriaAlternativeDescription/index.d.ts

@@ -0,0 +1,2 @@
+import { AriaAlternative, AriaHide } from './AriaAlternative';
+export { AriaAlternative, AriaHide };

package/dist/components/atoms/Grid/GridItemLegacy.d.ts

@@ -0,0 +1,8 @@
+import { IGridItemProps } from '../../../types/types';
+/**
+ * # IMPORTANT
+ * Please use the `<GridItem />` component instead of this component if possible.
+ * This component was introduced due to incompatibilities between versions of the Chord library.
+ */
+declare const GridItemLegacy: import("styled-components").StyledComponent<"div", any, IGridItemProps, never>;
+export default GridItemLegacy;

package/dist/components/atoms/Grid/index.d.ts

@@ -1,3 +1,4 @@
 import Grid from './Grid';
 import GridItem from './GridItem';
-export { Grid, GridItem };
+import GridItemLegacy from './GridItemLegacy';
+export { Grid, GridItem, GridItemLegacy };

package/dist/components/atoms/ToggleButton/ToggleButton.d.ts

@@ -0,0 +1,29 @@
+import { FunctionComponent } from 'react';
+import { IToggleProps } from '../../../types/toggleButtonTypes';
+/**
+ * A ToggleButton component that renders a toggleable button with an icon and label.
+ *
+ * # Usage
+ * The primary use case this component was written for is to be used within a group of
+ * toggles for filtering content displayed on page. One such implementation can be found in
+ * Filter Toggles component. However, this component can be used anywhere a toggle
+ * button is needed.
+ * Toggle Button requires the toggling logic to be handled by the parent component
+ * and passed down to it as isToggleOn, onFilterItemClick, and onKeyDownHandler props.
+ *
+ * # Props
+ * - `isToggleOn`: Boolean indicating if the toggle is on.
+ * - `onFilterItemClick`: Function to handle the click event on the toggle button.
+ * - `onKeyDownHandler`: Function to handle the keydown event on the toggle button.
+ * - `item`: Object representing the item associated with the toggle button.
+ * - `ariaLabelledBy`: Recommended when used as part of a group of toggles under a common
+ * label or title. A string which should be identical to the id of the label or title.
+ *
+ * # Design and Accessibility
+ * - aria-labelledby is used to associate the toggle button with a label or title when
+ * used as part of a group of toggles.
+ * - The component is designed to be keyboard-navigable.
+ * - aria-selected is used to indicate the selected state of the toggle button.
+ */
+declare const ToggleButton: FunctionComponent<IToggleProps>;
+export default ToggleButton;

package/dist/components/atoms/ToggleButton/ToggleButton.style.d.ts

@@ -0,0 +1,5 @@
+interface SelectionProps {
+    isSelected: boolean;
+}
+declare const Tile: import("styled-components").StyledComponent<"div", any, SelectionProps, never>;
+export default Tile;

package/dist/components/atoms/Typography/Typography.d.ts

@@ -1,7 +1,7 @@
 import { IAltHeaderProps, IBodyTextProps, IHeaderProps, IOverlineProps, IStyledTag, ISubtitleProps } from '../../../types/typography';
-export declare const StyledTag: ({ tag, typography, children, level }: IStyledTag) => JSX.Element;
+export declare const StyledTag: ({ tag, typography, children, level, id }: IStyledTag) => JSX.Element;
 export declare const AltHeader: ({ semanticLevel, level, children }: IAltHeaderProps) => JSX.Element;
 export declare const BodyText: ({ level, children, tag }: IBodyTextProps) => JSX.Element;
 export declare const Header: ({ semanticLevel, level, children }: IHeaderProps) => JSX.Element;
-export declare const Overline: ({ level, children, tag }: IOverlineProps) => JSX.Element;
+export declare const Overline: ({ level, children, tag, id }: IOverlineProps) => JSX.Element;
 export declare const Subtitle: ({ level, children, tag }: ISubtitleProps) => JSX.Element;

package/dist/components/atoms/index.d.ts

@@ -1,7 +1,7 @@
 import { CinemaBadge, StreamBadge } from './Badge';
 import { PrimaryButton, SecondaryButton, TertiaryButton } from './Buttons';
 import ControlledDropdown from './ControlledDropdown';
-import { Grid, GridItem } from './Grid';
+import { Grid, GridItem, GridItemLegacy } from './Grid';
 import { Icon } from './Icons';
 import ImageAspectRatioWrapper from './ImageAspectRatioWrapper';
 import Progress from './Progress';
@@ -25,4 +25,5 @@ import TypeTags from './TypeTags';
 import { AltHeader, BodyText, Header, Overline, Subtitle } from './Typography';
 import VideoControls from './VideoControls';
 import { Stepper } from './Stepper';
-export { AltHeader, BodyText, CinemaBadge, ControlledDropdown, Grid, GridItem, Header, Icon, ImageAspectRatioWrapper, Overline, Progress, PrimaryButton, Radio, Radio2, RotatorButtons, SecondaryButton, SecondaryLogo, SectionSplitter, SponsorLogo, Sponsorship, Stepper, StreamBadge, Subtitle, Tab, TabLink, TertiaryButton, TextArea, TextField, TextFieldLegacy, TextLink, TextLogo, Tickbox, Tickbox2, Timer, TypeTags, VideoControls, };
+import ToggleButton from './ToggleButton/ToggleButton';
+export { AltHeader, BodyText, CinemaBadge, ControlledDropdown, Grid, GridItem, GridItemLegacy, Header, Icon, ImageAspectRatioWrapper, Overline, Progress, PrimaryButton, Radio, Radio2, RotatorButtons, SecondaryButton, SecondaryLogo, SectionSplitter, SponsorLogo, Sponsorship, Stepper, StreamBadge, Subtitle, Tab, TabLink, TertiaryButton, TextArea, TextField, TextFieldLegacy, TextLink, TextLogo, Tickbox, Tickbox2, Timer, TypeTags, VideoControls, ToggleButton, };

package/dist/components/index.d.ts

@@ -1,6 +1,6 @@
-import { AltHeader, BodyText, CinemaBadge, ControlledDropdown, Grid, GridItem, Header, Icon, ImageAspectRatioWrapper, Overline, PrimaryButton, Progress, Radio, Radio2, RotatorButtons, SecondaryButton, SecondaryLogo, TertiaryButton, SectionSplitter, Sponsorship, Stepper, StreamBadge, Subtitle, Tab, TabLink, TextLogo, TextArea, TextField, TextFieldLegacy, TextLink, Tickbox, Tickbox2, Timer, TypeTags, VideoControls } from './atoms';
-import { AnchorTabBar, Footer, LiveChat, Navigation, StickyBar, TitleWithCTA, UpsellSection } from './organisms';
+import { AltHeader, BodyText, CinemaBadge, ControlledDropdown, Grid, GridItem, GridItemLegacy, Header, Icon, ImageAspectRatioWrapper, Overline, PrimaryButton, Progress, Radio, Radio2, RotatorButtons, SecondaryButton, SecondaryLogo, TertiaryButton, SectionSplitter, Sponsorship, Stepper, StreamBadge, Subtitle, Tab, TabLink, TextLogo, TextArea, TextField, TextFieldLegacy, TextLink, Tickbox, Tickbox2, Timer, TypeTags, VideoControls, ToggleButton } from './atoms';
+import { AnchorTabBar, Footer, LiveChat, Navigation, StickyBar, TitleWithCTA, UpsellSection, FilterToggles } from './organisms';
 import { Accordion, Accordions, AnnouncementBanner, AuxiliaryNav, Card, Cards, ContactCard, ContentSummary, CreditListing, Editorial, ImageWithCaption, Information, PageHeadingCinema, PageHeadingCompact, PageHeadingCore, PageHeadingImpact, PageHeadingPanel, PageHeadingStream, PasswordStrength, Pagination, PeopleListing, PromoWithTags, PromoWithTitle, RadioGroup, RadioGroup2, ReadMore, StatusBanner, SearchBar, SectionTitle, Select, Select2, Select2Async, Table, Tabs, TextOnly, UpsellCard, Quote, VideoWithControls } from './molecules';
 import ThemeProvider from '../styles/ThemeProvider';
 import GlobalStyles from '../styles/GlobalStyles';
-export { Accordion, Accordions, AnnouncementBanner, AltHeader, AnchorTabBar, AuxiliaryNav, BodyText, Card, Cards, ContactCard, ContentSummary, CinemaBadge, ControlledDropdown, CreditListing, Editorial, Footer, GlobalStyles, Grid, GridItem, Header, Icon, ImageAspectRatioWrapper, ImageWithCaption, Information, Navigation, Overline, PageHeadingCinema, PageHeadingCompact, PageHeadingCore, PageHeadingImpact, PageHeadingPanel, PageHeadingStream, Pagination, PasswordStrength, PeopleListing, PrimaryButton, Progress, PromoWithTags, PromoWithTitle, Radio, Radio2, RadioGroup, RadioGroup2, ReadMore, RotatorButtons, SecondaryButton, SecondaryLogo, StatusBanner, SearchBar, SectionTitle, Select, Select2, Select2Async, Sponsorship, Stepper, StickyBar, StreamBadge, Subtitle, TertiaryButton, TextOnly, ThemeProvider, TitleWithCTA, SectionSplitter, Tab, TabLink, Table, Tabs, TextArea, TextField, TextFieldLegacy, TextLink, TextLogo, Tickbox, Tickbox2, Timer, TypeTags, UpsellCard, UpsellSection, Quote, LiveChat, VideoControls, VideoWithControls, };
+export { Accordion, Accordions, AnnouncementBanner, AltHeader, AnchorTabBar, AuxiliaryNav, BodyText, Card, Cards, ContactCard, ContentSummary, CinemaBadge, ControlledDropdown, CreditListing, Editorial, Footer, GlobalStyles, Grid, GridItem, GridItemLegacy, Header, Icon, ImageAspectRatioWrapper, ImageWithCaption, Information, Navigation, Overline, PageHeadingCinema, PageHeadingCompact, PageHeadingCore, PageHeadingImpact, PageHeadingPanel, PageHeadingStream, Pagination, PasswordStrength, PeopleListing, PrimaryButton, Progress, PromoWithTags, PromoWithTitle, Radio, Radio2, RadioGroup, RadioGroup2, ReadMore, RotatorButtons, SecondaryButton, SecondaryLogo, StatusBanner, SearchBar, SectionTitle, Select, Select2, Select2Async, Sponsorship, Stepper, StickyBar, StreamBadge, Subtitle, TertiaryButton, TextOnly, ThemeProvider, TitleWithCTA, SectionSplitter, Tab, TabLink, Table, Tabs, TextArea, TextField, TextFieldLegacy, TextLink, TextLogo, Tickbox, Tickbox2, Timer, TypeTags, UpsellCard, UpsellSection, Quote, LiveChat, VideoControls, VideoWithControls, FilterToggles, ToggleButton, };

package/dist/components/molecules/PageHeading/index.d.ts

@@ -4,4 +4,4 @@ import PageHeadingImpact from './Impact';
 import PageHeadingPanel from './Panel';
 import PageHeadingStream from './Stream';
 import PageHeadingCompact from './Compact/Compact';
-export { PageHeadingCinema, PageHeadingCore, PageHeadingImpact, PageHeadingStream, PageHeadingCompact, PageHeadingPanel, };
+export { PageHeadingCinema, PageHeadingCore, PageHeadingImpact, PageHeadingPanel, PageHeadingStream, PageHeadingCompact, };

package/dist/components/molecules/PeopleListing/CreditListing/CreditListing.style.d.ts

@@ -5,3 +5,4 @@ export declare const CreditListingWrapper: import("styled-components").StyledCom
 export declare const DescriptionWrapper: import("styled-components").StyledComponent<"div", any, {}, never>;
 export declare const RoleWrapper: import("styled-components").StyledComponent<"div", any, {}, never>;
 export declare const CreditWrapper: import("styled-components").StyledComponent<"div", any, {}, never>;
+export declare const CreditBodyWrapper: import("styled-components").StyledComponent<"div", any, {}, never>;

package/dist/components/molecules/Table/Table.style.d.ts

@@ -16,4 +16,4 @@ export declare const PageNumber: import("styled-components").StyledComponent<"bu
 }, never>;
 export declare const Next: import("styled-components").StyledComponent<"span", any, {}, never>;
 export declare const ScrollButtons: import("styled-components").StyledComponent<"div", any, {}, never>;
-export declare const AriaDescription: import("styled-components").StyledComponent<"span", any, {}, never>;
+export declare const AriaDescription: import("styled-components").StyledComponent<"div", any, {}, never>;

package/dist/components/molecules/index.d.ts

@@ -27,8 +27,8 @@ import ImageWithCaption from './ImageWithCaption';
 import Quote from './Quote';
 import MiniCard from './MiniCard';
 import ReadMore from './ReadMore';
-import AuxiliaryNav from './AuxiliaryNav';
 import PasswordStrength from './PasswordStrength';
+import AuxiliaryNav from './AuxiliaryNav';
 import Table from './Table';
 import VideoWithControls from './VideoWithControls';
 export { Accordion, Accordions, AnnouncementBanner, AuxiliaryNav, Card, Cards, ContactCard, ContentSummary, CreditListing, Editorial, ImageWithCaption, Information, MiniCard, PageHeadingCinema, PageHeadingCompact, PageHeadingCore, PageHeadingImpact, PageHeadingPanel, PageHeadingStream, PasswordStrength, Pagination, PeopleListing, PromoWithTags, PromoWithTitle, RadioGroup, RadioGroup2, ReadMore, Quote, StatusBanner, SectionTitle, SearchBar, Select, Select2, Select2Async, Tabs, Table, TextOnly, UpsellCard, VideoWithControls, };

package/dist/components/organisms/FilterToggles/FilterToggles.d.ts

@@ -0,0 +1,26 @@
+import React from 'react';
+import { Props } from '.';
+/**
+ * A FilterToggles component that renders a labelled group of toggle buttons
+ * for filtering page content.
+ *
+ * # Usage
+ * This component is designed to be used within a filter context, where multiple items
+ * can be toggled on or off. The parent component should handle the toggling and filtering logic.
+ * toggling logic and state should be passed to filter Toggles as onclickHandler and selectedItems props.
+ *
+ * # Props
+ * - `filterItems`: Array of filter items to be displayed as toggle buttons. Each item should
+ *     be an object with a param string, label string, and disableIfActive array containing
+ *     params of items to be untoggled when the given item is toggled on.
+ * - `onClickHandler`: Function to handle the click event on each toggle button.
+ * - `selectedItems`: Array of selected filter item parameters. Likely to be a piece of state
+ *    mutated by onClickHandler in the parent component.
+ * - `title`: String for the title of the filter section.
+ *
+ * # Design and Accessibility
+ *  - aria-labelledby is used to associate the filter section with a label.
+ *  - The component is designed to be keyboard-navigable.
+ */
+export declare const FilterToggles: ({ filterItems, onClickHandler, selectedItems, title, }: Props) => React.ReactElement;
+export default FilterToggles;

package/dist/components/organisms/FilterToggles/FilterToggles.style.d.ts

@@ -0,0 +1,2 @@
+export declare const FiltersWrapper: import("styled-components").StyledComponent<"div", any, {}, never>;
+export declare const FilterItemsWrapper: import("styled-components").StyledComponent<"div", any, {}, never>;

package/dist/components/organisms/FilterToggles/index.d.ts

@@ -0,0 +1,23 @@
+import FilterToggles from './FilterToggles';
+import { FilterConfig } from '../../../types/toggleButtonTypes';
+export interface Props {
+    /**
+     * Array of filter configurations.
+     * @type {FilterConfig[]}
+     */
+    filterItems: FilterConfig[];
+    /**
+     * Handler function to be called when a filter item is clicked.
+     * @param filter - The filter configuration that was clicked.
+     */
+    onClickHandler: (filter: FilterConfig) => void;
+    /**
+     * Array of selected item identifiers.
+     */
+    selectedItems: string[];
+    /**
+     * Optional title for the component.
+     */
+    title?: string;
+}
+export default FilterToggles;

package/dist/components/organisms/index.d.ts

@@ -6,4 +6,5 @@ import UpsellSection from './UpsellSection';
 import { LiveChat } from './LiveChat';
 import StickyBar from './StickyBar';
 import ModalWindow from './ModalWindow';
-export { AnchorTabBar, Footer, LiveChat, ModalWindow, Navigation, StickyBar, TitleWithCTA, UpsellSection };
+import FilterToggles from './FilterToggles';
+export { AnchorTabBar, Footer, LiveChat, ModalWindow, Navigation, StickyBar, TitleWithCTA, UpsellSection, FilterToggles, };

package/dist/index.d.ts

@@ -1,8 +1,9 @@
-import { Accordion, Accordions, AnnouncementBanner, AltHeader, AnchorTabBar, AuxiliaryNav, BodyText, Card, Cards, CinemaBadge, ContactCard, ContentSummary, ControlledDropdown, CreditListing, Editorial, Footer, GlobalStyles, Grid, GridItem, Header, Icon, ImageAspectRatioWrapper, ImageWithCaption, Information, LiveChat, Navigation, Overline, PageHeadingCinema, PageHeadingCompact, PageHeadingCore, PageHeadingImpact, PageHeadingPanel, PageHeadingStream, Pagination, PasswordStrength, PeopleListing, PrimaryButton, Progress, PromoWithTags, PromoWithTitle, Radio, Radio2, RadioGroup, RadioGroup2, ReadMore, RotatorButtons, StatusBanner, SearchBar, SecondaryButton, SecondaryLogo, SectionSplitter, SectionTitle, Select, Select2, Select2Async, Sponsorship, StickyBar, Stepper, StreamBadge, Subtitle, TertiaryButton, TextOnly, ThemeProvider, TitleWithCTA, Tab, Table, TabLink, Tabs, TextArea, TextField, TextFieldLegacy, TextLink, Tickbox, Tickbox2, Timer, TypeTags, UpsellCard, UpsellSection, Quote, VideoControls, VideoWithControls } from './components';
+import { Accordion, Accordions, AnnouncementBanner, AltHeader, AnchorTabBar, AuxiliaryNav, BodyText, Card, Cards, CinemaBadge, ContactCard, ContentSummary, ControlledDropdown, CreditListing, Editorial, Footer, GlobalStyles, Grid, GridItem, GridItemLegacy, Header, Icon, ImageAspectRatioWrapper, ImageWithCaption, Information, LiveChat, Navigation, Overline, PageHeadingCinema, PageHeadingCompact, PageHeadingCore, PageHeadingImpact, PageHeadingPanel, PageHeadingStream, Pagination, PasswordStrength, PeopleListing, PrimaryButton, Progress, PromoWithTags, PromoWithTitle, Radio, Radio2, RadioGroup, RadioGroup2, ReadMore, RotatorButtons, StatusBanner, SearchBar, SecondaryButton, SecondaryLogo, SectionSplitter, SectionTitle, Select, Select2, Select2Async, Sponsorship, Stepper, StickyBar, StreamBadge, Subtitle, TertiaryButton, TextOnly, ThemeProvider, TitleWithCTA, Tab, Table, TabLink, Tabs, TextArea, TextField, TextFieldLegacy, TextLink, Tickbox, Tickbox2, Timer, TypeTags, UpsellCard, UpsellSection, Quote, VideoControls, VideoWithControls, FilterToggles, ToggleButton } from './components';
 import { devices, breakpoints } from './styles/viewports';
 import zIndexes from './styles/zIndexes';
 import { AspectRatio, ButtonType, CarouselType, Colors, IconNameType, IntegratedTimerProps, ITimerProps, TickboxMode, ThemeType, EditorialLink, IInformationTitleProps, IInformationCTAProps, IInformationBackgroundColour } from './types';
 import { MiniCard } from './components/molecules';
+import { BrandingStyle } from './types/impactHeader';
 import { ModalWindow } from './components/organisms';
 import AuxiliaryButton from './components/atoms/Buttons/Auxiliary/AuxiliaryButton';
-export { Accordion, Accordions, AnnouncementBanner, AltHeader, AnchorTabBar, AuxiliaryButton, AuxiliaryNav, AspectRatio, BodyText, breakpoints, ButtonType, Card, Cards, CarouselType, CinemaBadge, Colors, ContactCard, ContentSummary, ControlledDropdown, CreditListing, devices, Editorial, EditorialLink, Footer, GlobalStyles, Grid, GridItem, Header, Icon, IconNameType, ImageAspectRatioWrapper, ImageWithCaption, Information, IInformationBackgroundColour, IInformationCTAProps, IInformationTitleProps, ITimerProps, IntegratedTimerProps, LiveChat, MiniCard, ModalWindow, Navigation, Overline, PageHeadingCinema, PageHeadingCompact, PageHeadingCore, PageHeadingImpact, PageHeadingPanel, PageHeadingStream, Pagination, PasswordStrength, PeopleListing, PrimaryButton, Progress, PromoWithTags, PromoWithTitle, Radio, Radio2, RadioGroup, RadioGroup2, ReadMore, RotatorButtons, StatusBanner, SearchBar, SecondaryButton, SecondaryLogo, SectionSplitter, SectionTitle, Select, Select2, Select2Async, Sponsorship, StickyBar, Stepper, StreamBadge, Subtitle, Tab, Table, TabLink, Tabs, TertiaryButton, TextArea, TextField, TextFieldLegacy, TextLink, TextOnly, ThemeProvider, ThemeType, TitleWithCTA, Tickbox, Tickbox2, TickboxMode, Timer, TypeTags, UpsellCard, UpsellSection, Quote, VideoControls, VideoWithControls, zIndexes, };
+export { Accordion, Accordions, AnnouncementBanner, AltHeader, AnchorTabBar, AuxiliaryButton, AuxiliaryNav, AspectRatio, BodyText, BrandingStyle, breakpoints, ButtonType, Card, Cards, CarouselType, CinemaBadge, Colors, ContactCard, ContentSummary, ControlledDropdown, CreditListing, devices, Editorial, EditorialLink, Footer, GlobalStyles, Grid, GridItem, GridItemLegacy, Header, Icon, IconNameType, ImageAspectRatioWrapper, ImageWithCaption, Information, IInformationBackgroundColour, IInformationCTAProps, IInformationTitleProps, ITimerProps, IntegratedTimerProps, LiveChat, MiniCard, ModalWindow, Navigation, Overline, PageHeadingCinema, PageHeadingCompact, PageHeadingCore, PageHeadingImpact, PageHeadingPanel, PageHeadingStream, Pagination, PasswordStrength, PeopleListing, PrimaryButton, Progress, PromoWithTags, PromoWithTitle, Radio, Radio2, RadioGroup, RadioGroup2, ReadMore, RotatorButtons, StatusBanner, SearchBar, SecondaryButton, SecondaryLogo, SectionSplitter, SectionTitle, Select, Select2, Select2Async, Sponsorship, Stepper, StickyBar, StreamBadge, Subtitle, Tab, Table, TabLink, Tabs, TertiaryButton, TextArea, TextField, TextFieldLegacy, TextLink, TextOnly, ThemeProvider, ThemeType, TitleWithCTA, Tickbox, Tickbox2, TickboxMode, Timer, TypeTags, UpsellCard, UpsellSection, Quote, VideoControls, VideoWithControls, zIndexes, FilterToggles, ToggleButton, };

package/dist/types/ariaAlternative.d.ts

@@ -0,0 +1,34 @@
+export interface IAriaAlternativeProps {
+    /**
+     * A temporary screen-reader accessibility workaround for components with issues that can't be resolved quickly.
+     * Allows us to use aria-hidden on components with stuctural HTML markup issues until they can be rebuilt to be screen-reader compatible.
+     */
+    /**
+     * Description of the content being communicated by this component.
+     */
+    description: string;
+    /**
+     * originalContent - parse in the data from the original component / response object.
+     */
+    originalContent: Array<{
+        key: string;
+        value: string;
+    }>;
+    /**
+     * speechValues - input contextual speech values here to build a sentence, e.g. "you have" , "tickets for" , etc.
+     */
+    speechValues: Array<{
+        key: string;
+        value: string;
+    }>;
+    /**
+     * Disable this component (for testing purposes).
+     */
+    disabled?: boolean;
+}
+export interface IAriaHideProps {
+    /**
+     * Inert - disables all focusable child elements, necessary if using aria-hidden
+     */
+    inert: boolean;
+}

package/dist/types/formTypes.d.ts

@@ -265,17 +265,8 @@ export interface IStepperProps {
     step?: number;
     /** An error message to be shown below the stepper.
      *
-     * Default: `undefined`
      */
     error?: string;
-    /**
-     * A style prop that allows us to change what colours to
-     * use for light or dark mode (e.g. text color, border color, etc...)
-     * based on the background color.
-     *
-     * Defaults to `false`.
-     */
-    darkMode?: boolean;
     /**
      * Set disapled state
      */
@@ -284,6 +275,18 @@ export interface IStepperProps {
      * Minimum value allowed in the stepper
      */
     min?: number;
+    /**
+     * A style prop that allows us to change what colours to
+     * use for light or dark mode (e.g. text color, border color, etc...)
+     * based on the background color.
+     *
+     * Defaults to `false`.
+     * Specify whether or not the containing element has a dark background.
+     * This property affects the border colours for focused and error states.
+     *
+     * Default: `false`
+     */
+    darkMode?: boolean;
     /**
      * Maximum value allowed in the stepper
      */

package/dist/types/toggleButtonTypes.d.ts

@@ -0,0 +1,26 @@
+import { AnchorHTMLAttributes } from 'react';
+export interface FilterConfig {
+    /**
+     * Parameter associated with the filter item. Won't be displayed to the user.
+     */
+    param: string;
+    /**
+     * Label for the filter. Will be displayed to the user.
+     */
+    label: string;
+    /**
+     * Array of params of fitler items which will be disabled when this item is toggled on.
+     */
+    disableIfActive: string[];
+    /**
+     * Optional: id for use in filtering logic in parent component. Not used in the component itself.
+     */
+    id?: string;
+}
+export interface IToggleProps extends AnchorHTMLAttributes<HTMLElement> {
+    isToggleOn: boolean;
+    onFilterItemClick: (filter: FilterConfig) => void;
+    onKeyDownHandler: (e: React.KeyboardEvent<HTMLElement>, filter: FilterConfig) => void;
+    item: FilterConfig;
+    ariaLabelledBy?: string;
+}

package/dist/types/typography.d.ts

@@ -85,5 +85,9 @@ export interface IOverlineProps extends IGenericTypography {
      * HTML tag to use to render Overline, by default div.
      */
     tag?: React.ElementType;
+    /**
+     * Id for Overline component.
+     */
+    id?: string;
 }
 export {};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@royaloperahouse/chord",
-  "version": "2.5.0",
+  "version": "2.5.1-a-chord-development",
   "author": "Royal Opera House",
   "license": "MIT",
   "main": "dist/index.js",

package/README.GIT

@@ -1,277 +0,0 @@
-# Royal Opera House Chord - Front End Design System
-
-Welcome to The Royal Opera House Front End Design System, `@royaloperahouse/chord`
-
-This package is a library of UI components intended to be used in the ROH website.
-
-It uses React, TypeScript, TSDX and Storybook.
-
-The NPM packages are published at [https://www.npmjs.com/package/@royaloperahouse/chord](https://www.npmjs.com/package/@royaloperahouse/chord)
-
-The Storybook for the latest version of the library is hosted at [chord.roh.org.uk](chord.roh.org.uk)
-
-
-## Prerequisites
----
-
-* Make sure the required package dependencies are installed using `yarn install`
-
-* If this is the first time you are working on Chord, make sure to run `yarn build` to build all the modules.
-
-* **To deploy the storybook publicly** you will need credentials for the **parent** 'Royal Opera House' AWS account in your `~/.aws/credentials` file.
-  * The deploy script expects these to be called `[parent]`.
-
-  * You can find these values at:
-  
-    *AWS 'Your Applications' page -> 'Royal Opera House' -> 'Developer Access' -> 'Command line or programmatic access'*
-
-* **To deploy a preview** for demo / QA you will need the `CHROMATIC_PROJECT_TOKEN` -- find this in 1Password
-
-
-* **To publish the NPM package** you will need the ROH `NPM_TOKEN` -- find this in 1Password
-
-
-## Versioning
----
-
-We use [Semantic Versioning](https://semver.org/) for Chord.
-
-Given a version number MAJOR.MINOR.PATCH, increment the:
-
-* MAJOR version when you make incompatible library changes
-* MINOR version when you add functionality in a backwards compatible manner
-* PATCH version when you make backwards compatible bug fixes
-
-When you create a new release always update the `CHANGELOG` and `package.json`
-
-Increment your version from the latest stable version on `chord-releases`
-
-
-## Deploying the Storybook
----
-
-### **1. To build and deploy locally**
-
-You can quickly build and serve the contents of `/storybook-static` from your local machine, for development and manual testing. To do this run:
-
-```bash
-yarn storybook
-```
-
-By default the storybook will be accessible at
-[http://localhost:6006/]()
-
-The server will hot-reload on most changes.
-
-### **2. To deploy a preview version remotely**
-
-You can deploy a release candidate, or work-in-progress to [Chromatic](https://www.chromatic.com/) for showcase or QA.
-
-**NOTE:** you will need the `CHROMATIC_PROJECT_TOKEN` as described in *Prerequisites* above.
-
-Either set the token as a shell variable or use a `.env` file in the chord root directory containing the token, as so:
-
-```
-CHROMATIC_PROJECT_TOKEN=tokengoeshere
-```
-
-Run:
-
-```
-yarn deploy-storybook-dev
-```
-
-to build and deploy the storybook from your repo to Chromatic.
-
-You will find the address of your deployed storybook in the console output, looking something like this:
-
-`→ View your Storybook at https://randomHexString-randomAlphabeticalString.chromatic.com`
-
-### **3. To deploy a release version**
- 
-You can deploy the contents of `./storybook-static` to S3 as a static site, which is permanently accessible at [chord.roh.org.uk](chord.roh.org.uk)
-
-**NOTE:** To do this you will need the correct `AWS` credentials set up, as described in *Prerequisites* above.
-
-First build the storybook using:
-
-```
-yarn build-storybook
-```
-
-then run:
-
-```bash
-yarn deploy-storybook
-```
-
-> **IMPORTANT:** This URL is intended to showcase the latest stable version of Chord, it should be kept up to date with the main `chord-releases` branch and should **only** be used for release versions. If you want to deploy a development version follow the steps above under *To deploy a preview version remotely*.
-
-
-## Releasing a New Package Version
----
-
-This is the procedure for releasing a new Chord NPM package.
-
-There are two types of package:
-
-A **snapshot** can be published to use a development version of the Chord library in our frontend staging environments, to perform integrated, manual testing.
-
-A **stable** package is published for use in production.
-
-**NOTE:** You will need the `NPM_TOKEN`, as described in 'Prerequisites' above.
-
-### **1. To release a snapshot version**
-
-> **IMPORTANT:** Make sure you always publish your **snapshots** from `chord-development` after merging in your feature branch.
-
-For snapshots, `RELEASE_VERSION` should be the same as the latest **stable** version of the Chord Library, as found in `chord-releases`, followed by an **unused** lowercase letter.
-
-For example, if the latest stable release was 1.42.0, and the last snapshot published to NPM was 1.42.0-w, you would use RELEASE_VERSION `1.42.0-x`
-
-To publish a snapshot use:
-
-```bash
-NPM_ROH_TOKEN={NPM_TOKEN} RELEASE_VERSION={RELEASE_VERSION} yarn publish-snapshot
-```
-
-The version published to NPM will be named, e.g. `1.42.0-a-chord-development`, use this to install the snapshot package in the frontend repos.
-
-### **2. To release a stable version**
-
-> **IMPORTANT:** Make sure you always publish your **stable** packages from `chord-releases` after merging in your feature branch.
-
-For stable releases, increment your version from the latest **stable** version found on `chord-releases`, following the rules described in *Versioning* above, and use this as `RELEASE_VERSION`. (Make sure it matches the version in your `package.json` and `CHANGELOG.md`!)
-
-To publish a stable package use:
-
-```bash
-NPM_ROH_TOKEN={NPM_TOKEN} RELEASE_VERSION={RELEASE_VERSION} yarn publish-release
-```
-
-
-## Using the Package
----
-
-The package is deployed to NPM, and can be installed using yarn or npm:
-
-```bash
-npm i --save @royaloperahouse/chord
-```
-```bash
-yarn add @royaloperahouse/chord
-```
-
-
-## Testing
----
-
-To **Lint** the package use:
-
-```bash
-yarn lint
-# Use the --fix option to perform automatic fixes
-```
-
-To run the **unit tests** (using Jest) use:
-
-```bash
-yarn test
-
-# Use the -u option to update snapshots if needed
-# Run `yarn test:watch` to re-run tests on changes
-```
-
-To **run and and store the unit tests** for display in storybook use:
-
-```bash
-yarn test-storybook
-# Use the -u option to update snapshots if needed
-```
-
-
-## Development Process
----
-
-### **1. Branching Model**
-* The Chord project lives in the `roh-components` *monorepo*
-* When working on Chord, treat the `roh-components/packages/chord` directory as your root
-* The Chord **development** branch is currently `chord-development`
-* The Chord **main** branch is currently `chord-releases`
-* All work should be done on a correctly named **feature branch** of the format: `issueType/ticketNumber-short-description-of-feature`, e.g. `feature/RD-1234-update-chord-documentation`
-* Always create your feature branch FROM, and submit pull requests TO, the **main** branch
-* For **QA / UAT** of a Chord component in isolation: following review you should deploy a preview version to Chromatic straight from your **feature branch** _without_ merging to development
-* For releasing an **NPM snapshot**: merge your feature branch into the **development** branch and publish the NPM snapshot from there
-
-### **2. Detailed Workflow**
-
-#### **Before review:**
-
-* Git pull the latest version of `chord-releases`
-* Checkout a new, correctly-named feature branch from `chord releases`
-* Do your work on this feature branch
-* Run: `yarn lint`
-* Run: `yarn test`
-* Commit your changes
-* Create a pull request from your feature branch to `chord-releases`
-* Add the appropriate reviewers
-
-#### **Before QA / UAT:**
-
-After your PR is approved, you have two options:
-
-**i.** For QA of a component in isolation:
-
-* Follow the steps above in *Deploying the Storybook -> 2. Deploying a preview version remotely*
-* Share the generated Chromatic URL with the appropriate people for QA / UAT
-
-**ii.** For integrated testing of a component in the frontend staging environments:
-
-* Check out the `chord-development` branch
-* Merge your work in to `chord-development`
-* Follow the steps above under *Publishing a New Package Version -> 1. To release a snapshot version*
-* Git push the updated `chord-development` branch to remote
-* Finally, in the frontend repo:
-
-1. Update the `package.json` to reference the new snapshot version
-2. Run: `yarn install`
-3. Deploy the frontend to a staging environment
-
-#### **When ready for production:**
-
-* Return to your chord **feature branch**
-* Update the chord version in `package.json`, incrementing from the last **stable** release, found in `chord-releases`, and following the rules described in the *Versioning* section
-* Update `CHANGELOG.md`, adding the new version number and a short description of your changes
-* Run: `yarn lint`
-* Run: `yarn test`
-* Run: `yarn test-storybook -u`
-* Run: `yarn build-storybook`
-* Git commit, push, and update your PR for final approval
-* Merge your approved PR to `chord-releases`
-* Follow the steps in *Publishing a New Package Version -> 2. To release a stable version* to publish the NPM package
-* Finally, follow the steps in *Deploying The Storybook -> 3. To deploy a release version*, to update the public Chord Storybook page
-
-Once you have successfully published a new release version, you can open a ticket to update to this version in any of the frontend repos.
-
-
-## Notes
----
-### The `storybook-static` folder
-
-This folder contains all the HTML / JS required to deploy the Storybook as a static site. It's autogenerated whenever the Storybook is built and therefore will show up a lot of merge conflicts when you merge other branches into your feature branch. It is best to leave generating the storybook until the later part of your workflow, but in case you run into conflicts earlier, it's ok to just delete the folder and regenerate using:
-
-```bash
-yarn build-storybook
-```
-
-For the same reason changes to this folder will cause a lot of big diffs, when looking at a PR, but can mostly be skimmed over unless something looks unusual.
-
----
-### Examples
-
-There is an example implementation in the example folder. Alternatively there are also integration examples in storybook. Make sure to keep these updated so as to showcase the current components available.
-
----
-### Bundle analysis
-
-Calculate the real cost of your library using [size-limit](https://github.com/ai/size-limit) with `yarn size` and visualize it with `yarn analyze`.