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 form-layout styles into reusable CSS literal #8340

Merged
merged 1 commit 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
46 changes: 4 additions & 42 deletions packages/form-layout/src/vaadin-form-item.js
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,10 @@ import { html, PolymerElement } from '@polymer/polymer/polymer-element.js';
import { defineCustomElement } from '@vaadin/component-base/src/define.js';
import { addValueToAttribute, removeValueFromAttribute } from '@vaadin/component-base/src/dom-utils.js';
import { generateUniqueId } from '@vaadin/component-base/src/unique-id-utils.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 { formItemStyles } from './vaadin-form-layout-styles.js';

registerStyles('vaadin-form-item', formItemStyles, { moduleId: 'vaadin-form-item-styles' });

/**
* `<vaadin-form-item>` is a Web Component providing labelled form item wrapper
Expand Down Expand Up @@ -95,47 +98,6 @@ import { ThemableMixin } from '@vaadin/vaadin-themable-mixin/vaadin-themable-mix
class FormItem extends ThemableMixin(PolymerElement) {
static get template() {
return html`
<style>
:host {
display: inline-flex;
flex-direction: row;
align-items: baseline;
margin: calc(0.5 * var(--vaadin-form-item-row-spacing, 1em)) 0;
}

:host([label-position='top']) {
flex-direction: column;
align-items: stretch;
}

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

#label {
width: var(--vaadin-form-item-label-width, 8em);
flex: 0 0 auto;
}

:host([label-position='top']) #label {
width: auto;
}

#spacing {
width: var(--vaadin-form-item-label-spacing, 1em);
flex: 0 0 auto;
}

#content {
flex: 1 1 auto;
}

#content ::slotted(.full-width) {
box-sizing: border-box;
width: 100%;
min-width: 0;
}
</style>
<div id="label" part="label" on-click="__onLabelClick">
<slot name="label" id="labelSlot" on-slotchange="__onLabelSlotChange"></slot>
<span part="required-indicator" aria-hidden="true"></span>
Expand Down
10 changes: 10 additions & 0 deletions packages/form-layout/src/vaadin-form-layout-styles.d.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
/**
* @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 formLayoutStyles: CSSResult;

export const formItemStyles: CSSResult;
94 changes: 94 additions & 0 deletions packages/form-layout/src/vaadin-form-layout-styles.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,94 @@
/**
* @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 formLayoutStyles = css`
:host {
display: block;
max-width: 100%;
animation: 1ms vaadin-form-layout-appear;
/* CSS API for host */
--vaadin-form-item-label-width: 8em;
--vaadin-form-item-label-spacing: 1em;
--vaadin-form-item-row-spacing: 1em;
--vaadin-form-layout-column-spacing: 2em; /* (default) */
align-self: stretch;
}

@keyframes vaadin-form-layout-appear {
to {
opacity: 1 !important; /* stylelint-disable-line keyframe-declaration-no-important */
}
}

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

#layout {
display: flex;

align-items: baseline; /* default \`stretch\` is not appropriate */

flex-wrap: wrap; /* the items should wrap */
}

#layout ::slotted(*) {
/* Items should neither grow nor shrink. */
flex-grow: 0;
flex-shrink: 0;

/* Margins make spacing between the columns */
margin-left: calc(0.5 * var(--vaadin-form-layout-column-spacing));
margin-right: calc(0.5 * var(--vaadin-form-layout-column-spacing));
}

#layout ::slotted(br) {
display: none;
}
`;

export const formItemStyles = css`
:host {
display: inline-flex;
flex-direction: row;
align-items: baseline;
margin: calc(0.5 * var(--vaadin-form-item-row-spacing, 1em)) 0;
}

:host([label-position='top']) {
flex-direction: column;
align-items: stretch;
}

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

#label {
width: var(--vaadin-form-item-label-width, 8em);
flex: 0 0 auto;
}

:host([label-position='top']) #label {
width: auto;
}

#spacing {
width: var(--vaadin-form-item-label-spacing, 1em);
flex: 0 0 auto;
}

#content {
flex: 1 1 auto;
}

#content ::slotted(.full-width) {
box-sizing: border-box;
width: 100%;
min-width: 0;
}
`;
50 changes: 4 additions & 46 deletions packages/form-layout/src/vaadin-form-layout.js
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,10 @@ import { isElementHidden } from '@vaadin/a11y-base/src/focus-utils.js';
import { defineCustomElement } from '@vaadin/component-base/src/define.js';
import { ElementMixin } from '@vaadin/component-base/src/element-mixin.js';
import { ResizeMixin } from '@vaadin/component-base/src/resize-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 { formLayoutStyles } from './vaadin-form-layout-styles.js';

registerStyles('vaadin-form-layout', formLayoutStyles, { moduleId: 'vaadin-form-layout-styles' });

/**
* `<vaadin-form-layout>` is a Web Component providing configurable responsive
Expand Down Expand Up @@ -109,51 +112,6 @@ import { ThemableMixin } from '@vaadin/vaadin-themable-mixin/vaadin-themable-mix
class FormLayout extends ResizeMixin(ElementMixin(ThemableMixin(PolymerElement))) {
static get template() {
return html`
<style>
:host {
display: block;
max-width: 100%;
animation: 1ms vaadin-form-layout-appear;
/* CSS API for host */
--vaadin-form-item-label-width: 8em;
--vaadin-form-item-label-spacing: 1em;
--vaadin-form-item-row-spacing: 1em;
--vaadin-form-layout-column-spacing: 2em; /* (default) */
align-self: stretch;
}

@keyframes vaadin-form-layout-appear {
to {
opacity: 1 !important; /* stylelint-disable-line keyframe-declaration-no-important */
}
}

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

#layout {
display: flex;

align-items: baseline; /* default \`stretch\` is not appropriate */

flex-wrap: wrap; /* the items should wrap */
}

#layout ::slotted(*) {
/* Items should neither grow nor shrink. */
flex-grow: 0;
flex-shrink: 0;

/* Margins make spacing between the columns */
margin-left: calc(0.5 * var(--vaadin-form-layout-column-spacing));
margin-right: calc(0.5 * var(--vaadin-form-layout-column-spacing));
}

#layout ::slotted(br) {
display: none;
}
</style>
<div id="layout">
<slot id="slot"></slot>
</div>
Expand Down
Loading