@royaloperahouse/harmonic 0.1.7-d → 0.1.8-a

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/dist/index.d.ts CHANGED
@@ -1,9 +1,9 @@
1
1
  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, 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, SignUpForm } from './components';
2
2
  import { devices, breakpoints } from './styles/viewports';
3
3
  import zIndexes from './styles/zIndexes';
4
- import { AspectRatio, ButtonType, CarouselType, Colors, IconNameType, IntegratedTimerProps, ITimerProps, TickboxMode, ThemeType, EditorialLink, IInformationTitleProps, IInformationCTAProps, IInformationBackgroundColour } from './types';
4
+ import { AspectRatio, ButtonType, CarouselType, Colors, IconNameType, IntegratedTimerProps, ITimerProps, TickboxMode, ThemeType, EditorialLink, IInformationTitleProps, IInformationCTAProps } from './types';
5
5
  import { MiniCard } from './components/molecules';
6
6
  import { ModalWindow } from './components/organisms';
7
7
  import AuxiliaryButton from './components/atoms/Buttons/Auxiliary/AuxiliaryButton';
8
8
  import HarmonicThemeProvider from './styles/HarmonicThemeProvider';
9
- 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, HarmonicThemeProvider, Header, Icon, IconNameType, ImageAspectRatioWrapper, ImageWithCaption, Information, IInformationBackgroundColour, IInformationCTAProps, IInformationTitleProps, ITimerProps, IntegratedTimerProps, 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, SignUpForm, };
9
+ 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, HarmonicThemeProvider, Header, Icon, IconNameType, ImageAspectRatioWrapper, ImageWithCaption, Information, IInformationCTAProps, IInformationTitleProps, ITimerProps, IntegratedTimerProps, 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, SignUpForm, };
@@ -11,6 +11,6 @@ import { IPageHeadingCompactProps } from './impactHeader';
11
11
  import { IntegratedTimerProps, ITimerProps } from './timer';
12
12
  import { ICreditListing } from './creditListing';
13
13
  import { ModalWindowProps } from './modalWindow';
14
- import { IInformationTitleProps, IInformationCTAProps, IInformationBackgroundColour } from './information';
15
- export { AspectRatio, ButtonType, CarouselType, Colors, EditorialLink, IconNameType, ICreditListing, IPageHeadingCompactProps, INavigationProps, INavTopProps, IntegratedTimerProps, ITimerProps, ModalWindowProps, TickboxMode, ThemeType, IInformationTitleProps, IInformationCTAProps, IInformationBackgroundColour, };
14
+ import { IInformationTitleProps, IInformationCTAProps } from './information';
15
+ export { AspectRatio, ButtonType, CarouselType, Colors, EditorialLink, IconNameType, ICreditListing, IPageHeadingCompactProps, INavigationProps, INavTopProps, IntegratedTimerProps, ITimerProps, ModalWindowProps, TickboxMode, ThemeType, IInformationTitleProps, IInformationCTAProps, };
16
16
  export type { FooterData };
@@ -1,27 +1,13 @@
1
1
  import { DirectionType, IconNameType } from './iconTypes';
2
2
  import { LinkTarget } from './types';
