Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[GRAV-1370] [BpkOverlay] Add video overlay style #3717

Merged
merged 8 commits into from
Jan 22, 2025

Conversation

kirstybryce
Copy link
Contributor

@kirstybryce kirstybryce commented Jan 17, 2025

JIRA: https://skyscanner.atlassian.net/browse/GRAV-1370

The new homepage hero video ad POC requires a new video overlay. This PR adds that new overlay type to BpkOverlay as videoTop and videoBottom.

Link to Figma video overlay design: https://www.figma.com/design/yN0hFyZlKL0Jwbpi0rEKYT/Backpack-Beta?node-id=27362-1451&m=dev

No overlay Video Overlay
Screenshot 2025-01-21 at 15 17 57

Remember to include the following changes:

  • Ensure the PR title includes the name of the component you are changing so it's clear in the release notes for consumers of the changes in the version e.g [KOA-123][BpkButton] Updating the colour
  • README.md (If you have created a new component)
  • Component README.md
  • Tests
  • Accessibility tests
    • The following checks were performed:
      • Ability to navigate using a keyboard only
      • Zoom functionality (Deque University explanation):
        • The page SHOULD be functional AND readable when only the text is magnified to 200% of its initial size
        • Pages must reflow as zoom increases up to 400% so that content continues to be presented in only one column i.e. Content MUST NOT require scrolling in two directions (both vertically and horizontally)
      • Ability to navigate using a screen reader only
  • Storybook examples created/updated
  • For breaking changes or deprecating components/properties, migration guides added to the description of the PR. If the guide has large changes, consider creating a new Markdown page inside the component's docs folder and link it here

@kirstybryce kirstybryce changed the title [GRAV-1370] Add video overlay style to BpkOverlay [GRAV-1370] [BpkOverlay] Add video overlay style Jan 17, 2025
@kirstybryce kirstybryce added the minor Non breaking change label Jan 20, 2025
Copy link

Visit https://backpack.github.io/storybook-prs/3717 to see this build running in a browser.

Copy link

github-actions bot commented Jan 20, 2025

Warnings
⚠️

Package source files (e.g. packages/package-name/src/Component.tsx) were updated, but type files weren't. Have you checked that no types have changed?

Browser support

If this is a visual change, make sure you've tested it in multiple browsers.

Generated by 🚫 dangerJS against e41843e

@@ -61,6 +62,7 @@ const overlayTypeClassSuffixes = {
[OVERLAY_TYPES.rightMedium]: 'right-medium',
[OVERLAY_TYPES.rightHigh]: 'right-high',
[OVERLAY_TYPES.vignette]: 'vignette',
[OVERLAY_TYPES.videoOverlay]: 'video-overlay',
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We will need to have a videoTop and videoBottom overlay types looking at the figma design :)

Copy link
Contributor Author

@kirstybryce kirstybryce Jan 21, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hi, the reason I made it as one overlay is for 2 reasons:

  • simplicity of having one overlay used for the homepage video component instead of 2
  • since the video top overlay is only taking up 40% of the height at the top of the overlay, and the video bottom overlay is taking up 60% of the height at the bottom of the overlay, it seemed better to have a full overlay with those value since the current top/bottom overlay are taking up 100% of the height of the overlay. If I created a separate video top/bottom overlay they wouldn't be consistent with the other top/bottom overlays so it seemed better to have a separate video overlay like the vignette.

Do you think it would be better as top/bottom? Happy to change it if so :)

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for the response!

Checking the Backpack designs and with the designers, it would be expected to be two separate types of overlay for videos :) so shouldn't ever have both the top and bottom turned on at the same time.

If we would expect that to happen, then we should talk with design to get this changed at its design level to then reflect that into the code

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

ok makes sense, will update :)

Copy link

Visit https://backpack.github.io/storybook-prs/3717 to see this build running in a browser.

Copy link

Visit https://backpack.github.io/storybook-prs/3717 to see this build running in a browser.

Copy link

Visit https://backpack.github.io/storybook-prs/3717 to see this build running in a browser.

@kirstybryce kirstybryce marked this pull request as ready for review January 22, 2025 14:21
Copy link

Visit https://backpack.github.io/storybook-prs/3717 to see this build running in a browser.

Copy link

Visit https://backpack.github.io/storybook-prs/3717 to see this build running in a browser.

@Sybsw Sybsw merged commit d236a89 into main Jan 22, 2025
9 checks passed
@Sybsw Sybsw deleted the GRAV-1370_add-video-overlay branch January 22, 2025 14:44
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
minor Non breaking change
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants