@royaloperahouse/harmonic 0.11.0-i → 0.11.0

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.
Files changed (40) hide show
  1. package/CHANGELOG.md +3 -0
  2. package/README.GIT +278 -0
  3. package/README.md +43 -252
  4. package/dist/components/Typography/Typography.d.ts +2 -2
  5. package/dist/components/atoms/Dropdown/Dropdown.d.ts +1 -1
  6. package/dist/components/atoms/SectionSplitter/SectionSplitter.d.ts +1 -1
  7. package/dist/components/atoms/Tab/Tab.d.ts +1 -1
  8. package/dist/components/atoms/TextField/TextField.style.d.ts +1 -1
  9. package/dist/components/index.d.ts +2 -2
  10. package/dist/components/molecules/AnchorBar/AnchorBar.style.d.ts +1 -5
  11. package/dist/components/molecules/ContactCard/ContactCard.style.d.ts +4 -5
  12. package/dist/components/molecules/ContentSummary/ContentSummary.style.d.ts +1 -1
  13. package/dist/components/molecules/Information/Information.style.d.ts +1 -1
  14. package/dist/components/molecules/Pagination/Pagination.style.d.ts +1 -1
  15. package/dist/components/molecules/PromoWithTags/PromoWithTags.style.d.ts +6 -3
  16. package/dist/components/molecules/PromoWithTitle/PromoWithTitle.style.d.ts +1 -1
  17. package/dist/components/molecules/SectionTitle/SectionTitle.d.ts +1 -1
  18. package/dist/components/molecules/TextOnly/TextOnly.d.ts +4 -0
  19. package/dist/components/molecules/TextOnly/index.d.ts +2 -0
  20. package/dist/components/molecules/index.d.ts +2 -1
  21. package/dist/components/organisms/Footer/Footer.style.d.ts +5 -4
  22. package/dist/harmonic.cjs.development.css +16 -345
  23. package/dist/harmonic.cjs.development.js +545 -425
  24. package/dist/harmonic.cjs.development.js.map +1 -1
  25. package/dist/harmonic.cjs.production.min.js +1 -1
  26. package/dist/harmonic.cjs.production.min.js.map +1 -1
  27. package/dist/harmonic.esm.js +553 -436
  28. package/dist/harmonic.esm.js.map +1 -1
  29. package/dist/index.d.ts +2 -3
  30. package/dist/styles/HarmonicThemeProvider/HarmonicThemeProvider.d.ts +0 -1
  31. package/dist/types/anchorBar.d.ts +0 -2
  32. package/dist/types/contactCard.d.ts +22 -8
  33. package/dist/types/creditListing.d.ts +1 -1
  34. package/dist/types/promoWithTags.d.ts +1 -9
  35. package/dist/types/types.d.ts +33 -25
  36. package/dist/types/typography.d.ts +0 -4
  37. package/package.json +1 -1
  38. package/dist/components/molecules/BodyContent/BodyContent.d.ts +0 -4
  39. package/dist/components/molecules/BodyContent/index.d.ts +0 -2
  40. /package/dist/components/molecules/{BodyContent/BodyContent.style.d.ts → TextOnly/TextOnly.style.d.ts} +0 -0
