Skip to content

docs: document FormLayout auto-responsive mode #4225

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

Open
wants to merge 6 commits into
base: latest
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
385 changes: 268 additions & 117 deletions articles/components/form-layout/index.adoc

Large diffs are not rendered by default.

43 changes: 26 additions & 17 deletions frontend/demo/component/formlayout/form-layout-basic.ts
Original file line number Diff line number Diff line change
@@ -1,10 +1,12 @@
import 'Frontend/demo/init'; // hidden-source-line
import '@vaadin/form-layout';
import '@vaadin/form-layout/vaadin-form-row.js';
import '@vaadin/password-field';
import '@vaadin/text-field';
import '@vaadin/email-field';
import '@vaadin/split-layout';
import { html, LitElement } from 'lit';
import { customElement } from 'lit/decorators.js';
import type { FormLayoutResponsiveStep } from '@vaadin/form-layout';
import { applyTheme } from 'Frontend/generated/theme';

@customElement('form-layout-basic')
Expand All @@ -16,25 +18,32 @@ export class Example extends LitElement {
return root;
}

// tag::snippet[]
private responsiveSteps: FormLayoutResponsiveStep[] = [
// Use one column by default
{ minWidth: 0, columns: 1 },
// Use two columns, if layout's width exceeds 500px
{ minWidth: '500px', columns: 2 },
];

protected override render() {
return html`
<vaadin-form-layout .responsiveSteps="${this.responsiveSteps}">
<vaadin-text-field label="First name"></vaadin-text-field>
<vaadin-text-field label="Last name"></vaadin-text-field>
<!-- Stretch the username field over 2 columns -->
<vaadin-text-field colspan="2" label="Username"></vaadin-text-field>
<vaadin-password-field label="Password"></vaadin-password-field>
<vaadin-password-field label="Confirm password"></vaadin-password-field>
<vaadin-split-layout>
${this.renderFormLayout()}
<div></div>
</vaadin-split-layout>
`;
}

private renderFormLayout() {
// tag::snippet[]
return html`
<vaadin-form-layout class="w-full" auto-responsive>
<vaadin-form-row>
<vaadin-text-field label="First name"></vaadin-text-field>
<vaadin-text-field label="Last name"></vaadin-text-field>
</vaadin-form-row>
<vaadin-form-row>
<vaadin-email-field label="Email address"></vaadin-email-field>
</vaadin-form-row>
<vaadin-form-row>
<vaadin-password-field label="Password"></vaadin-password-field>
<vaadin-password-field label="Confirm password"></vaadin-password-field>
</vaadin-form-row>
</vaadin-form-layout>
`;
// end::snippet[]
}
// end::snippet[]
}
38 changes: 23 additions & 15 deletions frontend/demo/component/formlayout/form-layout-colspan.ts
Original file line number Diff line number Diff line change
@@ -1,11 +1,9 @@
import 'Frontend/demo/init'; // hidden-source-line
import '@vaadin/date-picker';
import '@vaadin/form-layout';
import '@vaadin/form-layout/vaadin-form-row.js';
import '@vaadin/text-field';
import '@vaadin/time-picker';
import { html, LitElement } from 'lit';
import { customElement } from 'lit/decorators.js';
import type { FormLayoutResponsiveStep } from '@vaadin/form-layout';
import { applyTheme } from 'Frontend/generated/theme';

@customElement('form-layout-colspan')
Expand All @@ -17,21 +15,31 @@ export class Example extends LitElement {
return root;
}

private responsiveSteps: FormLayoutResponsiveStep[] = [
{ minWidth: 0, columns: 1 },
{ minWidth: '20em', columns: 3 },
];

protected override render() {
return html`
<vaadin-form-layout .responsiveSteps="${this.responsiveSteps}">
<!-- tag::snippet[] -->
<vaadin-text-field label="Title" colspan="3"></vaadin-text-field>
<!-- end::snippet[] -->
<vaadin-date-picker label="Date"></vaadin-date-picker>
<vaadin-time-picker label="From"></vaadin-time-picker>
<vaadin-time-picker label="To"></vaadin-time-picker>
<vaadin-split-layout>
${this.renderFormLayout()}
<div></div>
</vaadin-split-layout>
`;
}

private renderFormLayout() {
// tag::snippet[]
return html`
<vaadin-form-layout class="w-full" auto-responsive column-width="8em" expand-fields>
<vaadin-form-row>
<vaadin-text-field label="Street address" data-colspan="3"></vaadin-text-field>
</vaadin-form-row>
<vaadin-form-row>
<vaadin-text-field label="Postal code"></vaadin-text-field>
<vaadin-text-field label="City/Town" data-colspan="2"></vaadin-text-field>
</vaadin-form-row>
<vaadin-form-row>
<vaadin-text-field label="Country" data-colspan="2"></vaadin-text-field>
</vaadin-form-row>
</vaadin-form-layout>
`;
// end::snippet[]
}
}
55 changes: 0 additions & 55 deletions frontend/demo/component/formlayout/form-layout-custom-field.ts

