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

refactor: extract app-layout styles into reusable CSS literal #8339

Merged
merged 2 commits into from
Dec 13, 2024
Merged
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
8 changes: 8 additions & 0 deletions packages/app-layout/src/vaadin-app-layout-styles.d.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
/**
* @license
* Copyright (c) 2018 - 2024 Vaadin Ltd.
* This program is available under Apache License Version 2.0, available at https://vaadin.com/license/
*/
import type { CSSResult } from 'lit';

export const appLayoutStyles: CSSResult;
166 changes: 166 additions & 0 deletions packages/app-layout/src/vaadin-app-layout-styles.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,166 @@
/**
* @license
* Copyright (c) 2018 - 2024 Vaadin Ltd.
* This program is available under Apache License Version 2.0, available at https://vaadin.com/license/
*/
import { css } from '@vaadin/vaadin-themable-mixin/vaadin-themable-mixin.js';

export const appLayoutStyles = css`
:host {
display: block;
box-sizing: border-box;
height: 100%;
--vaadin-app-layout-transition: 200ms;
transition: padding var(--vaadin-app-layout-transition);
--_vaadin-app-layout-drawer-width: var(--vaadin-app-layout-drawer-width, 16em);
--vaadin-app-layout-touch-optimized: false;
--vaadin-app-layout-navbar-offset-top: var(--_vaadin-app-layout-navbar-offset-size);
--vaadin-app-layout-navbar-offset-bottom: var(--_vaadin-app-layout-navbar-offset-size-bottom);
padding-block: var(--vaadin-app-layout-navbar-offset-top) var(--vaadin-app-layout-navbar-offset-bottom);
padding-inline-start: var(--vaadin-app-layout-navbar-offset-left);
}

:host([hidden]),
[hidden] {
display: none !important;
}

:host([no-anim]) {
--vaadin-app-layout-transition: none !important;
}

:host([drawer-opened]) {
--vaadin-app-layout-drawer-offset-left: var(--_vaadin-app-layout-drawer-offset-size);
}

:host([overlay]) {
--vaadin-app-layout-drawer-offset-left: 0;
--vaadin-app-layout-navbar-offset-left: 0;
}

:host(:not([no-scroll])) [content] {
overflow: auto;
}

[content] {
height: 100%;
}

@media (pointer: coarse) and (max-width: 800px) and (min-height: 500px) {
:host {
--vaadin-app-layout-touch-optimized: true;
}
}

[part='navbar'] {
position: fixed;
display: flex;
align-items: center;
top: 0;
inset-inline: 0;
transition: inset-inline-start var(--vaadin-app-layout-transition);
padding-top: var(--safe-area-inset-top);
padding-left: var(--safe-area-inset-left);
padding-right: var(--safe-area-inset-right);
z-index: 1;
}

:host([primary-section='drawer'][drawer-opened]:not([overlay])) [part='navbar'] {
inset-inline-start: var(--vaadin-app-layout-drawer-offset-left, 0);
}

:host([primary-section='drawer']) [part='drawer'] {
top: 0;
}

[part='navbar'][bottom] {
top: auto;
bottom: 0;
padding-bottom: var(--safe-area-inset-bottom);
}

[part='drawer'] {
overflow: auto;
position: fixed;
top: var(--vaadin-app-layout-navbar-offset-top, 0);
bottom: var(--vaadin-app-layout-navbar-offset-bottom, var(--vaadin-viewport-offset-bottom, 0));
inset-inline: var(--vaadin-app-layout-navbar-offset-left, 0) auto;
transition:
transform var(--vaadin-app-layout-transition),
visibility var(--vaadin-app-layout-transition);
transform: translateX(-100%);
max-width: 90%;
width: var(--_vaadin-app-layout-drawer-width);
box-sizing: border-box;
padding: var(--safe-area-inset-top) 0 var(--safe-area-inset-bottom) var(--safe-area-inset-left);
outline: none;
/* The drawer should be inaccessible by the tabbing navigation when it is closed. */
visibility: hidden;
display: flex;
flex-direction: column;
}

:host([drawer-opened]) [part='drawer'] {
/* The drawer should be accessible by the tabbing navigation when it is opened. */
visibility: visible;
transform: translateX(0%);
touch-action: manipulation;
}

[part='backdrop'] {
background-color: #000;
opacity: 0.3;
}

:host(:not([drawer-opened])) [part='backdrop'] {
opacity: 0;
}

:host([overlay]) [part='backdrop'] {
position: fixed;
inset: 0;
pointer-events: none;
transition: opacity var(--vaadin-app-layout-transition);
-webkit-tap-highlight-color: transparent;
}

:host([overlay]) [part='drawer'] {
top: 0;
bottom: 0;
}

:host([overlay]) [part='drawer'],
:host([overlay]) [part='backdrop'] {
z-index: 2;
}

:host([drawer-opened][overlay]) [part='backdrop'] {
pointer-events: auto;
touch-action: manipulation;
}

:host([dir='rtl']) [part='drawer'] {
transform: translateX(100%);
}

:host([dir='rtl'][drawer-opened]) [part='drawer'] {
transform: translateX(0%);
}

:host([drawer-opened]:not([overlay])) {
padding-inline-start: var(--vaadin-app-layout-drawer-offset-left);
}

@media (max-width: 800px), (max-height: 600px) {
:host {
--vaadin-app-layout-drawer-overlay: true;
--_vaadin-app-layout-drawer-width: var(--vaadin-app-layout-drawer-width, 20em);
}
}

/* If a vaadin-scroller is used in the drawer, allow it to take all remaining space and contain scrolling */
[part='drawer'] ::slotted(vaadin-scroller) {
flex: 1;
overscroll-behavior: contain;
}
`;
164 changes: 4 additions & 160 deletions packages/app-layout/src/vaadin-app-layout.js
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,10 @@ import { FocusTrapController } from '@vaadin/a11y-base/src/focus-trap-controller
import { ControllerMixin } from '@vaadin/component-base/src/controller-mixin.js';
import { defineCustomElement } from '@vaadin/component-base/src/define.js';
import { ElementMixin } from '@vaadin/component-base/src/element-mixin.js';
import { ThemableMixin } from '@vaadin/vaadin-themable-mixin/vaadin-themable-mixin.js';
import { registerStyles, ThemableMixin } from '@vaadin/vaadin-themable-mixin/vaadin-themable-mixin.js';
import { appLayoutStyles } from './vaadin-app-layout-styles.js';