3
- export declare enum IInformationCtaVariant {
4
- Primary = "Primary",
5
- Secondary = "Secondary",
6
- Tertiary = "Tertiary",
7
- TextLink = "TextLink"
8
- }
9
- export declare enum IInformationCtaTheme {
10
- Cinema = "Cinema",
11
- Core = "Core",
12
- Stream = "Stream"
13
- }
14
- export declare enum IInformationTitleVariant {
15
- Header = "Header",
16
- AltHeader = "AltHeader"
17
- }
18
- export declare enum IInformationBackgroundColour {
19
- Cinema = "cinema",
20
- Core = "core",
21
- Stream = "stream",
22
- White = "white"
23
- }
24
- export declare type TitleTextSize = 3 | 4 | 5 | 6;
3
+ import type { HarmonicSize } from './typography';
4
+ export declare const InformationCtaVariants: {
5
+ readonly Primary: "Primary";
6
+ readonly Secondary: "Secondary";
7
+ readonly Tertiary: "Tertiary";
8
+ readonly TextLink: "TextLink";
9
+ };
10
+ export declare type InformationCtaVariant = keyof typeof InformationCtaVariants;
25
11
  export interface IInformationCTAProps {
26
12
  /**
27
13
  * Text to display on the CTA
@@ -35,11 +21,7 @@ export interface IInformationCTAProps {
35
21
  * Style of the CTA. Choices are "Primary" (solid button background), "Secondary" (transparent button background)
36
22
  * or "Tertiary" (text only)
37
23
  */
38
- variant?: IInformationCtaVariant;
39
- /**
40
- * Flag to decide whether to adjust the CTA colours for display on coloured backgrounds
41
- */
42
- infoThemed: boolean;
24
+ variant?: InformationCtaVariant;
43
25
  /**
44
26
  * Name of the icon to be used in the button
45
27
  */
@@ -58,14 +40,10 @@ export interface IInformationTitleProps {
58
40
  * Title text to display
59
41
  */
60
42
  text: string;
61
- /**
62
- * Title typography type. Choices are Heading or AltHeader
63
- */
64
- variant: IInformationTitleVariant;
65
43
  /**
66
44
  * The size of the title text
67
45
  */
68
- textSize: TitleTextSize;
46
+ textSize: HarmonicSize;
69
47
  }
70
48
  export interface IInformationProps {
71
49
  /**
@@ -79,11 +57,7 @@ export interface IInformationProps {
79
57
  /**
80
58
  * Title options for the component
81
59
  */
82
- title: IInformationTitleProps;
83
- /**
84
- * Background Colour. Choices: None, Core, Cinema, Stream
85
- */
86
- background?: IInformationBackgroundColour;
60
+ title?: IInformationTitleProps;
87
61
  /**
88
62
  * Additional CSS class names to apply to component.
89
63
  */
@@ -539,6 +539,12 @@ export interface IAccordionsProps {
539
539
  */
540
540
  items: IAccordionProps[];
541
541
  }
542
+ export declare const BannerVariants: {
543
+ readonly 'service-persistent': "service-persistent";
544
+ readonly 'in-page-persistent': "in-page-persistent";
545
+ readonly 'in-page': "in-page";
546
+ };
547
+ export declare type BannerVariant = keyof typeof BannerVariants;
542
548
  export interface IAnnouncementBannerProps {
543
549
  /**
544
550
  * Announcement banner title
@@ -551,11 +557,23 @@ export interface IAnnouncementBannerProps {
551
557
  /**
552
558
  * Date and time text
553
559
  */
554
- time: string;
560
+ time?: string;
555
561
  /**
556
562
  * Icon graphic
557
563
  */
558
- icon: 'Info' | 'Clock' | 'Location' | 'Reminder' | 'Star';
564
+ icon?: 'Info' | 'Clock' | 'Location' | 'Reminder' | 'Star';
565
+ /**
566
+ * Custom CSS classes
567
+ */
568
+ className?: string;
569
+ /**
570
+ * Banner layout variant
571
+ */
572
+ variant?: BannerVariant;
573
+ /**
574
+ * Callback function to be executed when the banner is closed.
575
+ */
576
+ onClose?: () => void;
559
577
  }
560
578
  export interface IReadMoreProps {
561
579
  /**
@@ -1,9 +1,14 @@
1
1
  import { ReactNode } from 'react';
2
2
  import { StyledProps } from 'styled-components';
3
- export declare type HarmonicSize = 'small' | 'medium' | 'large';
4
- export declare type HarmonicColors = 'primary' | 'black' | 'white' | 'red' | 'grey';
5
- export interface IGenericTypographyProps {
6
- children: ReactNode;
3
+ export declare const HarmonicSizes: {
4
+ readonly Small: "small";
5
+ readonly Medium: "medium";
6
+ readonly Large: "large";
7
+ };
8
+ export declare type HarmonicSize = (typeof HarmonicSizes)[keyof typeof HarmonicSizes];
9
+ export declare type HarmonicColors = 'primary' | 'black' | 'white' | 'red' | 'grey' | 'inherit';
10
+ export interface IGenericTypographyProps<T extends HTMLElement = HTMLParagraphElement> extends React.HTMLAttributes<T> {
11
+ children?: ReactNode;
7
12
  size?: HarmonicSize;
8
13
  serif?: boolean;
9
14
  color?: HarmonicColors;
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@royaloperahouse/harmonic",
3
- "version": "0.1.7-d",
3
+ "version": "0.1.8-a",
4
4
  "author": "Royal Opera House",
5
5
  "license": "MIT",
6
6
  "main": "dist/index.js",