vaadin-split-layout
The Web Component which allows you to partition a layout into resizeable areas. Part of the Vaadin components.
<vaadin-split-layout>
Live Demo ↗ | API documentation ↗
<vaadin-split-layout> is a Web Component implementing a split layout for two content elements with a draggable splitter between them, part of the Vaadin components.
<vaadin-split-layout>
<vaadin-split-layout orientation="vertical">
<div>First layout content</div>
<div>Second layout content</div>
</vaadin-split-layout>
<vaadin-split-layout orientation="vertical">
<div>Third layout content</div>
<div>Fourth layout content</div>
</vaadin-split-layout>
</vaadin-split-layout>
Installation
The Vaadin components are distributed as Bower and npm packages. Please note that the version range is the same, as the API has not changed. You should not mix Bower and npm versions in the same application, though.
Unlike the official Polymer Elements, the converted Polymer 3 compatible Vaadin components are only published on npm, not pushed to GitHub repositories.
Polymer 2 and HTML Imports Compatible Version
Install vaadin-split-layout
:
bower i vaadin/vaadin-split-layout --save
Once installed, import it in your application:
<link rel="import" href="bower_components/vaadin-split-layout/vaadin-split-layout.html">
Polymer 3 and ES Modules Compatible Version
Install vaadin-split-layout
:
npm i @vaadin/vaadin-split-layout --save
Once installed, import it in your application:
import '@vaadin/vaadin-split-layout/vaadin-split-layout.js';
Getting started
Vaadin components use the Lumo theme by default.
To use the Material theme, import the correspondent file from the theme/material
folder.
Entry points
The component with the Lumo theme:
theme/lumo/vaadin-split-layout.html
The component with the Material theme:
theme/material/vaadin-split-layout.html
Alias for
theme/lumo/vaadin-split-layout.html
:vaadin-split-layout.html
Running demos and tests in browser
Fork the
vaadin-split-layout
repository and clone it locally.Make sure you have npm installed.
When in the
vaadin-split-layout
directory, runnpm install
and thenpolymer install --variants
to install dependencies.Run
polymer serve
, after that you will be able to access:
Polymer1-compatible version:
Polymer2-compatible version:
Note that ports 8000
and 8001
could be different in your environment.
Running tests from the command line
- When in the
vaadin-split-layout
directory, runpolymer test
Following the coding style
We are using ESLint for linting JavaScript code. You can check if your code is following our standards by running gulp lint
, which will automatically lint all .js
files as well as JavaScript snippets inside .html
files.
Contributing
To contribute to the component, please read the guideline first.
License
Apache License 2.0
Vaadin collects development time usage statistics to improve this product. For details and to opt-out, see https://github.com/vaadin/vaadin-usage-statistics.
Links
Compatibility
Was this helpful? Need more help?
Leave a comment or a question below. You can also join
the chat on Discord or
ask questions on StackOverflow.
Version
Dependencies
- @polymer/polymer#^3.0.0
- @polymer/iron-resizable-behavior#^3.0.0-pre.18
- @vaadin/vaadin-themable-mixin#^1.2.1
- @vaadin/vaadin-lumo-styles#^1.1.0
- @vaadin/vaadin-material-styles#^1.1.0
- @vaadin/vaadin-element-mixin#^2.0.0
- Released
- 2018-08-20
- Maturity
- IMPORTED
- License
- Apache License 2.0
Compatibility
- Framework
- Polymer 2.0+
- Polymer 3.0+
- Polymer 1.0+ in 1.1.0
- Browser
- Browser Independent