@royaloperahouse/harmonic 0.12.1-b → 0.12.1-c

package/dist/index.d.ts

@@ -1,5 +1,6 @@
-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, PageHeadingHighlight, 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';
+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, PageHeadingHighlight, 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, VideoControls, VideoWithControls } from './components';
 import BodyContent from './components/molecules/BodyContent';
+import Quote from './components/molecules/Quote';
 import { devices, breakpoints } from './styles/viewports';
 import zIndexes from './styles/zIndexes';
 import { AspectRatio, ButtonType, CarouselType, Colors, IconNameType, IntegratedTimerProps, ITimerProps, TickboxMode, ThemeColor, ThemeType, EditorialLink, IInformationTitleProps, IInformationCTAProps } from './types';

package/dist/types/image.d.ts

@@ -38,17 +38,13 @@ export interface IImageAspectRatioWrapperProps {
     alt?: string;
 }
 export interface IImageWithCaptionProps {
-    /**
-     * Aspect ratio of the contained image
-     */
+    /** Aspect ratio of the contained image */
     aspectRatio?: AspectRatio;
-    /**
-     * Image caption or credit
-     */
+    /** Image caption or credit */
     caption: string;
-    /**
-     * Image element
-     */
+    /** Alternative text describing the image content for accessibility purposes. */
+    altText?: string;
+    /** Image element */
     children: ReactElement<HTMLImageElement>;
 }
 export interface IImageWithCaptionWrapperProps extends StyledProps<{

package/dist/types/quote.d.ts

@@ -1,19 +1,8 @@
-import { StyledProps } from 'styled-components';
 export interface IQuoteProps {
-    /**
-     * Text placed in the Quote component
-     */
+    /** Text placed in the Quote component */
     text: string;
-    /**
-     * Attribution under the main text
-     */
+    /** Attribution under the main text */
     attribution?: string;
-}
-export interface IQuoteAttributionBlockProps extends StyledProps<{
-    displayAttribution: boolean;
-}> {
-    /**
-     * Set visibility of the attribution block
-     */
-    displayAttribution: boolean;
+    /** Custom CSS classes */
+    className?: string;
 }

package/dist/types/types.d.ts

@@ -346,10 +346,10 @@ export declare type ListingRole = {
     dataROH?: string;
 };
 export interface IPeopleListing {
-    /**
-     * List of roles to be displayed
-     */
+    /** List of roles to be displayed */
     roles: ListingRole[];
+    /** Custom CSS classes */
+    className?: string;
 }
 export interface IPagination {
     /**
@@ -722,13 +722,3 @@ export declare enum LinkTarget {
      */
     Blank = "_blank"
 }
-export interface ISkipToMainProps {
-    /**
-     * Custom CSS class
-     */
-    className?: string;
-    /**
-     * Defines which tag the button should skip to. Default: "main"
-     */
-    skipToTag?: string;
-}

package/dist/types/typography.d.ts

@@ -22,9 +22,13 @@ export interface IGenericTypographyProps<T extends HTMLElement = HTMLParagraphEl
     bold?: boolean;
     className?: string;
 }
-export interface IHarmonicHeaderProps extends IGenericTypographyProps {
+export declare type HarmonicHeaderProps = (IGenericTypographyProps<HTMLHeadingElement> & {
     hierarchy: HeaderHierarchy;
-}
+    tag?: never;
+}) | (IGenericTypographyProps<HTMLHeadingElement> & {
+    tag?: React.ElementType;
+    hierarchy?: never;
+});
 export interface ITaggedTypographyProps extends IGenericTypographyProps {
     /** Specifies the HTML tag for rendering typography. The default is 'p'. */
     tag?: React.ElementType;

package/package.json

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

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

@@ -1,17 +0,0 @@
-import React from 'react';
-import { ISkipToMainProps } from '../../../types/types';
-declare const SkipToMain: ({ className, skipToTag }: ISkipToMainProps) => React.JSX.Element;
-export default SkipToMain;
-/** TODO:
- * - make robust with SSR - might be solved with moving logic to FE.
- * - hiding thing when element not found - might be solved with copying Tab element. ✅
- * - fix columns ✅
- * - fix top-bottom margin ✅
- * - remove !important ✅
- * - add types file ✅
- * - mobile solution ✅
- * - implement in Nav
- * - consider: Make other Tab props available?
- * - is Classname needed as a prop after all?
- * - J's comment about id vs element
- */

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

@@ -1,7 +0,0 @@
-interface FocusableTabProps {
-    $hide?: boolean;
-}
-export declare const SkiptoMainContainer: import("styled-components").StyledComponent<"div", any, {}, never>;
-export declare const FocusableTab: import("styled-components").StyledComponent<({ title, titleLink, onClick, onFocus, onReset, selected, iconName, iconDirection, withIcon, withTextInMobile, trimText, className, role, ariaLabel, tabLinkId, color, }: import("../../../types/types").ITabProps) => import("react").JSX.Element, any, FocusableTabProps, never>;
-export declare const HiddenBlock: import("styled-components").StyledComponent<"div", any, {}, never>;
-export {};

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

@@ -1,2 +0,0 @@
-import SkipToMain from './SkipToMain';
-export default SkipToMain;