package/dist/index.d.ts CHANGED
@@ -1,5 +1,4 @@
1
- import { Accordion, Accordions, AnchorBar, AnnouncementBanner, AltHeader, AnchorTabBar, AuxiliaryNav, BodyText, Card, Cards, Carousel, CinemaBadge, ContactCard, ContentSummary, ControlledDropdown, CreditListing, Editorial, Footer, GlobalStyles, Grid, GridItem, Header, HighlightsCarousel, HighlightsCarouselCinema, HighlightsCarouselCore, HighlightsCarouselStream, HotFilters, Icon, ImageAspectRatioWrapper, ImageWithCaption, Information, Navigation, MinimalCarousel, Overline, PageHeading, PageHeadingCompact, PageHeadingImpact, PageHeadingPanel, PageHeadingPromo, Pagination, PasswordStrength, PeopleListing, PrimaryButton, Progress, PromoWithTags, PromoWithTitle, Radio, Radio2, RadioGroup, RadioGroup2, ReadMore, RotatorButtons, StatusBanner, SearchBar, SecondaryButton, SecondaryLogo, SectionSplitter, SectionTitle, Select, Select2, Select2Async, SignUpForm, Sponsorship, StickyBar, Stepper, StreamBadge, Subtitle, TertiaryButton, ThemeProvider, TitleWithCTA, Tab, Table, TabLink, Tabs, TextArea, TextField, TextFieldLegacy, TextLink, Tickbox, Tickbox2, Timer, TypeTags, UpsellCard, UpsellSection, Quote, VideoControls, VideoWithControls } from './components';
2
- import BodyContent from './components/molecules/BodyContent';
1
+ import { Accordion, Accordions, AnchorBar, AnnouncementBanner, AltHeader, AnchorTabBar, AuxiliaryNav, BodyText, Card, Cards, Carousel, CinemaBadge, ContactCard, ContentSummary, ControlledDropdown, CreditListing, Editorial, Footer, GlobalStyles, Grid, GridItem, Header, HighlightsCarousel, HighlightsCarouselCinema, HighlightsCarouselCore, HighlightsCarouselStream, HotFilters, Icon, ImageAspectRatioWrapper, ImageWithCaption, Information, Navigation, MinimalCarousel, Overline, PageHeading, PageHeadingCompact, PageHeadingImpact, PageHeadingPanel, PageHeadingPromo, Pagination, PasswordStrength, PeopleListing, PrimaryButton, Progress, PromoWithTags, PromoWithTitle, Radio, Radio2, RadioGroup, RadioGroup2, ReadMore, RotatorButtons, StatusBanner, SearchBar, SecondaryButton, SecondaryLogo, SectionSplitter, SectionTitle, Select, Select2, Select2Async, SignUpForm, 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';
3
2
  import { devices, breakpoints } from './styles/viewports';
4
3
  import zIndexes from './styles/zIndexes';
5
4
  import { AspectRatio, ButtonType, CarouselType, Colors, IconNameType, IntegratedTimerProps, ITimerProps, TickboxMode, ThemeColor, ThemeType, EditorialLink, IInformationTitleProps, IInformationCTAProps } from './types';
@@ -9,4 +8,4 @@ import AuxiliaryButton from './components/atoms/Buttons/Auxiliary/AuxiliaryButto
9
8
  import HarmonicThemeProvider from './styles/HarmonicThemeProvider';
10
9
  import { HarmonicSize } from './types/typography';
11
10
  import { HarmonicHeader, HarmonicSubtitle, BodyCopyHarmonic, HarmonicOverline, ButtonText, Caption, NavigationText } from './components/Typography';
12
- export { Accordion, Accordions, AnchorBar, AnnouncementBanner, AltHeader, AnchorTabBar, AuxiliaryButton, AuxiliaryNav, AspectRatio, BodyContent, BodyText, breakpoints, ButtonType, Card, Cards, CarouselType, Carousel, CinemaBadge, Colors, ContactCard, ContentSummary, ControlledDropdown, CreditListing, devices, Editorial, EditorialLink, Footer, GlobalStyles, Grid, GridItem, HarmonicSize, HarmonicThemeProvider, Header, HighlightsCarousel, HighlightsCarouselCinema, HighlightsCarouselCore, HighlightsCarouselStream, HotFilters, Icon, IconNameType, ImageAspectRatioWrapper, ImageWithCaption, Information, IInformationCTAProps, IInformationTitleProps, ITimerProps, IntegratedTimerProps, MinimalCarousel, MiniCard, ModalWindow, Navigation, Overline, PageHeading, PageHeadingCompact, PageHeadingImpact, PageHeadingPanel, PageHeadingPromo, Pagination, PasswordStrength, PeopleListing, PrimaryButton, Progress, PromoWithTags, PromoWithTitle, Radio, Radio2, RadioGroup, RadioGroup2, ReadMore, RotatorButtons, StatusBanner, SearchBar, SecondaryButton, SecondaryLogo, SectionSplitter, SectionTitle, Select, Select2, Select2Async, SignUpForm, Sponsorship, StickyBar, Stepper, StreamBadge, Subtitle, Tab, Table, TabLink, Tabs, TertiaryButton, TextArea, TextField, TextFieldLegacy, TextLink, ThemeColor, ThemeProvider, ThemeType, TitleWithCTA, Tickbox, Tickbox2, TickboxMode, Timer, TypeTags, UpsellCard, UpsellSection, Quote, VideoControls, VideoWithControls, zIndexes, HarmonicHeader, HarmonicSubtitle, BodyCopyHarmonic, HarmonicOverline, ButtonText, Caption, NavigationText, };
11
+ export { Accordion, Accordions, AnchorBar, AnnouncementBanner, AltHeader, AnchorTabBar, AuxiliaryButton, AuxiliaryNav, AspectRatio, BodyText, breakpoints, ButtonType, Card, Cards, CarouselType, Carousel, CinemaBadge, Colors, ContactCard, ContentSummary, ControlledDropdown, CreditListing, devices, Editorial, EditorialLink, Footer, GlobalStyles, Grid, GridItem, HarmonicSize, HarmonicThemeProvider, Header, HighlightsCarousel, HighlightsCarouselCinema, HighlightsCarouselCore, HighlightsCarouselStream, HotFilters, Icon, IconNameType, ImageAspectRatioWrapper, ImageWithCaption, Information, IInformationCTAProps, IInformationTitleProps, ITimerProps, IntegratedTimerProps, MinimalCarousel, MiniCard, ModalWindow, Navigation, Overline, PageHeading, PageHeadingCompact, PageHeadingImpact, PageHeadingPanel, PageHeadingPromo, Pagination, PasswordStrength, PeopleListing, PrimaryButton, Progress, PromoWithTags, PromoWithTitle, Radio, Radio2, RadioGroup, RadioGroup2, ReadMore, RotatorButtons, StatusBanner, SearchBar, SecondaryButton, SecondaryLogo, SectionSplitter, SectionTitle, Select, Select2, Select2Async, SignUpForm, Sponsorship, StickyBar, Stepper, StreamBadge, Subtitle, Tab, Table, TabLink, Tabs, TertiaryButton, TextArea, TextField, TextFieldLegacy, TextLink, TextOnly, ThemeColor, ThemeProvider, ThemeType, TitleWithCTA, Tickbox, Tickbox2, TickboxMode, Timer, TypeTags, UpsellCard, UpsellSection, Quote, VideoControls, VideoWithControls, zIndexes, HarmonicHeader, HarmonicSubtitle, BodyCopyHarmonic, HarmonicOverline, ButtonText, Caption, NavigationText, };
@@ -1,7 +1,6 @@
1
1
  import React from 'react';
2
2
  import { ThemeType } from '../../types';
3
3
  import './theme/fonts.css';
4
- import './theme/typography.css';
5
4
  interface HarmonicThemeProviderProps {
6
5
  theme: ThemeType;
7
6
  children: React.ReactNode;
@@ -11,6 +11,4 @@ export interface IAnchorBarProps {
11
11
  onCloseHandler?: () => void;
12
12
  /** Custom CSS classes */
13
13
  className?: string;
14
- /** Flag indicating whether the anchor bar should have a shadow */
15
- withShadow?: boolean;
16
14
  }
@@ -1,12 +1,9 @@
1
+ import { StyledProps } from 'styled-components';
1
2
  export interface IContactCardProps {
2
3
  /**
3
- * Title
4
+ * Name
4
5
  */
5
- title: string;
6
- /**
7
- * Title suffix
8
- */
9
- titleSuffix?: string;
6
+ name: string;
10
7
  /**
11
8
  * Description
12
9
  */
@@ -28,7 +25,24 @@ export interface IContactCardProps {
28
25
  */
29
26
  address?: string;
30
27
  /**
31
- * The component's class name
28
+ * Set visibility of the top border
29
+ */
30
+ hideTopBorder?: boolean;
31
+ /**
32
+ * Set visibility of the top border
33
+ */
34
+ hideBottomBorder?: boolean;
35
+ }
36
+ export interface IContactCardWrapperProps extends StyledProps<{
37
+ hideTopBorder: boolean;
38
+ hideBottomBorder: boolean;
39
+ }> {
40
+ /**
41
+ * Set visibility of the top border
42
+ */
43
+ hideTopBorder: boolean;
44
+ /**
45
+ * Set visibility of the bottom border
32
46
  */
33
- className?: string;
47
+ hideBottomBorder: boolean;
34
48
  }
@@ -2,7 +2,7 @@ import { ListingPerson } from './types';
2
2
  export interface ICreditListing {
3
3
  roles: {
4
4
  name: string;
5
- people: ListingPerson[];
5
+ people: ListingPerson[] | ListingPerson[][];
6
6
  description: string;
7
7
  musicTitle: string[];
8
8
  replacement: string;
@@ -1,5 +1,5 @@
1
1
  import { ReactElement } from 'react';
2
- import { EditorialLink, PromoLinks, PromoTitleHierarchy } from './editorial';
2
+ import { EditorialLink, PromoLinks } from './editorial';
3
3
  import { IntegratedTimerProps } from './timer';
4
4
  import { Image } from './types';
5
5
  export interface IPromoWithTagsProps {
@@ -15,10 +15,6 @@ export interface IPromoWithTagsProps {
15
15
  * Title size
16
16
  */
17
17
  titleSize?: 'small' | 'large';
18
- /**
19
- * Semantic level of the promo title header - h2 or h3.
20
- */
21
- titleHierarchy: PromoTitleHierarchy;
22
18
  /**
23
19
  * Subtitle placed in the editorial component
24
20
  */
@@ -86,8 +82,4 @@ export interface IPromoWithTagsStyledProps {
86
82
  * Sets margin for the tags container
87
83
  */
88
84
  marginBottom?: number;
89
- /**
90
- * Sets mobile margin for the tags container
91
- */
92
- mobileMarginBottom?: number;
93
85
  }
@@ -154,10 +154,6 @@ export interface ITabProps {
154
154
  * Additional CSS class names to apply to the navigation component.
155
155
  */
156
156
  className?: string;
157
- /**
158
- * The unique ID to assign to the link element.
159
- */
160
- tabLinkId?: string;
161
157
  /**
162
158
  * Defines the ARIA role of the element for accessibility purposes.
163
159
  */
@@ -225,11 +221,7 @@ export interface IDropdownProps {
225
221
  */
226
222
  ariaLabel?: string;
227
223
  /**
228
- * The unique ID to assign to the link element inside the tab.
229
- */
230
- tabLinkId?: string;
231
- /**
232
- * Defines if it is needed to trim the text of the Tab and add 3 dots in the end
224
+ * Defines if it is needed to trim the text of the Tab and add 3 dots in the end
233
225
  */
234
226
  trimTabText?: boolean;
235
227
  }
@@ -466,10 +458,10 @@ export interface ITextLinkProps extends AnchorHTMLAttributes<HTMLAnchorElement>
466
458
  textColor?: ThemeColor;
467
459
  }
468
460
  export interface ISectionSplitterProps {
469
- /** Set the width of the Section to full */
461
+ /**
462
+ * Set the width of the Section to full
463
+ */
470
464
  fullWidth?: boolean;
471
- /** Custom CSS classes */
472
- className?: string;
473
465
  }
474
466
  export interface ITypeTagsProps {
475
467
  /**
@@ -477,30 +469,46 @@ export interface ITypeTagsProps {
477
469
  */
478
470
  list: string[];
479
471
  }
480
- export interface IBodyContentProps {
481
- /** Text placed in the BodyContent component */
472
+ export interface ITextOnlyProps {
473
+ /**
474
+ * Text placed in the TextOnly component
475
+ */
482
476
  text: string;
483
- /** Set columnStart in Desktop */
477
+ /**
478
+ * Set columnstart in Desktop
479
+ */
484
480
  columnStartDesktop?: number;
485
- /** Set columnSpan in Desktop */
481
+ /**
482
+ * Set columnSpan in Desktop
483
+ */
486
484
  columnSpanDesktop?: number;
487
- /** Set columnStart in Device */
485
+ /**
486
+ * Set columnstart in Device
487
+ */
488
488
  columnStartDevice?: number;
489
- /** Set columnSpan in Device */
489
+ /**
490
+ * Set columnSpam in Device
491
+ */
490
492
  columnSpanDevice?: number;
491
- /** Custom CSS classes */
492
- className?: string;
493
493
  }
494
494
  export declare type SectionTitleSize = 'small' | 'large';
495
495
  export interface ISectionTitleProps {
496
- /** Title to display. */
496
+ /**
497
+ * Title to display.
498
+ */
497
499
  title: string;
498
- /** Size of title to display - by default small, which renders as an H2 (and large is an H1). */
500
+ /**
501
+ * Size of title to display - by default small, which renders as an H2 (and large is an H1).
502
+ */
499
503
  size?: SectionTitleSize;
500
- /** Optional description that can be rendered below the title. */
504
+ /**
505
+ * Optional description that can be rendered below the title.
506
+ */
501
507
  description?: string;
502
- /** Custom CSS classes */
503
- className?: string;
508
+ /**
509
+ * Semantic level of the title.
510
+ */
511
+ semanticLevel?: TypographyLevel;
504
512
  }
505
513
  export interface ILogosProps {
506
514
  /**
@@ -25,10 +25,6 @@ export interface IGenericTypographyProps<T extends HTMLElement = HTMLParagraphEl
25
25
  export interface IHarmonicHeaderProps extends IGenericTypographyProps {
26
26
  hierarchy: HeaderHierarchy;
27
27
  }
28
- export interface IBodyCopyHarmonicProps extends IGenericTypographyProps {
29
- /** HTML tag to use to render BodyCopy, by default p. */
30
- tag?: React.ElementType;
31
- }
32
28
  export declare type TypographyLevel = 1 | 2 | 3 | 4 | 5 | 6;
33
29
  export declare type AltHeaderLevel = 3 | 4 | 5 | 6;
34
30
  export declare type BodyLevel = 1 | 2 | 3;
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@royaloperahouse/harmonic",
3
- "version": "0.11.0-i",
3
+ "version": "0.11.0",
4
4
  "author": "Royal Opera House",
5
5
  "license": "MIT",
6
6
  "main": "dist/index.js",
@@ -1,4 +0,0 @@
1
- import { FunctionComponent } from 'react';
2
- import { IBodyContentProps } from '../../../types/types';
3
- declare const BodyContent: FunctionComponent<IBodyContentProps>;
4
- export default BodyContent;
@@ -1,2 +0,0 @@
1
- import BodyContent from './BodyContent';
2
- export default BodyContent;