@royaloperahouse/harmonic 0.16.0 → 0.17.0-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.
Files changed (34) hide show
  1. package/CHANGELOG.md +0 -10
  2. package/README.md +252 -43
  3. package/dist/components/atoms/Tab/Tab.d.ts +1 -1
  4. package/dist/components/index.d.ts +3 -3
  5. package/dist/components/molecules/PageHeading/HighlightCarousel/HighlightCarousel.d.ts +4 -0
  6. package/dist/components/molecules/PageHeading/HighlightCarousel/HighlightCarousel.style.d.ts +14 -0
  7. package/dist/components/molecules/PageHeading/HighlightCarousel/index.d.ts +2 -0
  8. package/dist/components/molecules/PageHeading/index.d.ts +2 -2
  9. package/dist/components/molecules/PromoWithTags/PromoWithTags.style.d.ts +271 -1
  10. package/dist/components/molecules/PromoWithTitle/PromoWithTitle.style.d.ts +271 -1
  11. package/dist/components/molecules/index.d.ts +2 -3
  12. package/dist/components/organisms/Carousels/Carousel/Carousel.style.d.ts +271 -1
  13. package/dist/components/organisms/Navigation/Navigation.d.ts +1 -1
  14. package/dist/harmonic.cjs.development.js +6753 -6830
  15. package/dist/harmonic.cjs.development.js.map +1 -1
  16. package/dist/harmonic.cjs.production.min.js +1 -1
  17. package/dist/harmonic.cjs.production.min.js.map +1 -1
  18. package/dist/harmonic.esm.js +6764 -6841
  19. package/dist/harmonic.esm.js.map +1 -1
  20. package/dist/index.d.ts +2 -2
  21. package/dist/types/impactHeader.d.ts +2 -20
  22. package/dist/types/navigation.d.ts +0 -4
  23. package/dist/types/types.d.ts +0 -71
  24. package/package.json +1 -1
  25. package/README.GIT +0 -294
  26. package/dist/components/molecules/CastFilter/CastFilters.d.ts +0 -4
  27. package/dist/components/molecules/CastFilter/CastFilters.style.d.ts +0 -16
  28. package/dist/components/molecules/CastFilter/index.d.ts +0 -2
  29. package/dist/components/molecules/PageHeading/Highlight/Highlight.d.ts +0 -4
  30. package/dist/components/molecules/PageHeading/Highlight/Highlight.style.d.ts +0 -9
  31. package/dist/components/molecules/PageHeading/Highlight/index.d.ts +0 -2
  32. package/dist/components/molecules/SkipToMain/SkipToMain.d.ts +0 -20
  33. package/dist/components/molecules/SkipToMain/SkipToMain.style.d.ts +0 -6
  34. package/dist/components/molecules/SkipToMain/index.d.ts +0 -2
package/dist/index.d.ts CHANGED
@@ -1,4 +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, 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';
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, PageHeadingHighlightCarousel, 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';
2
2
  import BodyContent from './components/molecules/BodyContent';
3
3
  import Quote from './components/molecules/Quote';
4
4
  import { devices, breakpoints } from './styles/viewports';
@@ -11,4 +11,4 @@ import HarmonicThemeProvider, { useHarmonicTheme } from './styles/HarmonicThemeP
11
11
  import { HarmonicSize } from './types/typography';
12
12
  import { HarmonicHeader, HarmonicSubtitle, BodyCopyHarmonic, HarmonicOverline, ButtonText, Caption, NavigationText } from './components/Typography';
13
13
  export { useHarmonicTheme };
14
- 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, 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, 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, };
14
+ 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, PageHeadingHighlightCarousel, 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, };
@@ -1,5 +1,5 @@
1
- import { ImgHTMLAttributes, ReactNode } from 'react';
2
- import { EditorialLink, ThemeColor } from '../types';
1
+ import { ReactNode } from 'react';
2
+ import { EditorialLink } from '../types';
3
3
  import { HeaderHierarchy, TypographyLevel } from './typography';
4
4
  export interface CustomSponsorImageData {
5
5
  /**
@@ -190,21 +190,3 @@ export interface IPageHeadingPromoProps {
190
190
  /** Custom CSS classes */
191
191
  className?: string;
192
192
  }
