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

chore(components): update back to top button to adapt to sticky header #4879

Open
wants to merge 17 commits into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 7 additions & 0 deletions .changeset/smart-walls-carry.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
---
'@swisspost/design-system-documentation': patch
'@swisspost/design-system-components': patch
'@swisspost/design-system-styles': patch
---

Adjusted the placement of the Back-to-top button to accommodate the sticky header.
Original file line number Diff line number Diff line change
Expand Up @@ -8,15 +8,19 @@
tokens.$default-map: components.$post-floating-button;

:host {
--post-floating-button-translate-y: calc(-1 * #{tokens.get('floating-button-translate-y')});
--post-floating-button-position-top: #{tokens.get('floating-button-position-top')};
--post-back-to-top-position-top: calc(
var(--post-header-height) + var(--post-floating-button-position-top)
);
--post-back-to-top-elevation: #{tokens.get('floating-button-elevation')};
position: fixed;
top: tokens.get('floating-button-position-top');
top: var(--post-back-to-top-position-top);
right: tokens.get('floating-button-position-right');

.back-to-top {
@include button-mx.reset-button;
@include utilities.focus-style;
box-shadow: tokens.get('floating-button-elevation');
box-shadow: var(--post-back-to-top-elevation);
cursor: pointer;
border-radius: tokens.get('floating-button-border-radius-round');
width: tokens.get('floating-button-size-outer');
Expand All @@ -28,11 +32,13 @@ tokens.$default-map: components.$post-floating-button;
display: flex;
align-items: center;
justify-content: center;

&:hover {
border-color: tokens.get('floating-button-hover-border');
color: tokens.get('floating-button-hover-fg');
background-color: tokens.get('floating-button-hover-bg');
}

post-icon {
height: tokens.get('floating-button-size-icon');
width: tokens.get('floating-button-size-icon');
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -25,11 +25,11 @@ export class PostBackToTop {
return window.scrollY > window.innerHeight;
}

private handleScroll = () => {
private readonly handleScroll = () => {
this.belowFold = this.isBelowFold();
};

// Watch for changes in belowFold
// Watch for changes in belowFold to show/hide the back to top button
@Watch('belowFold')
watchBelowFold(newValue: boolean) {
if (newValue) {
Expand Down Expand Up @@ -60,17 +60,43 @@ export class PostBackToTop {
componentDidLoad() {
window.addEventListener('scroll', this.handleScroll, false);

this.translateY = window
.getComputedStyle(this.host)
.getPropertyValue('--post-floating-button-translate-y');
// Get the back-to-top button top postiion
const positionTop = window.getComputedStyle(this.host).getPropertyValue('top');

if (!this.belowFold) {
this.host.style.transform = `translateY(${this.translateY})`;
const buttonElement = this.host.shadowRoot.querySelector('button');

// Extract the elevation height from the back-to-top button elevation token
const elevation = getComputedStyle(buttonElement).getPropertyValue(
'--post-back-to-top-elevation',
);
const elevationParts = elevation.split(',');

function getSecondPixelValue(parts: string[]) {
for (const part of parts) {
const pixelValues = part.match(/\b\d+px\b/g);

if (pixelValues && pixelValues.length > 1) {
return pixelValues[1];
}
}
}

// Initial load
const elevationHeight = getSecondPixelValue(elevationParts);

// The translateY is calculated as => -100% (btt button height) - topPosition - elevationHeight
this.translateY =
String(
(-1 * 100) / 100 -
parseFloat(positionTop.replace('px', '')) -
parseFloat(elevationHeight.replace('px', '')),
) + 'px';

if (this.belowFold) {
slideUp(this.host, this.translateY);
slideDown(this.host, this.translateY);
}

if (!this.belowFold) {
this.host.style.transform = `translateY(${this.translateY})`;
}

this.validateLabel();
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ const meta: MetaComponent = {
language="en"
></swisspost-internet-header>
${fakeContent(17)}
<post-back-to-top />
<post-back-to-top label="Back to top button" />
Copy link
Contributor

Choose a reason for hiding this comment

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

Not sure if it's because the previous swisspost-internet-header is not sticky, but on the preview, the back to top button is visible because it's not being hidden by the header. I think in all cases, it'd be best that the back to top button is not visible at all before we start scrolling.

</div>`,
decorators: [
(story: StoryFn, { args, context }: StoryContext) => html` ${story(args, context)} `,
Expand Down
6 changes: 6 additions & 0 deletions packages/styles/src/tokens/_post-theme.scss
Original file line number Diff line number Diff line change
Expand Up @@ -5,4 +5,10 @@

:root {
@include tokens.from(themes.$post-post);

--post-header-height: 120px; //dummy value
}

body:has(post-header:not([data-hydrated])) post-back-to-top {
visibility: hidden !important;
}