kaicao / vaadin-lumo-styles

Lumo is an evolving design system foundation for modern web applications, used by Vaadin Elements. https://vaadin.com/elements

Lumo

Lumo – ✨ enchantment (Finnish) and 🔆 light (Esperanto)

Lumo is a design system foundation for modern, beautiful and accessible web applications.

Lumo contains foundational styles – typography, colors, visual style, sizing & spacing and icons – that components and applications can use to achieve a consistent visual design.

The implementation of Lumo is based on CSS custom properties, and Polymer 2.0 style modules. Note, that you don’t need to use Polymer to build your application in order to use Lumo, though it is recommended.

Documentation

🚧 Documentation will eventually be deployed at https://vaadin.com/themes/lumo 🚧

For documentation and instructions how to get started, use the “Documentation” link in the latest release notes.

Part of the Vaadin platform

Lumo is maintained as a part of the Vaadin platform.

Vaadin Elements is a collection of web components that use the Lumo design language as their default theme. The Vaadin app starters are also based on Lumo.

Roadmap

Currently, Lumo is perhaps just a glorified visual style guide. The intention, however, is to gradually grow it to contain design guidelines and patterns as well, with a focus on enterprise/business application use cases. The vision is that you could use Lumo as a starting point for creating your own design system.

Also, the technical implementation is expected to evolve together with Vaadin Elements and Polymer, with Polymer 3 around the corner.

Contributing

Reporting issues and feature request is a great way to help! If you have questions, join the Vaadin Elements chat – we’re happy to answer Lumo related questions there.

Running demos and tests in browser

1. Fork the vaadin-lumo-styles repository and clone it locally.

2. Make sure you have npm installed.

3. When in the vaadin-lumo-styles directory, run npm install and then bower install to install dependencies.

4. Run polymer serve --open, browser will automatically open the component API documentation.

5. You can also open demo/documentation by adding demo to the URL, for example:

• http://127.0.0.1:8080/components/vaadin-lumo-styles/demo

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. CSS inside .html files is also linted at the same time.

Creating a pull request

• Make sure your code is compliant with our code linters: gulp lint
• Submit a pull request with detailed title and description
• Wait for response from one of Vaadin Elements team members

Updating the version number

Use npm version <new version> to update the version number in package.json and in other relevant places such as version.html, when preparing to release a new version.

License

Apache License 2.0