@royaloperahouse/chord 2.3.3 → 2.4.0-a-chord-development
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 +214 -7
- package/README.md +250 -40
- package/dist/chord.cjs.development.js +732 -491
- package/dist/chord.cjs.development.js.map +1 -1
- package/dist/chord.cjs.production.min.js +1 -1
- package/dist/chord.cjs.production.min.js.map +1 -1
- package/dist/chord.esm.js +732 -493
- package/dist/chord.esm.js.map +1 -1
- package/dist/components/atoms/Grid/GridItemLegacy.d.ts +8 -0
- package/dist/components/atoms/Grid/index.d.ts +2 -1
- package/dist/components/atoms/Icons/Icons.d.ts +1 -1
- package/dist/components/atoms/Icons/SvgIcons/Descriptors/Wheelchair.svg.d.ts +1 -1
- package/dist/components/atoms/Icons/SvgIcons/index.d.ts +1 -1
- package/dist/components/atoms/Typography/Typography.d.ts +1 -1
- package/dist/components/atoms/index.d.ts +2 -2
- package/dist/components/index.d.ts +3 -3
- package/dist/components/molecules/PageHeading/index.d.ts +1 -1
- package/dist/components/molecules/PeopleListing/CreditListing/CreditListing.style.d.ts +1 -0
- package/dist/components/molecules/PromoWithTitle/PromoChild.d.ts +2 -2
- package/dist/components/molecules/SectionTitle/SectionTitle.d.ts +1 -1
- package/dist/components/molecules/Select/Select.style.d.ts +1 -1
- package/dist/components/molecules/Table/Table.style.d.ts +1 -0
- package/dist/components/molecules/VideoWithControls/index.d.ts +2 -0
- package/dist/components/molecules/index.d.ts +3 -2
- package/dist/helpers/generateDomElementId.d.ts +8 -0
- package/dist/index.d.ts +3 -2
- package/dist/types/editorial.d.ts +18 -2
- package/dist/types/formTypes.d.ts +12 -9
- package/dist/types/iconTypes.d.ts +5 -0
- package/dist/types/impactHeader.d.ts +13 -0
- package/dist/types/tableTypes.d.ts +4 -0
- package/dist/types/types.d.ts +10 -1
- package/package.json +1 -1
- package/README.GIT +0 -277
|
@@ -0,0 +1,8 @@
|
|
|
1
|
+
import { IGridItemProps } from '../../../types/types';
|
|
2
|
+
/**
|
|
3
|
+
* # IMPORTANT
|
|
4
|
+
* Please use the `<GridItem />` component instead of this component if possible.
|
|
5
|
+
* This component was introduced due to incompatibilities between versions of the Chord library.
|
|
6
|
+
*/
|
|
7
|
+
declare const GridItemLegacy: import("styled-components").StyledComponent<"div", any, IGridItemProps, never>;
|
|
8
|
+
export default GridItemLegacy;
|
|
@@ -1,4 +1,4 @@
|
|
|
1
1
|
import * as React from 'react';
|
|
2
2
|
import { IIconProps } from '../../../types/iconTypes';
|
|
3
|
-
declare const Icon: React.MemoExoticComponent<({ className, color, iconName, title, direction }: IIconProps) => React.ReactElement>;
|
|
3
|
+
declare const Icon: React.MemoExoticComponent<({ className, color, iconName, title, direction, ariaLabel }: IIconProps) => React.ReactElement>;
|
|
4
4
|
export default Icon;
|
|
@@ -1,4 +1,4 @@
|
|
|
1
1
|
import * as React from 'react';
|
|
2
2
|
import { IconSVGProps } from '../../../../../types/iconTypes';
|
|
3
|
-
declare const _default: ({ color }: IconSVGProps) => React.ReactElement;
|
|
3
|
+
declare const _default: ({ color, ariaLabel }: IconSVGProps) => React.ReactElement;
|
|
4
4
|
export default _default;
|
|
@@ -73,7 +73,7 @@ export declare const IconLibrary: {
|
|
|
73
73
|
UserSignedIn: ({ color }: import("../../../../types/iconTypes").IconSVGProps) => import("react").ReactElement<any, string | ((props: any) => import("react").ReactElement<any, any> | null) | (new (props: any) => import("react").Component<any, any, any>)>;
|
|
74
74
|
Volume: ({ color }: import("../../../../types/iconTypes").IconSVGProps) => import("react").ReactElement<any, string | ((props: any) => import("react").ReactElement<any, any> | null) | (new (props: any) => import("react").Component<any, any, any>)>;
|
|
75
75
|
Watch: ({ color }: import("../../../../types/iconTypes").IconSVGProps) => import("react").ReactElement<any, string | ((props: any) => import("react").ReactElement<any, any> | null) | (new (props: any) => import("react").Component<any, any, any>)>;
|
|
76
|
-
Wheelchair: ({ color }: import("../../../../types/iconTypes").IconSVGProps) => import("react").ReactElement<any, string | ((props: any) => import("react").ReactElement<any, any> | null) | (new (props: any) => import("react").Component<any, any, any>)>;
|
|
76
|
+
Wheelchair: ({ color, ariaLabel }: import("../../../../types/iconTypes").IconSVGProps) => import("react").ReactElement<any, string | ((props: any) => import("react").ReactElement<any, any> | null) | (new (props: any) => import("react").Component<any, any, any>)>;
|
|
77
77
|
X: ({ color }: import("../../../../types/iconTypes").IconSVGProps) => import("react").ReactElement<any, string | ((props: any) => import("react").ReactElement<any, any> | null) | (new (props: any) => import("react").Component<any, any, any>)>;
|
|
78
78
|
Youtube: ({ color }: import("../../../../types/iconTypes").IconSVGProps) => import("react").ReactElement<any, string | ((props: any) => import("react").ReactElement<any, any> | null) | (new (props: any) => import("react").Component<any, any, any>)>;
|
|
79
79
|
};
|
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
import { IAltHeaderProps, IBodyTextProps, IHeaderProps, IOverlineProps, IStyledTag, ISubtitleProps } from '../../../types/typography';
|
|
2
2
|
export declare const StyledTag: ({ tag, typography, children, level }: IStyledTag) => JSX.Element;
|
|
3
|
-
export declare const AltHeader: ({ level, children }: IAltHeaderProps) => JSX.Element;
|
|
3
|
+
export declare const AltHeader: ({ semanticLevel, level, children }: IAltHeaderProps) => JSX.Element;
|
|
4
4
|
export declare const BodyText: ({ level, children, tag }: IBodyTextProps) => JSX.Element;
|
|
5
5
|
export declare const Header: ({ semanticLevel, level, children }: IHeaderProps) => JSX.Element;
|
|
6
6
|
export declare const Overline: ({ level, children, tag }: IOverlineProps) => JSX.Element;
|
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
import { CinemaBadge, StreamBadge } from './Badge';
|
|
2
2
|
import { PrimaryButton, SecondaryButton, TertiaryButton } from './Buttons';
|
|
3
3
|
import ControlledDropdown from './ControlledDropdown';
|
|
4
|
-
import { Grid, GridItem } from './Grid';
|
|
4
|
+
import { Grid, GridItem, GridItemLegacy } from './Grid';
|
|
5
5
|
import { Icon } from './Icons';
|
|
6
6
|
import ImageAspectRatioWrapper from './ImageAspectRatioWrapper';
|
|
7
7
|
import Progress from './Progress';
|
|
@@ -25,4 +25,4 @@ import TypeTags from './TypeTags';
|
|
|
25
25
|
import { AltHeader, BodyText, Header, Overline, Subtitle } from './Typography';
|
|
26
26
|
import VideoControls from './VideoControls';
|
|
27
27
|
import { Stepper } from './Stepper';
|
|
28
|
-
export { AltHeader, BodyText, CinemaBadge, ControlledDropdown, Grid, GridItem, Header, Icon, ImageAspectRatioWrapper, Overline, Progress, PrimaryButton, Radio, Radio2, RotatorButtons, SecondaryButton, SecondaryLogo, SectionSplitter, SponsorLogo, Sponsorship, Stepper, StreamBadge, Subtitle, Tab, TabLink, TertiaryButton, TextArea, TextField, TextFieldLegacy, TextLink, TextLogo, Tickbox, Tickbox2, Timer, TypeTags, VideoControls, };
|
|
28
|
+
export { AltHeader, BodyText, CinemaBadge, ControlledDropdown, Grid, GridItem, GridItemLegacy, Header, Icon, ImageAspectRatioWrapper, Overline, Progress, PrimaryButton, Radio, Radio2, RotatorButtons, SecondaryButton, SecondaryLogo, SectionSplitter, SponsorLogo, Sponsorship, Stepper, StreamBadge, Subtitle, Tab, TabLink, TertiaryButton, TextArea, TextField, TextFieldLegacy, TextLink, TextLogo, Tickbox, Tickbox2, Timer, TypeTags, VideoControls, };
|
|
@@ -1,6 +1,6 @@
|
|
|
1
|
-
import { AltHeader, BodyText, CinemaBadge, ControlledDropdown, Grid, GridItem, Header, Icon, ImageAspectRatioWrapper, Overline, PrimaryButton, Progress, Radio, Radio2, RotatorButtons, SecondaryButton, SecondaryLogo, TertiaryButton, SectionSplitter, Sponsorship, Stepper, StreamBadge, Subtitle, Tab, TabLink, TextLogo, TextArea, TextField, TextFieldLegacy, TextLink, Tickbox, Tickbox2, Timer, TypeTags, VideoControls } from './atoms';
|
|
1
|
+
import { AltHeader, BodyText, CinemaBadge, ControlledDropdown, Grid, GridItem, GridItemLegacy, Header, Icon, ImageAspectRatioWrapper, Overline, PrimaryButton, Progress, Radio, Radio2, RotatorButtons, SecondaryButton, SecondaryLogo, TertiaryButton, SectionSplitter, Sponsorship, Stepper, StreamBadge, Subtitle, Tab, TabLink, TextLogo, TextArea, TextField, TextFieldLegacy, TextLink, Tickbox, Tickbox2, Timer, TypeTags, VideoControls } from './atoms';
|
|
2
2
|
import { AnchorTabBar, Footer, LiveChat, Navigation, StickyBar, TitleWithCTA, UpsellSection } from './organisms';
|
|
3
|
-
import { Accordion, Accordions, AnnouncementBanner, AuxiliaryNav, Card, Cards, ContactCard, ContentSummary, CreditListing, Editorial, ImageWithCaption, Information, PageHeadingCinema, PageHeadingCompact, PageHeadingCore, PageHeadingImpact, PageHeadingPanel, PageHeadingStream, PasswordStrength, Pagination, PeopleListing, PromoWithTags, PromoWithTitle, RadioGroup, RadioGroup2, ReadMore, StatusBanner, SearchBar, SectionTitle, Select, Select2, Select2Async, Table, Tabs, TextOnly, UpsellCard, Quote } from './molecules';
|
|
3
|
+
import { Accordion, Accordions, AnnouncementBanner, AuxiliaryNav, Card, Cards, ContactCard, ContentSummary, CreditListing, Editorial, ImageWithCaption, Information, PageHeadingCinema, PageHeadingCompact, PageHeadingCore, PageHeadingImpact, PageHeadingPanel, PageHeadingStream, PasswordStrength, Pagination, PeopleListing, PromoWithTags, PromoWithTitle, RadioGroup, RadioGroup2, ReadMore, StatusBanner, SearchBar, SectionTitle, Select, Select2, Select2Async, Table, Tabs, TextOnly, UpsellCard, Quote, VideoWithControls } from './molecules';
|
|
4
4
|
import ThemeProvider from '../styles/ThemeProvider';
|
|
5
5
|
import GlobalStyles from '../styles/GlobalStyles';
|
|
6
|
-
export { Accordion, Accordions, AnnouncementBanner, AltHeader, AnchorTabBar, AuxiliaryNav, BodyText, Card, Cards, ContactCard, ContentSummary, CinemaBadge, 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, SecondaryButton, SecondaryLogo, StatusBanner, SearchBar, SectionTitle, Select, Select2, Select2Async, Sponsorship, Stepper, StickyBar, StreamBadge, Subtitle, TertiaryButton, TextOnly, ThemeProvider, TitleWithCTA, SectionSplitter, Tab, TabLink, Table, Tabs, TextArea, TextField, TextFieldLegacy, TextLink, TextLogo, Tickbox, Tickbox2, Timer, TypeTags, UpsellCard, UpsellSection, Quote, LiveChat, VideoControls, };
|
|
6
|
+
export { Accordion, Accordions, AnnouncementBanner, AltHeader, AnchorTabBar, AuxiliaryNav, BodyText, Card, Cards, ContactCard, ContentSummary, CinemaBadge, ControlledDropdown, CreditListing, Editorial, Footer, GlobalStyles, Grid, GridItem, GridItemLegacy, 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, SecondaryButton, SecondaryLogo, StatusBanner, SearchBar, SectionTitle, Select, Select2, Select2Async, Sponsorship, Stepper, StickyBar, StreamBadge, Subtitle, TertiaryButton, TextOnly, ThemeProvider, TitleWithCTA, SectionSplitter, Tab, TabLink, Table, Tabs, TextArea, TextField, TextFieldLegacy, TextLink, TextLogo, Tickbox, Tickbox2, Timer, TypeTags, UpsellCard, UpsellSection, Quote, LiveChat, VideoControls, VideoWithControls, };
|
|
@@ -4,4 +4,4 @@ import PageHeadingImpact from './Impact';
|
|
|
4
4
|
import PageHeadingPanel from './Panel';
|
|
5
5
|
import PageHeadingStream from './Stream';
|
|
6
6
|
import PageHeadingCompact from './Compact/Compact';
|
|
7
|
-
export { PageHeadingCinema, PageHeadingCore, PageHeadingImpact, PageHeadingStream, PageHeadingCompact,
|
|
7
|
+
export { PageHeadingCinema, PageHeadingCore, PageHeadingImpact, PageHeadingPanel, PageHeadingStream, PageHeadingCompact, };
|
|
@@ -3,3 +3,4 @@ export declare const CreditListingWrapper: import("styled-components").StyledCom
|
|
|
3
3
|
export declare const DescriptionWrapper: import("styled-components").StyledComponent<"div", any, {}, never>;
|
|
4
4
|
export declare const RoleWrapper: import("styled-components").StyledComponent<"div", any, {}, never>;
|
|
5
5
|
export declare const CreditWrapper: import("styled-components").StyledComponent<"div", any, {}, never>;
|
|
6
|
+
export declare const CreditBodyWrapper: import("styled-components").StyledComponent<"div", any, {}, never>;
|
|
@@ -1,8 +1,8 @@
|
|
|
1
1
|
import { FunctionComponent, ReactElement } from 'react';
|
|
2
|
-
import {
|
|
2
|
+
import { IVideoWithControlsSettings } from '../../../types/types';
|
|
3
3
|
interface IPromoChildProps {
|
|
4
4
|
children: ReactElement<HTMLImageElement | HTMLVideoElement>;
|
|
5
|
-
videoSettings:
|
|
5
|
+
videoSettings: IVideoWithControlsSettings;
|
|
6
6
|
imageToLeft: boolean;
|
|
7
7
|
}
|
|
8
8
|
declare const PromoChild: FunctionComponent<IPromoChildProps>;
|
|
@@ -1,3 +1,3 @@
|
|
|
1
1
|
import { ISectionTitleProps } from '../../../types/types';
|
|
2
|
-
declare const SectionTitle: ({ title, size, description }: ISectionTitleProps) => JSX.Element;
|
|
2
|
+
declare const SectionTitle: ({ title, size, description, semanticLevel }: ISectionTitleProps) => JSX.Element;
|
|
3
3
|
export default SectionTitle;
|
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
/// <reference types="react" />
|
|
2
2
|
import { ISelectProps } from '../../../types/formTypes';
|
|
3
|
-
export declare const ArrowIcon: import("styled-components").StyledComponent<import("react").MemoExoticComponent<({ className, color, iconName, title, direction }: import("../../../types/iconTypes").IIconProps) => import("react").ReactElement<any, string | ((props: any) => import("react").ReactElement<any, any> | null) | (new (props: any) => import("react").Component<any, any, any>)>>, any, {
|
|
3
|
+
export declare const ArrowIcon: import("styled-components").StyledComponent<import("react").MemoExoticComponent<({ className, color, iconName, title, direction, ariaLabel }: import("../../../types/iconTypes").IIconProps) => import("react").ReactElement<any, string | ((props: any) => import("react").ReactElement<any, any> | null) | (new (props: any) => import("react").Component<any, any, any>)>>, any, {
|
|
4
4
|
iconName: "DropdownArrow";
|
|
5
5
|
color: string;
|
|
6
6
|
title: "Select Arrow";
|
|
@@ -17,3 +17,4 @@ export declare const PageNumber: import("styled-components").StyledComponent<"bu
|
|
|
17
17
|
}, never>;
|
|
18
18
|
export declare const Next: import("styled-components").StyledComponent<"span", any, {}, never>;
|
|
19
19
|
export declare const ScrollButtons: import("styled-components").StyledComponent<"div", any, {}, never>;
|
|
20
|
+
export declare const AriaDescription: import("styled-components").StyledComponent<"span", any, {}, never>;
|
|
@@ -27,7 +27,8 @@ import ImageWithCaption from './ImageWithCaption';
|
|
|
27
27
|
import Quote from './Quote';
|
|
28
28
|
import MiniCard from './MiniCard';
|
|
29
29
|
import ReadMore from './ReadMore';
|
|
30
|
-
import AuxiliaryNav from './AuxiliaryNav';
|
|
31
30
|
import PasswordStrength from './PasswordStrength';
|
|
31
|
+
import AuxiliaryNav from './AuxiliaryNav';
|
|
32
32
|
import Table from './Table';
|
|
33
|
-
|
|
33
|
+
import VideoWithControls from './VideoWithControls';
|
|
34
|
+
export { Accordion, Accordions, AnnouncementBanner, AuxiliaryNav, Card, Cards, ContactCard, ContentSummary, CreditListing, Editorial, ImageWithCaption, Information, MiniCard, PageHeadingCinema, PageHeadingCompact, PageHeadingCore, PageHeadingImpact, PageHeadingPanel, PageHeadingStream, PasswordStrength, Pagination, PeopleListing, PromoWithTags, PromoWithTitle, RadioGroup, RadioGroup2, ReadMore, Quote, StatusBanner, SectionTitle, SearchBar, Select, Select2, Select2Async, Tabs, Table, TextOnly, UpsellCard, VideoWithControls, };
|
|
@@ -0,0 +1,8 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Generates a random string in the format XXX-XXX.
|
|
3
|
+
* Does not meet UUID standards.
|
|
4
|
+
* To be used where only a small number of unique IDs are required, e.g. DOM element IDs.
|
|
5
|
+
*
|
|
6
|
+
* @return {string} A random string in the format XXX-XXX.
|
|
7
|
+
*/
|
|
8
|
+
export declare const generateDomElementId: () => string;
|
package/dist/index.d.ts
CHANGED
|
@@ -1,8 +1,9 @@
|
|
|
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, LiveChat, 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,
|
|
1
|
+
import { Accordion, Accordions, AnnouncementBanner, AltHeader, AnchorTabBar, AuxiliaryNav, BodyText, Card, Cards, CinemaBadge, ContactCard, ContentSummary, ControlledDropdown, CreditListing, Editorial, Footer, GlobalStyles, Grid, GridItem, GridItemLegacy, Header, Icon, ImageAspectRatioWrapper, ImageWithCaption, Information, LiveChat, 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, Stepper, StickyBar, 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';
|
|
2
2
|
import { devices, breakpoints } from './styles/viewports';
|
|
3
3
|
import zIndexes from './styles/zIndexes';
|
|
4
4
|
import { AspectRatio, ButtonType, CarouselType, Colors, IconNameType, IntegratedTimerProps, ITimerProps, TickboxMode, ThemeType, EditorialLink } from './types';
|
|
5
5
|
import { MiniCard } from './components/molecules';
|
|
6
|
+
import { BrandingStyle } from './types/impactHeader';
|
|
6
7
|
import { ModalWindow } from './components/organisms';
|
|
7
8
|
import AuxiliaryButton from './components/atoms/Buttons/Auxiliary/AuxiliaryButton';
|
|
8
|
-
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, Header, Icon, IconNameType, ImageAspectRatioWrapper, ImageWithCaption, Information, ITimerProps, IntegratedTimerProps, LiveChat, 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,
|
|
9
|
+
export { Accordion, Accordions, AnnouncementBanner, AltHeader, AnchorTabBar, AuxiliaryButton, AuxiliaryNav, AspectRatio, BodyText, BrandingStyle, breakpoints, ButtonType, Card, Cards, CarouselType, CinemaBadge, Colors, ContactCard, ContentSummary, ControlledDropdown, CreditListing, devices, Editorial, EditorialLink, Footer, GlobalStyles, Grid, GridItem, GridItemLegacy, Header, Icon, IconNameType, ImageAspectRatioWrapper, ImageWithCaption, Information, ITimerProps, IntegratedTimerProps, LiveChat, 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, Stepper, StickyBar, 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, };
|
|
@@ -2,7 +2,7 @@ import { AnchorHTMLAttributes, ImgHTMLAttributes, MouseEventHandler, ReactElemen
|
|
|
2
2
|
import { StyledProps } from 'styled-components';
|
|
3
3
|
import { ButtonType } from './buttonTypes';
|
|
4
4
|
import { DirectionType, IconNameType } from './iconTypes';
|
|
5
|
-
import { Colors,
|
|
5
|
+
import { Colors, IVideoWithControlsSettings } from './types';
|
|
6
6
|
import { TypographyLevel } from './typography';
|
|
7
7
|
export interface IEditorialProps {
|
|
8
8
|
/**
|
|
@@ -107,11 +107,15 @@ export interface IPromoWithTitleProps {
|
|
|
107
107
|
/**
|
|
108
108
|
* Settings for the VideoWithControls component.
|
|
109
109
|
*/
|
|
110
|
-
videoSettings?:
|
|
110
|
+
videoSettings?: IVideoWithControlsSettings;
|
|
111
111
|
/**
|
|
112
112
|
* Array of buttons props. First one should have PrimaryButton attributes, second one Tertiary button attributes
|
|
113
113
|
*/
|
|
114
114
|
links?: PromoLinks;
|
|
115
|
+
/**
|
|
116
|
+
* Semantic level of the title. Default is 2.
|
|
117
|
+
*/
|
|
118
|
+
titleSemanticLevel?: TypographyLevel;
|
|
115
119
|
}
|
|
116
120
|
export interface IThemePageHeadingProps {
|
|
117
121
|
/**
|
|
@@ -130,6 +134,18 @@ export interface IThemePageHeadingProps {
|
|
|
130
134
|
* Boolean to show/hide sponsorship logo (default true)
|
|
131
135
|
*/
|
|
132
136
|
sponsor?: boolean;
|
|
137
|
+
/**
|
|
138
|
+
* Semantic level of the title. Default is 1.
|
|
139
|
+
*/
|
|
140
|
+
semanticLevel?: TypographyLevel;
|
|
141
|
+
/**
|
|
142
|
+
* Character limit for the text
|
|
143
|
+
*/
|
|
144
|
+
copyCharLimit?: number;
|
|
145
|
+
/**
|
|
146
|
+
* Character limit for the title
|
|
147
|
+
*/
|
|
148
|
+
titleCharLimit?: number;
|
|
133
149
|
}
|
|
134
150
|
export interface IPageHeadingProps extends IThemePageHeadingProps {
|
|
135
151
|
/**
|
|
@@ -265,17 +265,8 @@ export interface IStepperProps {
|
|
|
265
265
|
step?: number;
|
|
266
266
|
/** An error message to be shown below the stepper.
|
|
267
267
|
*
|
|
268
|
-
* Default: `undefined`
|
|
269
268
|
*/
|
|
270
269
|
error?: string;
|
|
271
|
-
/**
|
|
272
|
-
* A style prop that allows us to change what colours to
|
|
273
|
-
* use for light or dark mode (e.g. text color, border color, etc...)
|
|
274
|
-
* based on the background color.
|
|
275
|
-
*
|
|
276
|
-
* Defaults to `false`.
|
|
277
|
-
*/
|
|
278
|
-
darkMode?: boolean;
|
|
279
270
|
/**
|
|
280
271
|
* Set disapled state
|
|
281
272
|
*/
|
|
@@ -284,6 +275,18 @@ export interface IStepperProps {
|
|
|
284
275
|
* Minimum value allowed in the stepper
|
|
285
276
|
*/
|
|
286
277
|
min?: number;
|
|
278
|
+
/**
|
|
279
|
+
* A style prop that allows us to change what colours to
|
|
280
|
+
* use for light or dark mode (e.g. text color, border color, etc...)
|
|
281
|
+
* based on the background color.
|
|
282
|
+
*
|
|
283
|
+
* Defaults to `false`.
|
|
284
|
+
* Specify whether or not the containing element has a dark background.
|
|
285
|
+
* This property affects the border colours for focused and error states.
|
|
286
|
+
*
|
|
287
|
+
* Default: `false`
|
|
288
|
+
*/
|
|
289
|
+
darkMode?: boolean;
|
|
287
290
|
/**
|
|
288
291
|
* Maximum value allowed in the stepper
|
|
289
292
|
*/
|
|
@@ -8,6 +8,7 @@ export interface IIconStyledProps {
|
|
|
8
8
|
}
|
|
9
9
|
export interface IconSVGProps {
|
|
10
10
|
color?: string;
|
|
11
|
+
ariaLabel?: string;
|
|
11
12
|
}
|
|
12
13
|
export interface IIconProps {
|
|
13
14
|
/**
|
|
@@ -30,4 +31,8 @@ export interface IIconProps {
|
|
|
30
31
|
* Icon to display.
|
|
31
32
|
*/
|
|
32
33
|
iconName: IconNameType;
|
|
34
|
+
/**
|
|
35
|
+
* Descriptive alt text for Assistive Tech.
|
|
36
|
+
*/
|
|
37
|
+
ariaLabel?: string;
|
|
33
38
|
}
|
|
@@ -1,5 +1,6 @@
|
|
|
1
1
|
import { ReactNode } from 'react';
|
|
2
2
|
import { EditorialLink } from '../types';
|
|
3
|
+
import { TypographyLevel } from './typography';
|
|
3
4
|
export interface IPageHeadingImpactProps {
|
|
4
5
|
/**
|
|
5
6
|
* Text placed in the impact component
|
|
@@ -37,6 +38,10 @@ export interface IPageHeadingImpactProps {
|
|
|
37
38
|
* Internal anchor ref
|
|
38
39
|
*/
|
|
39
40
|
scrollHref?: string;
|
|
41
|
+
/**
|
|
42
|
+
* Semantic level of the header
|
|
43
|
+
*/
|
|
44
|
+
semanticLevel?: TypographyLevel;
|
|
40
45
|
}
|
|
41
46
|
export declare type BrandingStyle = 'BlockText' | 'BodyText' | 'StreamLogo' | 'CinemaLogo' | 'TextLink';
|
|
42
47
|
export interface IPageHeadingCompactProps {
|
|
@@ -101,6 +106,14 @@ export interface IPageHeadingCompactProps {
|
|
|
101
106
|
* @type {string}
|
|
102
107
|
* */
|
|
103
108
|
videoUrlMobile?: string;
|
|
109
|
+
/**
|
|
110
|
+
* If true, shows the copy section (title, CTAs etc.). If false, only the video banner is visible. True by default.
|
|
111
|
+
*/
|
|
112
|
+
showCopy?: boolean;
|
|
113
|
+
/**
|
|
114
|
+
* Semantic level of the header
|
|
115
|
+
*/
|
|
116
|
+
semanticLevel?: TypographyLevel;
|
|
104
117
|
}
|
|
105
118
|
export interface CustomSponsorImageData {
|
|
106
119
|
/**
|
package/dist/types/types.d.ts
CHANGED
|
@@ -426,12 +426,20 @@ export interface ISectionTitleProps {
|
|
|
426
426
|
* Optional description that can be rendered below the title.
|
|
427
427
|
*/
|
|
428
428
|
description?: string;
|
|
429
|
+
/**
|
|
430
|
+
* Semantic level of the title.
|
|
431
|
+
*/
|
|
432
|
+
semanticLevel?: TypographyLevel;
|
|
429
433
|
}
|
|
430
434
|
export interface ILogosProps {
|
|
431
435
|
/**
|
|
432
436
|
* Color used to fill logos.
|
|
433
437
|
*/
|
|
434
438
|
fillColor?: Colors.White | Colors.Black;
|
|
439
|
+
/**
|
|
440
|
+
* Text aligned logo variants.
|
|
441
|
+
*/
|
|
442
|
+
align?: 'left' | 'center';
|
|
435
443
|
}
|
|
436
444
|
export interface ILogosStyledProps extends StyledProps<any> {
|
|
437
445
|
/**
|
|
@@ -572,6 +580,7 @@ export interface IVideoControlsProps {
|
|
|
572
580
|
*/
|
|
573
581
|
loop?: boolean;
|
|
574
582
|
}
|
|
583
|
+
export declare type IVideoWithControlsSettings = Omit<IVideoControlsProps, 'videoElementId' | 'videoContainerId'>;
|
|
575
584
|
export interface IVideoWithControlsProps {
|
|
576
585
|
/**
|
|
577
586
|
* Video element
|
|
@@ -580,6 +589,6 @@ export interface IVideoWithControlsProps {
|
|
|
580
589
|
/**
|
|
581
590
|
* Settings for video controls
|
|
582
591
|
*/
|
|
583
|
-
settings:
|
|
592
|
+
settings: IVideoWithControlsSettings;
|
|
584
593
|
}
|
|
585
594
|
export declare type Image = Pick<HTMLImageElement, 'alt' | 'src'>;
|
package/package.json
CHANGED
package/README.GIT
DELETED
|
@@ -1,277 +0,0 @@
|
|
|
1
|
-
# Royal Opera House Chord - Front End Design System
|
|
2
|
-
|
|
3
|
-
Welcome to The Royal Opera House Front End Design System, `@royaloperahouse/chord`
|
|
4
|
-
|
|
5
|
-
This package is a library of UI components intended to be used in the ROH website.
|
|
6
|
-
|
|
7
|
-
It uses React, TypeScript, TSDX and Storybook.
|
|
8
|
-
|
|
9
|
-
The NPM packages are published at [https://www.npmjs.com/package/@royaloperahouse/chord](https://www.npmjs.com/package/@royaloperahouse/chord)
|
|
10
|
-
|
|
11
|
-
The Storybook for the latest version of the library is hosted at [chord.roh.org.uk](chord.roh.org.uk)
|
|
12
|
-
|
|
13
|
-
|
|
14
|
-
## Prerequisites
|
|
15
|
-
---
|
|
16
|
-
|
|
17
|
-
* Make sure the required package dependencies are installed using `yarn install`
|
|
18
|
-
|
|
19
|
-
* If this is the first time you are working on Chord, make sure to run `yarn build` to build all the modules.
|
|
20
|
-
|
|
21
|
-
* **To deploy the storybook publicly** you will need credentials for the **parent** 'Royal Opera House' AWS account in your `~/.aws/credentials` file.
|
|
22
|
-
* The deploy script expects these to be called `[parent]`.
|
|
23
|
-
|
|
24
|
-
* You can find these values at:
|
|
25
|
-
|
|
26
|
-
*AWS 'Your Applications' page -> 'Royal Opera House' -> 'Developer Access' -> 'Command line or programmatic access'*
|
|
27
|
-
|
|
28
|
-
* **To deploy a preview** for demo / QA you will need the `CHROMATIC_PROJECT_TOKEN` -- find this in 1Password
|
|
29
|
-
|
|
30
|
-
|
|
31
|
-
* **To publish the NPM package** you will need the ROH `NPM_TOKEN` -- find this in 1Password
|
|
32
|
-
|
|
33
|
-
|
|
34
|
-
## Versioning
|
|
35
|
-
---
|
|
36
|
-
|
|
37
|
-
We use [Semantic Versioning](https://semver.org/) for Chord.
|
|
38
|
-
|
|
39
|
-
Given a version number MAJOR.MINOR.PATCH, increment the:
|
|
40
|
-
|
|
41
|
-
* MAJOR version when you make incompatible library changes
|
|
42
|
-
* MINOR version when you add functionality in a backwards compatible manner
|
|
43
|
-
* PATCH version when you make backwards compatible bug fixes
|
|
44
|
-
|
|
45
|
-
When you create a new release always update the `CHANGELOG` and `package.json`
|
|
46
|
-
|
|
47
|
-
Increment your version from the latest stable version on `chord-releases`
|
|
48
|
-
|
|
49
|
-
|
|
50
|
-
## Deploying the Storybook
|
|
51
|
-
---
|
|
52
|
-
|
|
53
|
-
### **1. To build and deploy locally**
|
|
54
|
-
|
|
55
|
-
You can quickly build and serve the contents of `/storybook-static` from your local machine, for development and manual testing. To do this run:
|
|
56
|
-
|
|
57
|
-
```bash
|
|
58
|
-
yarn storybook
|
|
59
|
-
```
|
|
60
|
-
|
|
61
|
-
By default the storybook will be accessible at
|
|
62
|
-
[http://localhost:6006/]()
|
|
63
|
-
|
|
64
|
-
The server will hot-reload on most changes.
|
|
65
|
-
|
|
66
|
-
### **2. To deploy a preview version remotely**
|
|
67
|
-
|
|
68
|
-
You can deploy a release candidate, or work-in-progress to [Chromatic](https://www.chromatic.com/) for showcase or QA.
|
|
69
|
-
|
|
70
|
-
**NOTE:** you will need the `CHROMATIC_PROJECT_TOKEN` as described in *Prerequisites* above.
|
|
71
|
-
|
|
72
|
-
Either set the token as a shell variable or use a `.env` file in the chord root directory containing the token, as so:
|
|
73
|
-
|
|
74
|
-
```
|
|
75
|
-
CHROMATIC_PROJECT_TOKEN=tokengoeshere
|
|
76
|
-
```
|
|
77
|
-
|
|
78
|
-
Run:
|
|
79
|
-
|
|
80
|
-
```
|
|
81
|
-
yarn deploy-storybook-dev
|
|
82
|
-
```
|
|
83
|
-
|
|
84
|
-
to build and deploy the storybook from your repo to Chromatic.
|
|
85
|
-
|
|
86
|
-
You will find the address of your deployed storybook in the console output, looking something like this:
|
|
87
|
-
|
|
88
|
-
`→ View your Storybook at https://randomHexString-randomAlphabeticalString.chromatic.com`
|
|
89
|
-
|
|
90
|
-
### **3. To deploy a release version**
|
|
91
|
-
|
|
92
|
-
You can deploy the contents of `./storybook-static` to S3 as a static site, which is permanently accessible at [chord.roh.org.uk](chord.roh.org.uk)
|
|
93
|
-
|
|
94
|
-
**NOTE:** To do this you will need the correct `AWS` credentials set up, as described in *Prerequisites* above.
|
|
95
|
-
|
|
96
|
-
First build the storybook using:
|
|
97
|
-
|
|
98
|
-
```
|
|
99
|
-
yarn build-storybook
|
|
100
|
-
```
|
|
101
|
-
|
|
102
|
-
then run:
|
|
103
|
-
|
|
104
|
-
```bash
|
|
105
|
-
yarn deploy-storybook
|
|
106
|
-
```
|
|
107
|
-
|
|
108
|
-
> **IMPORTANT:** This URL is intended to showcase the latest stable version of Chord, it should be kept up to date with the main `chord-releases` branch and should **only** be used for release versions. If you want to deploy a development version follow the steps above under *To deploy a preview version remotely*.
|
|
109
|
-
|
|
110
|
-
|
|
111
|
-
## Releasing a New Package Version
|
|
112
|
-
---
|
|
113
|
-
|
|
114
|
-
This is the procedure for releasing a new Chord NPM package.
|
|
115
|
-
|
|
116
|
-
There are two types of package:
|
|
117
|
-
|
|
118
|
-
A **snapshot** can be published to use a development version of the Chord library in our frontend staging environments, to perform integrated, manual testing.
|
|
119
|
-
|
|
120
|
-
A **stable** package is published for use in production.
|
|
121
|
-
|
|
122
|
-
**NOTE:** You will need the `NPM_TOKEN`, as described in 'Prerequisites' above.
|
|
123
|
-
|
|
124
|
-
### **1. To release a snapshot version**
|
|
125
|
-
|
|
126
|
-
> **IMPORTANT:** Make sure you always publish your **snapshots** from `chord-development` after merging in your feature branch.
|
|
127
|
-
|
|
128
|
-
For snapshots, `RELEASE_VERSION` should be the same as the latest **stable** version of the Chord Library, as found in `chord-releases`, followed by an **unused** lowercase letter.
|
|
129
|
-
|
|
130
|
-
For example, if the latest stable release was 1.42.0, and the last snapshot published to NPM was 1.42.0-w, you would use RELEASE_VERSION `1.42.0-x`
|
|
131
|
-
|
|
132
|
-
To publish a snapshot use:
|
|
133
|
-
|
|
134
|
-
```bash
|
|
135
|
-
NPM_ROH_TOKEN={NPM_TOKEN} RELEASE_VERSION={RELEASE_VERSION} yarn publish-snapshot
|
|
136
|
-
```
|
|
137
|
-
|
|
138
|
-
The version published to NPM will be named, e.g. `1.42.0-a-chord-development`, use this to install the snapshot package in the frontend repos.
|
|
139
|
-
|
|
140
|
-
### **2. To release a stable version**
|
|
141
|
-
|
|
142
|
-
> **IMPORTANT:** Make sure you always publish your **stable** packages from `chord-releases` after merging in your feature branch.
|
|
143
|
-
|
|
144
|
-
For stable releases, increment your version from the latest **stable** version found on `chord-releases`, following the rules described in *Versioning* above, and use this as `RELEASE_VERSION`. (Make sure it matches the version in your `package.json` and `CHANGELOG.md`!)
|
|
145
|
-
|
|
146
|
-
To publish a stable package use:
|
|
147
|
-
|
|
148
|
-
```bash
|
|
149
|
-
NPM_ROH_TOKEN={NPM_TOKEN} RELEASE_VERSION={RELEASE_VERSION} yarn publish-release
|
|
150
|
-
```
|
|
151
|
-
|
|
152
|
-
|
|
153
|
-
## Using the Package
|
|
154
|
-
---
|
|
155
|
-
|
|
156
|
-
The package is deployed to NPM, and can be installed using yarn or npm:
|
|
157
|
-
|
|
158
|
-
```bash
|
|
159
|
-
npm i --save @royaloperahouse/chord
|
|
160
|
-
```
|
|
161
|
-
```bash
|
|
162
|
-
yarn add @royaloperahouse/chord
|
|
163
|
-
```
|
|
164
|
-
|
|
165
|
-
|
|
166
|
-
## Testing
|
|
167
|
-
---
|
|
168
|
-
|
|
169
|
-
To **Lint** the package use:
|
|
170
|
-
|
|
171
|
-
```bash
|
|
172
|
-
yarn lint
|
|
173
|
-
# Use the --fix option to perform automatic fixes
|
|
174
|
-
```
|
|
175
|
-
|
|
176
|
-
To run the **unit tests** (using Jest) use:
|
|
177
|
-
|
|
178
|
-
```bash
|
|
179
|
-
yarn test
|
|
180
|
-
|
|
181
|
-
# Use the -u option to update snapshots if needed
|
|
182
|
-
# Run `yarn test:watch` to re-run tests on changes
|
|
183
|
-
```
|
|
184
|
-
|
|
185
|
-
To **run and and store the unit tests** for display in storybook use:
|
|
186
|
-
|
|
187
|
-
```bash
|
|
188
|
-
yarn test-storybook
|
|
189
|
-
# Use the -u option to update snapshots if needed
|
|
190
|
-
```
|
|
191
|
-
|
|
192
|
-
|
|
193
|
-
## Development Process
|
|
194
|
-
---
|
|
195
|
-
|
|
196
|
-
### **1. Branching Model**
|
|
197
|
-
* The Chord project lives in the `roh-components` *monorepo*
|
|
198
|
-
* When working on Chord, treat the `roh-components/packages/chord` directory as your root
|
|
199
|
-
* The Chord **development** branch is currently `chord-development`
|
|
200
|
-
* The Chord **main** branch is currently `chord-releases`
|
|
201
|
-
* All work should be done on a correctly named **feature branch** of the format: `issueType/ticketNumber-short-description-of-feature`, e.g. `feature/RD-1234-update-chord-documentation`
|
|
202
|
-
* Always create your feature branch FROM, and submit pull requests TO, the **main** branch
|
|
203
|
-
* For **QA / UAT** of a Chord component in isolation: following review you should deploy a preview version to Chromatic straight from your **feature branch** _without_ merging to development
|
|
204
|
-
* For releasing an **NPM snapshot**: merge your feature branch into the **development** branch and publish the NPM snapshot from there
|
|
205
|
-
|
|
206
|
-
### **2. Detailed Workflow**
|
|
207
|
-
|
|
208
|
-
#### **Before review:**
|
|
209
|
-
|
|
210
|
-
* Git pull the latest version of `chord-releases`
|
|
211
|
-
* Checkout a new, correctly-named feature branch from `chord releases`
|
|
212
|
-
* Do your work on this feature branch
|
|
213
|
-
* Run: `yarn lint`
|
|
214
|
-
* Run: `yarn test`
|
|
215
|
-
* Commit your changes
|
|
216
|
-
* Create a pull request from your feature branch to `chord-releases`
|
|
217
|
-
* Add the appropriate reviewers
|
|
218
|
-
|
|
219
|
-
#### **Before QA / UAT:**
|
|
220
|
-
|
|
221
|
-
After your PR is approved, you have two options:
|
|
222
|
-
|
|
223
|
-
**i.** For QA of a component in isolation:
|
|
224
|
-
|
|
225
|
-
* Follow the steps above in *Deploying the Storybook -> 2. Deploying a preview version remotely*
|
|
226
|
-
* Share the generated Chromatic URL with the appropriate people for QA / UAT
|
|
227
|
-
|
|
228
|
-
**ii.** For integrated testing of a component in the frontend staging environments:
|
|
229
|
-
|
|
230
|
-
* Check out the `chord-development` branch
|
|
231
|
-
* Merge your work in to `chord-development`
|
|
232
|
-
* Follow the steps above under *Publishing a New Package Version -> 1. To release a snapshot version*
|
|
233
|
-
* Git push the updated `chord-development` branch to remote
|
|
234
|
-
* Finally, in the frontend repo:
|
|
235
|
-
|
|
236
|
-
1. Update the `package.json` to reference the new snapshot version
|
|
237
|
-
2. Run: `yarn install`
|
|
238
|
-
3. Deploy the frontend to a staging environment
|
|
239
|
-
|
|
240
|
-
#### **When ready for production:**
|
|
241
|
-
|
|
242
|
-
* Return to your chord **feature branch**
|
|
243
|
-
* Update the chord version in `package.json`, incrementing from the last **stable** release, found in `chord-releases`, and following the rules described in the *Versioning* section
|
|
244
|
-
* Update `CHANGELOG.md`, adding the new version number and a short description of your changes
|
|
245
|
-
* Run: `yarn lint`
|
|
246
|
-
* Run: `yarn test`
|
|
247
|
-
* Run: `yarn test-storybook -u`
|
|
248
|
-
* Run: `yarn build-storybook`
|
|
249
|
-
* Git commit, push, and update your PR for final approval
|
|
250
|
-
* Merge your approved PR to `chord-releases`
|
|
251
|
-
* Follow the steps in *Publishing a New Package Version -> 2. To release a stable version* to publish the NPM package
|
|
252
|
-
* Finally, follow the steps in *Deploying The Storybook -> 3. To deploy a release version*, to update the public Chord Storybook page
|
|
253
|
-
|
|
254
|
-
Once you have successfully published a new release version, you can open a ticket to update to this version in any of the frontend repos.
|
|
255
|
-
|
|
256
|
-
|
|
257
|
-
## Notes
|
|
258
|
-
---
|
|
259
|
-
### The `storybook-static` folder
|
|
260
|
-
|
|
261
|
-
This folder contains all the HTML / JS required to deploy the Storybook as a static site. It's autogenerated whenever the Storybook is built and therefore will show up a lot of merge conflicts when you merge other branches into your feature branch. It is best to leave generating the storybook until the later part of your workflow, but in case you run into conflicts earlier, it's ok to just delete the folder and regenerate using:
|
|
262
|
-
|
|
263
|
-
```bash
|
|
264
|
-
yarn build-storybook
|
|
265
|
-
```
|
|
266
|
-
|
|
267
|
-
For the same reason changes to this folder will cause a lot of big diffs, when looking at a PR, but can mostly be skimmed over unless something looks unusual.
|
|
268
|
-
|
|
269
|
-
---
|
|
270
|
-
### Examples
|
|
271
|
-
|
|
272
|
-
There is an example implementation in the example folder. Alternatively there are also integration examples in storybook. Make sure to keep these updated so as to showcase the current components available.
|
|
273
|
-
|
|
274
|
-
---
|
|
275
|
-
### Bundle analysis
|
|
276
|
-
|
|
277
|
-
Calculate the real cost of your library using [size-limit](https://github.com/ai/size-limit) with `yarn size` and visualize it with `yarn analyze`.
|