registerStyles('vaadin-app-layout', appLayoutStyles, { moduleId: 'vaadin-app-layout-styles' });

/**
* @typedef {import('./vaadin-app-layout.js').AppLayoutI18n} AppLayoutI18n
Expand Down Expand Up @@ -114,165 +117,6 @@ import { ThemableMixin } from '@vaadin/vaadin-themable-mixin/vaadin-themable-mix
class AppLayout extends ElementMixin(ThemableMixin(ControllerMixin(PolymerElement))) {
static get template() {
return html`
<style>
:host {
display: block;
box-sizing: border-box;
height: 100%;
--vaadin-app-layout-transition: 200ms;
transition: padding var(--vaadin-app-layout-transition);
--_vaadin-app-layout-drawer-width: var(--vaadin-app-layout-drawer-width, 16em);
--vaadin-app-layout-touch-optimized: false;
--vaadin-app-layout-navbar-offset-top: var(--_vaadin-app-layout-navbar-offset-size);
--vaadin-app-layout-navbar-offset-bottom: var(--_vaadin-app-layout-navbar-offset-size-bottom);
padding-block: var(--vaadin-app-layout-navbar-offset-top) var(--vaadin-app-layout-navbar-offset-bottom);
padding-inline-start: var(--vaadin-app-layout-navbar-offset-left);
}

:host([hidden]),
[hidden] {
display: none !important;
}

:host([no-anim]) {
--vaadin-app-layout-transition: none !important;
}

:host([drawer-opened]) {
--vaadin-app-layout-drawer-offset-left: var(--_vaadin-app-layout-drawer-offset-size);
}

:host([overlay]) {
--vaadin-app-layout-drawer-offset-left: 0;
--vaadin-app-layout-navbar-offset-left: 0;
}

:host(:not([no-scroll])) [content] {
overflow: auto;
}

[content] {
height: 100%;
}

@media (pointer: coarse) and (max-width: 800px) and (min-height: 500px) {
:host {
--vaadin-app-layout-touch-optimized: true;
}
}

[part='navbar'] {
position: fixed;
display: flex;
align-items: center;
top: 0;
inset-inline: 0;
transition: inset-inline-start var(--vaadin-app-layout-transition);
padding-top: var(--safe-area-inset-top);
padding-left: var(--safe-area-inset-left);
padding-right: var(--safe-area-inset-right);
z-index: 1;
}

:host([primary-section='drawer'][drawer-opened]:not([overlay])) [part='navbar'] {
inset-inline-start: var(--vaadin-app-layout-drawer-offset-left, 0);
}

:host([primary-section='drawer']) [part='drawer'] {
top: 0;
}

[part='navbar'][bottom] {
top: auto;
bottom: 0;
padding-bottom: var(--safe-area-inset-bottom);
}

[part='drawer'] {
overflow: auto;
position: fixed;
top: var(--vaadin-app-layout-navbar-offset-top, 0);
bottom: var(--vaadin-app-layout-navbar-offset-bottom, var(--vaadin-viewport-offset-bottom, 0));
inset-inline: var(--vaadin-app-layout-navbar-offset-left, 0) auto;
transition:
transform var(--vaadin-app-layout-transition),
visibility var(--vaadin-app-layout-transition);
transform: translateX(-100%);
max-width: 90%;
width: var(--_vaadin-app-layout-drawer-width);
box-sizing: border-box;
padding: var(--safe-area-inset-top) 0 var(--safe-area-inset-bottom) var(--safe-area-inset-left);
outline: none;
/* The drawer should be inaccessible by the tabbing navigation when it is closed. */
visibility: hidden;
display: flex;
flex-direction: column;
}

