https://github.com/vaadin/vaadin-board
Web Component for creating flexible responsive layouts and building nice looking dashboards.
https://github.com/vaadin/vaadin-board
vaadin vaadin-elements vaadin-pro web-component web-components
Last synced: about 1 year ago
JSON representation
Web Component for creating flexible responsive layouts and building nice looking dashboards.
- Host: GitHub
- URL: https://github.com/vaadin/vaadin-board
- Owner: vaadin
- License: other
- Created: 2017-01-25T09:57:40.000Z (over 9 years ago)
- Default Branch: master
- Last Pushed: 2025-02-10T10:27:07.000Z (over 1 year ago)
- Last Synced: 2025-04-15T07:08:36.479Z (about 1 year ago)
- Topics: vaadin, vaadin-elements, vaadin-pro, web-component, web-components
- Language: HTML
- Homepage: https://vaadin.com/components/vaadin-board
- Size: 1.23 MB
- Stars: 17
- Watchers: 15
- Forks: 11
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE.txt
Awesome Lists containing this project
README
# \
> ⚠️ Starting from Vaadin 20, the source code and issues for this component are migrated to the [`vaadin/web-components`](https://github.com/vaadin/web-components/tree/master/packages/vaadin-board) monorepository.
> This repository contains the source code and releases of `` for the Vaadin versions 10 to 19.
[<vaadin-board>](https://vaadin.com/components/vaadin-board) is a Web component to create flexible responsive layouts and build nice looking dashboard.
Vaadin Board key feature is how it effectively reorders the widgets on different screen sizes, maximizing the use of space and looking stunning.
[Live Demo ↗](https://vaadin.com/components/vaadin-board/html-examples)
|
[API documentation ↗](https://vaadin.com/components/vaadin-board/html-api)
[](https://www.npmjs.com/package/@vaadin/vaadin-board)
[](https://vaadin.com/directory/component/vaadinvaadin-board)
[](https://discord.gg/PHmkCKC)
```html
top A
top B
top C
mid
low A
low B / A
low B / B
low B / C
low B / D
```
[
](https://vaadin.com/components/vaadin-board)
### 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-board`:
```sh
$ bower i vaadin/vaadin-board --save
```
Once installed, import it in your application:
```html
```
### Polymer 3 and ES Modules compatible version
Install `vaadin-board`:
```sh
npm i @vaadin/vaadin-board --save
```
Once installed, import it in your application:
```js
import '@vaadin/vaadin-board/vaadin-board.js';
```
## Running demos and tests in browser
1. Clone the repository
`git clone https://github.com/vaadin/vaadin-board.git`
1. Make sure you have [npm](https://www.npmjs.com/) installed.
1. When in the `vaadin-element` directory, run `npm install` and then `bower install` to install dependencies.
1. Make sure you have [polymer-cli](https://www.npmjs.com/package/polymer-cli) installed globally: `npm i -g polymer-cli`.
1. Run `polymer serve --open`, browser will automatically open the component API documentation.
1. You can also open demo or in-browser tests by adding **demo** or **test** to the URL, for example:
- http://127.0.0.1:8080/components/vaadin-board/demo
- http://127.0.0.1:8080/components/vaadin-board/test
## Running tests from the command line
> [!WARNING]
> Running tests locally from the CLI does not work due to outdated dependencies. Run tests via SauceLabs or in the browser instead.
1. When in the `vaadin-board` directory, run `polymer test`
## Following the coding style
We are using [ESLint](http://eslint.org/) for linting JavaScript code. You can check if your code is following our standards by running `npm run 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](https://github.com/vaadin/vaadin-core/blob/master/CONTRIBUTING.md) first.
## License
Vaadin Board is distributed under [Commercial Vaadin Add-on License version 3](http://vaadin.com/license/cval-3) (CVALv3). For license terms, see LICENSE.txt.
Vaadin collects development time usage statistics to improve this product. For details and to opt-out, see https://github.com/vaadin/vaadin-usage-statistics.