@royaloperahouse/harmonic 0.13.4 → 0.14.0

package/dist/types/types.d.ts

@@ -421,6 +421,67 @@ export declare type IHotFilterProps = {
     selectedIndex?: number;
     onSelect?: (index: number) => void;
 };
+export declare type ICastFilterItem = Pick<AnchorHTMLAttributes<HTMLAnchorElement>, 'aria-label' | 'role'> & {
+    /**
+     * Name of the cast member shown below the image circle. Required.
+     */
+    name: string;
+    /**
+     * Image source for the image to be shown. Optional but if not included an unaesthetic placeholder will show.
+     */
+    image?: string;
+    onClick?: () => void;
+};
+export declare type ICastFiltersProps = {
+    className?: string;
+    /**
+     * Array of cast to filter by.
+     */
+    cast: ICastFilterItem[];
+    /**
+     * Indices of currently selected cast in the `cast` array.
+     */
+    selectedIndices?: number[];
+    /**
+     * Text shown at the top of the component, e.g. 'Filter by cast'. If this is not provided
+     * the component will render without any.
+     */
+    headingText?: string;
+    /**
+     * Override the text of the primary CTA. Default is 'Apply'.
+     */
+    ctaText?: string;
+    /**
+     * Override the text of the text link. Default is 'Clear'.
+     */
+    textLinkText?: string;
+    /**
+     * Text to show if no selection is made.
+     */
+    emptySelectionText?: string;
+    /**
+     * Default image to show in cases where a cast member image prop is missing.
+     * If this is undefined then a light grey background will be displayed instead.
+     */
+    placeholderImage?: string;
+    /**
+     * Description to be used as aria-roledescription of the cast filter listbox.
+     * Read out by screen readers to describe the contents of the list.
+     */
+    listRoleDescription?: string;
+    /**
+     * Handle selecting individual cast filters.
+     */
+    onSelect?: (index: number) => void;
+    /**
+     * Handle clicking the primary CTA.
+     */
+    onApply?: (indices: number[]) => void;
+    /**
+     * Handle clicking the text link.
+     */
+    onClear?: () => void;
+};
 export interface ISponsorshipProps {
     /**
      * Source URL for Sponsorship IFRAME.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@royaloperahouse/harmonic",
-  "version": "0.13.4",
+  "version": "0.14.0",
   "author": "Royal Opera House",
   "license": "MIT",
   "main": "dist/index.js",