:host([drawer-opened]) [part='drawer'] {
/* The drawer should be accessible by the tabbing navigation when it is opened. */
visibility: visible;
transform: translateX(0%);
touch-action: manipulation;
}

[part='backdrop'] {
background-color: #000;
opacity: 0.3;
}

:host(:not([drawer-opened])) [part='backdrop'] {
opacity: 0;
}

:host([overlay]) [part='backdrop'] {
position: fixed;
inset: 0;
pointer-events: none;
transition: opacity var(--vaadin-app-layout-transition);
-webkit-tap-highlight-color: transparent;
}

:host([overlay]) [part='drawer'] {
top: 0;
bottom: 0;
}

:host([overlay]) [part='drawer'],
:host([overlay]) [part='backdrop'] {
z-index: 2;
}

:host([drawer-opened][overlay]) [part='backdrop'] {
pointer-events: auto;
touch-action: manipulation;
}

:host([dir='rtl']) [part='drawer'] {
transform: translateX(100%);
}

:host([dir='rtl'][drawer-opened]) [part='drawer'] {
transform: translateX(0%);
}

:host([drawer-opened]:not([overlay])) {
padding-inline-start: var(--vaadin-app-layout-drawer-offset-left);
}

@media (max-width: 800px), (max-height: 600px) {
:host {
--vaadin-app-layout-drawer-overlay: true;
--_vaadin-app-layout-drawer-width: var(--vaadin-app-layout-drawer-width, 20em);
}
}

/* If a vaadin-scroller is used in the drawer, allow it to take all remaining space and contain scrolling */
[part='drawer'] ::slotted(vaadin-scroller) {
flex: 1;
overscroll-behavior: contain;
}
</style>
<div part="navbar" id="navbarTop">
<slot name="navbar" on-slotchange="_updateTouchOptimizedMode"></slot>
</div>
Expand Down
Loading