@royaloperahouse/harmonic 1.0.1-g → 1.0.2
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/CHANGELOG.md +3 -5
- package/README.GIT +293 -0
- package/README.md +43 -267
- package/dist/components/atoms/Dropdown/Dropdown.d.ts +1 -1
- package/dist/components/atoms/Tab/Tab.d.ts +1 -1
- package/dist/components/molecules/SkipToMain/SkipToMain.style.d.ts +1 -1
- package/dist/harmonic.cjs.development.css +0 -319
- package/dist/harmonic.cjs.development.js +65 -111
- package/dist/harmonic.cjs.development.js.map +1 -1
- package/dist/harmonic.cjs.production.min.js +1 -1
- package/dist/harmonic.cjs.production.min.js.map +1 -1
- package/dist/harmonic.esm.js +73 -122
- package/dist/harmonic.esm.js.map +1 -1
- package/dist/styles/HarmonicThemeProvider/HarmonicThemeProvider.d.ts +0 -1
- package/dist/types/modalWindow.d.ts +0 -4
- package/dist/types/types.d.ts +2 -43
- package/package.json +1 -1
package/dist/types/types.d.ts
CHANGED
|
@@ -147,10 +147,6 @@ export interface ITabProps {
|
|
|
147
147
|
* Additional CSS class names to apply to the navigation component.
|
|
148
148
|
*/
|
|
149
149
|
className?: string;
|
|
150
|
-
/**
|
|
151
|
-
* The unique ID to assign to the link element.
|
|
152
|
-
*/
|
|
153
|
-
tabLinkId?: string;
|
|
154
150
|
/**
|
|
155
151
|
* Defines the ARIA role of the element for accessibility purposes.
|
|
156
152
|
*/
|
|
@@ -226,11 +222,7 @@ export interface IDropdownProps {
|
|
|
226
222
|
*/
|
|
227
223
|
ariaLabel?: string;
|
|
228
224
|
/**
|
|
229
|
-
*
|
|
230
|
-
*/
|
|
231
|
-
tabLinkId?: string;
|
|
232
|
-
/**
|
|
233
|
-
* Defines if it is needed to trim the text of the Tab and add 3 dots in the end
|
|
225
|
+
* Defines if it is needed to trim the text of the Tab and add 3 dots in the end
|
|
234
226
|
*/
|
|
235
227
|
trimTabText?: boolean;
|
|
236
228
|
}
|
|
@@ -437,15 +429,7 @@ export declare type IHotFilterProps = {
|
|
|
437
429
|
selectedIndex?: number;
|
|
438
430
|
onSelect?: (index: number) => void;
|
|
439
431
|
};
|
|
440
|
-
export declare type ICastFilterItem = {
|
|
441
|
-
/**
|
|
442
|
-
* Stable identifier for selection mapping and rendering keys.
|
|
443
|
-
*/
|
|
444
|
-
id?: string | number;
|
|
445
|
-
/**
|
|
446
|
-
* Alternative stable identifier for selection mapping and rendering keys.
|
|
447
|
-
*/
|
|
448
|
-
slug?: string;
|
|
432
|
+
export declare type ICastFilterItem = Pick<AnchorHTMLAttributes<HTMLAnchorElement>, 'aria-label' | 'role'> & {
|
|
449
433
|
/**
|
|
450
434
|
* Name of the cast member shown below the image circle. Required.
|
|
451
435
|
*/
|
|
@@ -454,15 +438,6 @@ export declare type ICastFilterItem = {
|
|
|
454
438
|
* Image source for the image to be shown. Optional but if not included an unaesthetic placeholder will show.
|
|
455
439
|
*/
|
|
456
440
|
image?: string;
|
|
457
|
-
/**
|
|
458
|
-
* Optional accessible name for the option. If omitted, `name` is used.
|
|
459
|
-
*/
|
|
460
|
-
'aria-label'?: string;
|
|
461
|
-
/**
|
|
462
|
-
* Kept for backwards compatibility with existing integrations.
|
|
463
|
-
* CastFilter always renders option semantics and ignores this value at runtime.
|
|
464
|
-
*/
|
|
465
|
-
role?: string;
|
|
466
441
|
onClick?: () => void;
|
|
467
442
|
};
|
|
468
443
|
export declare type ICastFiltersProps = {
|
|
@@ -473,14 +448,8 @@ export declare type ICastFiltersProps = {
|
|
|
473
448
|
cast: ICastFilterItem[];
|
|
474
449
|
/**
|
|
475
450
|
* Indices of currently selected cast in the `cast` array.
|
|
476
|
-
* Legacy API kept for backwards compatibility.
|
|
477
451
|
*/
|
|
478
452
|
selectedIndices?: number[];
|
|
479
|
-
/**
|
|
480
|
-
* Stable IDs/slugs of currently selected cast items.
|
|
481
|
-
* Prefer this over `selectedIndices` for stable selection across reordering.
|
|
482
|
-
*/
|
|
483
|
-
selectedIds?: Array<string | number>;
|
|
484
453
|
/**
|
|
485
454
|
* Text shown at the top of the component, e.g. 'Filter by cast'. If this is not provided
|
|
486
455
|
* the component will render without any.
|
|
@@ -510,22 +479,12 @@ export declare type ICastFiltersProps = {
|
|
|
510
479
|
listRoleDescription?: string;
|
|
511
480
|
/**
|
|
512
481
|
* Handle selecting individual cast filters.
|
|
513
|
-
* Legacy API kept for backwards compatibility.
|
|
514
482
|
*/
|
|
515
483
|
onSelect?: (index: number) => void;
|
|
516
|
-
/**
|
|
517
|
-
* Handle selecting individual cast filters using stable item ID/slug.
|
|
518
|
-
*/
|
|
519
|
-
onSelectId?: (id: string) => void;
|
|
520
484
|
/**
|
|
521
485
|
* Handle clicking the primary CTA.
|
|
522
|
-
* Legacy API kept for backwards compatibility.
|
|
523
486
|
*/
|
|
524
487
|
onApply?: (indices: number[]) => void;
|
|
525
|
-
/**
|
|
526
|
-
* Handle clicking the primary CTA using stable selected IDs/slugs.
|
|
527
|
-
*/
|
|
528
|
-
onApplyIds?: (ids: string[]) => void;
|
|
529
488
|
/**
|
|
530
489
|
* Handle clicking the text link.
|
|
531
490
|
*/
|