193
- export interface IPageHeadingHighlightProps {
194
- /**
195
- * Image to display in the right hand panel, aspect ratio 4:3
196
- */
197
- image: ImgHTMLAttributes<HTMLImageElement>;
198
- /**
199
- * Optional change to background color
200
- */
201
- background?: ThemeColor;
202
- /**
203
- * The component(s) to be wrapped in the page header
204
- */
205
- children: ReactNode;
206
- /**
207
- * Custom CSS classes
208
- */
209
- className?: string;
210
- }
@@ -203,10 +203,6 @@ export interface INavigationProps {
203
203
  * Additional CSS class names to apply to the navigation component.
204
204
  */
205
205
  className?: string;
206
- /**
207
- * Defines which tag the button should skip to. Default: 'main-content'.
208
- */
209
- skipToId?: string;
210
206
  }
211
207
  export interface ISearchBarProps {
212
208
  /**
@@ -163,10 +163,6 @@ export interface ITabProps {
163
163
  * Defines if it is needed to trim the text of the Tab and add 3 dots in the end
164
164
  */
165
165
  trimText?: boolean;
166
- /**
167
- * data-testid string for easier testing
168
- */
169
- dataTestId?: string;
170
166
  /**
171
167
  * Boolean indicating if the Tab is open.
172
168
  */
@@ -425,67 +421,6 @@ export declare type IHotFilterProps = {
425
421
  selectedIndex?: number;
426
422
  onSelect?: (index: number) => void;
427
423
  };
428
- export declare type ICastFilterItem = Pick<AnchorHTMLAttributes<HTMLAnchorElement>, 'aria-label' | 'role'> & {
429
- /**
430
- * Name of the cast member shown below the image circle. Required.
431
- */
432
- name: string;
433
- /**
434
- * Image source for the image to be shown. Optional but if not included an unaesthetic placeholder will show.
435
- */
436
- image?: string;
437
- onClick?: () => void;
438
- };
439
- export declare type ICastFiltersProps = {
440
- className?: string;
441
- /**
442
- * Array of cast to filter by.
443
- */
444
- cast: ICastFilterItem[];
445
- /**
446
- * Indices of currently selected cast in the `cast` array.
447
- */
448
- selectedIndices?: number[];
449
- /**
450
- * Text shown at the top of the component, e.g. 'Filter by cast'. If this is not provided
451
- * the component will render without any.
452
- */
453
- headingText?: string;
454
- /**
455
- * Override the text of the primary CTA. Default is 'Apply'.
456
- */
457
- ctaText?: string;
458
- /**
459
- * Override the text of the text link. Default is 'Clear'.
460
- */
461
- textLinkText?: string;
462
- /**
463
- * Text to show if no selection is made.
464
- */
465
- emptySelectionText?: string;
466
- /**
467
- * Default image to show in cases where a cast member image prop is missing.
468
- * If this is undefined then a light grey background will be displayed instead.
469
- */
470
- placeholderImage?: string;
471
- /**
472
- * Description to be used as aria-roledescription of the cast filter listbox.
473
- * Read out by screen readers to describe the contents of the list.
474
- */
475
- listRoleDescription?: string;
476
- /**
477
- * Handle selecting individual cast filters.
478
- */
479
- onSelect?: (index: number) => void;
480
- /**
481
- * Handle clicking the primary CTA.
482
- */
483
- onApply?: (indices: number[]) => void;
484
- /**
485
- * Handle clicking the text link.
486
- */
487
- onClear?: () => void;
488
- };
489
424
  export interface ISponsorshipProps {
490
425
  /**
491
426
  * Source URL for Sponsorship IFRAME.
@@ -727,9 +662,3 @@ export declare enum LinkTarget {
727
662
  */
728
663
  Blank = "_blank"
729
664
  }
730
- export interface ISkipToMainProps {
731
- /**
732
- * Defines which tag the button should skip to.
733
- */
734
- skipToId?: string;
735
- }
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@royaloperahouse/harmonic",
3
- "version": "0.16.0",
3
+ "version": "0.17.0-a",
4
4
  "author": "Royal Opera House",
5
5
  "license": "MIT",
6
6
  "main": "dist/index.js",
package/README.GIT DELETED
@@ -1,294 +0,0 @@
1
- # Royal Opera House Harmonic - Front End Design System
2
-
3
- Welcome to The Royal Opera House Front End Design System, `@royaloperahouse/harmonic`
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 [Royal Opera House - Harmonic](https://www.npmjs.com/package/@royaloperahouse/harmonic)
10
-
11
- The Storybook for the latest version of the library is hosted at [Storybook - Harmonic] TODO: S3 deployment
12
-
13
-
14
- ## Prerequisites
15
- ---
16
-
17
- * Make sure the required package dependencies are installed using `yarn install`
18
- * If this is the first time you are working on Harmonic, make sure to run `yarn build` to build all the modules.
19
-
20
- * **To deploy the storybook publicly** you will need credentials for the **parent** 'Royal Opera House' AWS account in your `~/.aws/credentials` file.
21
- * The deploy script expects these to be called `[parent]`.
22
-
23
- * You can find these values at:
24
-
25
- *AWS 'Your Applications' page -> 'Royal Opera House' -> 'Developer Access' -> 'Command line or programmatic access'*
26
-
27
- * **To deploy a preview** for demo / QA you will need:
28
-
29
- * A Chromatic account with a **Developer** role in the `roh-ml` project in Chromatic
30
- * [Mari Lovell](mari.lovell@roh.org.uk) is the current owner of this project, you can contact her to invite you
31
- * The `CHROMATIC_PROJECT_TOKEN` -- find this in 1Password or ask the project owner.
32
-
33
-
34
- * **To enable publishing to the NPM package**:
35
- * Create account / log in to NPM
36
- * Ask a colleague with admin rights to be added as a contributer
37
- * Generate your own ROH `NPM_TOKEN` (store this token in 1Password)
38
- * Set up Two-Factor Authentication for NPM, as you will be prompted by the publishing script
39
-
40
-
41
- ## Versioning
42
- ---
43
- > NOTE: The following applies while the Harmonic project is in Alpha (before a version 1.0.0 release)
44
-
45
- We are **not** yet using semantic versioning.
46
-
47
- When proposing changes to the Harmonic library, increment the patch version (the last number) by one, **only** in the changelog (alternatively, leave the version in the changelog as TBC) along with a note about your changes.
48
-
49
- Only increment the version in the package.json for releasing snapshots.
50
-
51
- Once your changes are merged to the main branch and released in a new version, the release manager will be responsible for incrementing that release version.
52
-
53
- > NOTE: The following **may** apply once the Harmonic project is out of Alpha, but is subject to change before then.
54
-
55
- We use [Semantic Versioning](https://semver.org/) for Harmonic.
56
-
57
- Given a version number MAJOR.MINOR.PATCH, increment the:
58
-
59
- * MAJOR version when you make incompatible library changes
60
- * MINOR version when you add functionality in a backwards compatible manner
61
- * PATCH version when you make backwards compatible bug fixes
62
-
63
- When you create a new release always update the `CHANGELOG` and `package.json`
64
-
65
- Increment your version from the latest stable version on [Royal Opera House - Harmonic](https://www.npmjs.com/package/@royaloperahouse/harmonic?activeTab=versions)
66
-
67
-
68
- ## Deploying the Storybook
69
- ---
70
-
71
- ### **1. To build and deploy locally**
72
-
73
- You can quickly build and serve the contents of `/storybook-static` from your local machine, for development and manual testing. To do this run:
74
-
75
- ```bash
76
- yarn storybook
77
- ```
78
-
79
- By default the storybook will be accessible at
80
- [http://localhost:6006/]()
81
-
82
- The server will hot-reload on most changes.
83
-
84
- ### **2. To deploy a preview version remotely**
85
-
86
- You can deploy a release candidate, or work-in-progress to [Chromatic](https://www.chromatic.com/) for showcase or QA.
87
-
88
- **NOTE:** you will need the `CHROMATIC_PROJECT_TOKEN` and to be invited as a contributor to the Harmonic project in Chromatic, as described in *Prerequisites* above.
89
-
90
- Either set the token as a shell variable or use a `.env` file in the `harmonic` root directory containing the token, as so:
91
-
92
- ```
93
- CHROMATIC_PROJECT_TOKEN=tokengoeshere
94
- ```
95
-
96
- Run:
97
- ```
98
- CHROMATIC_PROJECT_TOKEN=tokengoeshere yarn deploy-storybook-dev
99
- ```
100
-
101
- to build and deploy the storybook from your repo to Chromatic.
102
-
103
- You will find the address of your deployed storybook in the console output, looking something like this:
104
-
105
- `→ View your Storybook at https://randomHexString-randomAlphabeticalString.chromatic.com`
106
-
107
- ### **3. To deploy a release version**
108
-
109
- You can deploy the contents of `./storybook-static` to S3 as a static site, which is permanently accessible at [WIP] TODO: S3 deployment
110
-
111
- **NOTE:** To do this you will need the correct `AWS` credentials set up, as described in *Prerequisites* above.
112
-
113
- First build the storybook using:
114
-
115
- ```
116
- yarn build-storybook
117
- ```
118
-
119
- then run:
120
-
121
- ```bash
122
- yarn deploy-storybook
123
- ```
124
-
125
- > **IMPORTANT:** This URL is intended to showcase the latest stable version of Harmonic, it should be kept up to date with the `main` Harmonic 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*.
126
-
127
-
128
- ## Releasing a New Package Version
129
- ---
130
-
131
- This is the procedure for releasing a new Harmonic NPM package.
132
-
133
- There are two types of package:
134
-
135
- A **snapshot** can be published to use a development version of the Harmonic library in our frontend staging environments, to perform integrated, manual testing.
136
-
137
- A **stable** package is published for use in production.
138
-
139
- **NOTE:** You will need the `NPM_TOKEN`, as described in 'Prerequisites' above.
140
-
141
- ### **1. To release a snapshot version**
142
-
143
- > **IMPORTANT:** Make sure you always publish your **snapshots** from `development` after merging in your feature branch.
144
-
145
- For snapshots, `RELEASE_VERSION` should be the same as the latest **stable** version of the Harmonic Library, as found in [npm Harmonic - Versions](https://www.npmjs.com/package/@royaloperahouse/harmonic?activeTab=versions), followed by an **unused** lowercase letter.
146
-
147
- 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`
148
-
149
- To publish a snapshot use:
150
-
151
- ```bash
152
- NPM_ROH_TOKEN={NPM_TOKEN} RELEASE_VERSION={RELEASE_VERSION} yarn publish-snapshot
153
- ```
154
-
155
- The version published to NPM will be named, e.g. `1.42.0-a-harmonic-development`, use this to install the snapshot package in the frontend repos.
156
-
157
- ### **2. To release a stable version**
158
-
159
- > **IMPORTANT:** Make sure you always publish your **stable** packages from `main` after merging in your feature branch.
160
-
161
- For stable releases, increment your version from the latest **stable** version found on [npm Harmonic - Versions](https://www.npmjs.com/package/@royaloperahouse/harmonic?activeTab=versions), 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`!)
162
-
163
- To publish a stable package use:
164
-
165
- ```bash
166
- NPM_ROH_TOKEN={NPM_TOKEN} RELEASE_VERSION={RELEASE_VERSION} yarn publish-release
167
- ```
168
-
169
-
170
- ## Using the Package
171
- ---
172
-
173
- The package is deployed to NPM, and can be installed using yarn or npm:
174
-
175
- ```bash
176
- npm i --save @royaloperahouse/harmonic
177
- ```
178
- ```bash
179
- yarn add @royaloperahouse/harmonic
180
- ```
181
-
182
-
183
- ## Testing
184
- ---
185
-
186
- To **Lint** the package use:
187
-
188
- ```bash
189
- yarn lint
190
- # Use the --fix option to perform automatic fixes
191
- ```
192
-
193
- To run the **unit tests** (using Jest) use:
194
-
195
- ```bash
196
- yarn test
197
-
198
- # Use the -u option to update snapshots if needed
199
- # Run `yarn test:watch` to re-run tests on changes
200
- ```
201
-
202
- To **run and and store the unit tests** for display in storybook use:
203
-
204
- ```bash
205
- yarn test-storybook
206
- # Use the -u option to update snapshots if needed
207
- ```
208
-
209
-
210
- ## Development Process
211
- ---
212
-
213
- ### **1. Branching Model**
214
- * The Harmonic project lives in the `harmonic-library/harmonic` *repository*
215
- * When working on Harmonic, treat the `harmonic` directory as your root
216
- * The Harmonic **development** branch is for QA
217
- * The Harmonic **main** branch is currently for stable releases
218
- * All work should be done on a correctly named **feature branch** of the format: `issueType/ticketNumber-short-description-of-feature`, e.g. `feature/RD-12345-add-example-component`
219
- * Always create your feature branch FROM, and submit pull requests TO, the **main** branch
220
- * For **QA / UAT** of a Harmonic component in isolation: following review you should deploy a preview version to Chromatic straight from your **feature branch** _without_ merging to development
221
- * For releasing an **NPM snapshot**: merge your feature branch into the **development** branch and publish the NPM snapshot from there
222
-
223
- ### **2. Detailed Workflow**
224
-
225
- #### **Before review:**
226
-
227
- * Git pull the latest version of Harmonic from `main`
228
- * Checkout a new, correctly-named feature branch from `main`
229
- * Do your work on this feature branch
230
- * Run: `yarn lint --fix`
231
- * Run: `yarn test -u`
232
- * Commit your changes
233
- * Create a pull request from your feature branch to `main`
234
- * Add the appropriate reviewers
235
-
236
- #### **Before QA / UAT:**
237
-
238
- After your PR is approved, you have two options:
239
-
240
- **i.** For QA of a component in isolation:
241
-
242
- * Follow the steps above in *Deploying the Storybook -> 2. Deploying a preview version remotely*
243
- * Share the generated Chromatic URL with the appropriate people for QA / UAT
244
-
245
- **ii.** For integrated testing of a component in the frontend staging environments:
246
-
247
- * Check out the `development` branch
248
- * Merge your work in to `development`
249
- * Follow the steps above under *Publishing a New Package Version -> 1. To release a snapshot version*
250
- * Git push the updated `development` branch to remote
251
- * Finally, in the frontend repo:
252
-
253
- 1. Update the `package.json` to reference the new snapshot version
254
- 2. Run: `yarn install`
255
- 3. Deploy the frontend to a staging environment
256
-
257
- #### **When ready for production:**
258
-
259
- * Return to your Harmonic **feature branch**
260
- * Update the HArmonic version in `package.json`, incrementing from the last **stable** release, found in [npm Harmonic - Versions](https://www.npmjs.com/package/@royaloperahouse/harmonic?activeTab=versions), and following the rules described in the *Versioning* section
261
- * Update `CHANGELOG.md`, adding the new version number and a short description of your changes
262
- * Run: `yarn lint --fix`
263
- * Run: `yarn test -u`
264
- * Run: `yarn test-storybook -u`
265
- * Run: `yarn build-storybook`
266
- * Git commit, push, and update your PR for final approval
267
- * Merge your approved PR to `main`
268
- * Follow the steps in *Publishing a New Package Version -> 2. To release a stable version* to publish the NPM package
269
- * Finally, follow the steps in *Deploying The Storybook -> 3. To deploy a release version*, to update the public Harmonic Storybook page
270
-
271
- 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.
272
-
273
-
274
- ## Notes
275
- ---
276
- ### The `storybook-static` folder
277
-
278
- 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:
279
-
280
- ```bash
281
- yarn build-storybook
282
- ```
283
-
284
- 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.
285
-
286
- ---
287
- ### Examples
288
-
289
- 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.
290
-
291
- ---
292
- ### Bundle analysis
293
-
294
- 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`.
@@ -1,4 +0,0 @@
1
- import { FunctionComponent } from 'react';
2
- import { ICastFiltersProps } from '../../../types/types';
3
- declare const CastFilters: FunctionComponent<ICastFiltersProps>;
4
- export default CastFilters;
@@ -1,16 +0,0 @@
1
- export declare const CastFiltersComponentWrapper: import("styled-components").StyledComponent<"div", any, {}, never>;
2
- export declare const CastFiltersWrapper: import("styled-components").StyledComponent<"div", any, {}, never>;
3
- export declare const CastWrapper: import("styled-components").StyledComponent<"div", any, {}, never>;
4
- export declare const ActionButtons: import("styled-components").StyledComponent<"div", any, {}, never>;
5
- export declare const PersonWrapper: import("styled-components").StyledComponent<"div", any, {}, never>;
6
- export declare const PersonToggle: import("styled-components").StyledComponent<"div", any, {
7
- isSelected: boolean;
8
- }, never>;
9
- export declare const PersonImage: import("styled-components").StyledComponent<"img", any, {
10
- isDefaultPlaceholder?: boolean | undefined;
11
- }, never>;
12
- export declare const PersonName: import("styled-components").StyledComponent<"div", any, {}, never>;
13
- export declare const Decal: import("styled-components").StyledComponent<"div", any, {
14
- isSelected: boolean;
15
- }, never>;
16
- export declare const EmptySelectionTextSpacer: import("styled-components").StyledComponent<"div", any, {}, never>;
@@ -1,2 +0,0 @@
1
- import CastFilters from './CastFilters';
2
- export default CastFilters;
@@ -1,4 +0,0 @@
1
- import { FunctionComponent } from 'react';
2
- import { IPageHeadingHighlightProps } from '../../../../types/impactHeader';
3
- declare const PageHeadingHighlight: FunctionComponent<IPageHeadingHighlightProps>;
4
- export default PageHeadingHighlight;
@@ -1,9 +0,0 @@
1
- import { ThemeColor } from '../../../../types';
2
- export declare const HighlightPanelGrid: import("styled-components").StyledComponent<"div", any, {
3
- $background: ThemeColor;
4
- }, never>;
5
- export declare const LeftPanel: import("styled-components").StyledComponent<"div", any, {
6
- hasImage: boolean;
7
- }, never>;
8
- export declare const RightPanel: import("styled-components").StyledComponent<"div", any, {}, never>;
9
- export declare const Wrapper: import("styled-components").StyledComponent<"div", any, {}, never>;
@@ -1,2 +0,0 @@
1
- import PageHeadingHighlight from './Highlight';
2
- export default PageHeadingHighlight;
@@ -1,20 +0,0 @@
1
- import React from 'react';
2
- import { ISkipToMainProps } from '../../../types/types';
3
- /**
4
- * An accessible component which allows Assistive Technology users to move the focus
5
- * to main content, skipping the Nav bar. On desktop, it will remain invisible until focused.
6
- * On mobile, it will remain invisible even when focused.
7
- *
8
- * It's default functionality is to skip to the <main> tag.
9
- * However, skipToId may be passed as a prop to target any element with corresponding id.
10
- * If neither of those is found in the document, the component will be hidden and not focusable.
11
- *
12
- * To prevent SSR errors, the component will return `null` when document object is undefined.
13
- * In practice, testing reveals that this component renders correctly on most SSR'd pages,
14
- * but this check serves as an additional safeguard.
15
- *
16
- * @param skipToId - an optional id of the element to be skipped to, instead of the default <main> tag target.
17
- * @returns JSX.Element | null
18
- */
19
- declare const SkipToMain: ({ skipToId }: ISkipToMainProps) => React.JSX.Element | null;
20
- export default SkipToMain;
@@ -1,6 +0,0 @@
1
- interface FocusableTabProps {
2
- hide?: boolean;
3
- }
4
- export declare const FocusableTab: import("styled-components").StyledComponent<({ title, titleLink, onClick, onFocus, onReset, selected, iconName, iconDirection, withIcon, withTextInMobile, trimText, className, role, ariaLabel, color, dataTestId, isOpen, }: import("../../../types/types").ITabProps) => import("react").JSX.Element, any, FocusableTabProps, never>;
5
- export declare const HiddenBlock: import("styled-components").StyledComponent<"div", any, {}, never>;
6
- export {};
@@ -1,2 +0,0 @@
1
- import SkipToMain from './SkipToMain';
2
- export default SkipToMain;