This file was deleted.

49 changes: 49 additions & 0 deletions frontend/demo/component/formlayout/form-layout-expand-columns.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,49 @@
import 'Frontend/demo/init'; // hidden-source-line
import '@vaadin/form-layout';
import '@vaadin/form-layout/vaadin-form-row.js';
import '@vaadin/password-field';
import '@vaadin/text-field';
import '@vaadin/email-field';
import '@vaadin/split-layout';
import { html, LitElement } from 'lit';
import { customElement } from 'lit/decorators.js';
import { applyTheme } from 'Frontend/generated/theme';

@customElement('form-layout-expand-columns')
export class Example extends LitElement {
protected override createRenderRoot() {
const root = super.createRenderRoot();
// Apply custom theme (only supported if your app uses one)
applyTheme(root);
return root;
}

protected override render() {
return html`
<vaadin-split-layout>
${this.renderFormLayout()}
<div></div>
</vaadin-split-layout>
`;
}

private renderFormLayout() {
// tag::snippet[]
return html`
<vaadin-form-layout class="w-full" auto-responsive column-width="8em" expand-columns>
<vaadin-form-row>
<vaadin-text-field label="First name"></vaadin-text-field>
<vaadin-text-field label="Last name"></vaadin-text-field>
</vaadin-form-row>
<vaadin-form-row>
<vaadin-email-field label="Email address"></vaadin-email-field>
</vaadin-form-row>
<vaadin-form-row>
<vaadin-password-field label="Password"></vaadin-password-field>
<vaadin-password-field label="Confirm password"></vaadin-password-field>
</vaadin-form-row>
</vaadin-form-layout>
`;
// end::snippet[]
}
}
55 changes: 55 additions & 0 deletions frontend/demo/component/formlayout/form-layout-expand-fields.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,55 @@
import 'Frontend/demo/init'; // hidden-source-line
import '@vaadin/form-layout';
import '@vaadin/form-layout/vaadin-form-row.js';
import '@vaadin/password-field';
import '@vaadin/text-field';
import '@vaadin/email-field';
import '@vaadin/split-layout';
import { html, LitElement } from 'lit';
import { customElement } from 'lit/decorators.js';
import { applyTheme } from 'Frontend/generated/theme';

@customElement('form-layout-expand-fields')
export class Example extends LitElement {
protected override createRenderRoot() {
const root = super.createRenderRoot();
// Apply custom theme (only supported if your app uses one)
applyTheme(root);
return root;
}

protected override render() {
return html`
<vaadin-split-layout>
${this.renderFormLayout()}
<div></div>
</vaadin-split-layout>
`;
}

private renderFormLayout() {
// tag::snippet[]
return html`
<vaadin-form-layout
class="w-full"
auto-responsive
column-width="8em"
expand-columns
expand-fields
>
<vaadin-form-row>
<vaadin-text-field label="First name"></vaadin-text-field>
<vaadin-text-field label="Last name"></vaadin-text-field>
</vaadin-form-row>
<vaadin-form-row>
<vaadin-email-field label="Email address"></vaadin-email-field>
</vaadin-form-row>
<vaadin-form-row>
<vaadin-password-field label="Password"></vaadin-password-field>
<vaadin-password-field label="Confirm password"></vaadin-password-field>
</vaadin-form-row>
</vaadin-form-layout>
`;
// end::snippet[]
}
}
49 changes: 49 additions & 0 deletions frontend/demo/component/formlayout/form-layout-labels-aside.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,49 @@
import 'Frontend/demo/init'; // hidden-source-line
import '@vaadin/form-layout';
import '@vaadin/form-layout/vaadin-form-item.js';
import '@vaadin/text-field';
import '@vaadin/email-field';
import '@vaadin/split-layout';
import { html, LitElement } from 'lit';
import { customElement } from 'lit/decorators.js';
import { applyTheme } from 'Frontend/generated/theme';

@customElement('form-layout-labels-aside')
export class Example extends LitElement {
protected override createRenderRoot() {
const root = super.createRenderRoot();
// Apply custom theme (only supported if your app uses one)
applyTheme(root);
return root;
}

protected override render() {
return html`
<vaadin-split-layout>
${this.renderFormLayout()}
<div></div>
</vaadin-split-layout>
`;
}

private renderFormLayout() {
// tag::snippet[]
return html`
<vaadin-form-layout class="w-full" auto-responsive labels-aside>
<vaadin-form-item>
<label slot="label">First name</label>
<vaadin-text-field></vaadin-text-field>
</vaadin-form-item>
<vaadin-form-item>
<label slot="label">Last name</label>
<vaadin-text-field></vaadin-text-field>
</vaadin-form-item>
<vaadin-form-item>
<label slot="label">Email address</label>
<vaadin-email-field></vaadin-email-field>
</vaadin-form-item>
</vaadin-form-layout>
`;
// end::snippet[]
}
}
29 changes: 0 additions & 29 deletions frontend/demo/component/formlayout/form-layout-native-input.ts

This file was deleted.

Loading