@vaadin/vaadin-lumo-styles

What is @vaadin/vaadin-lumo-styles?

@vaadin/vaadin-lumo-styles is a package that provides a set of customizable CSS styles and design tokens for Vaadin components. It is part of the Vaadin platform, which is used for building modern web applications. The package includes a variety of styles such as typography, color schemes, and spacing utilities that can be applied to enhance the appearance of web components.

What are @vaadin/vaadin-lumo-styles's main functionalities?

Typography

The typography feature provides a set of CSS custom properties for font families, sizes, and weights. These can be used to ensure consistent typography across your application.

import '@vaadin/vaadin-lumo-styles/typography.js';

// Usage in HTML
// <style>
//   h1 {
//     font-family: var(--lumo-font-family);
//     font-size: var(--lumo-font-size-xl);
//   }
// </style>

Color Schemes

The color schemes feature offers a range of CSS custom properties for defining primary, secondary, and contrast colors. This allows for easy theming and color management in your application.

import '@vaadin/vaadin-lumo-styles/color.js';

// Usage in HTML
// <style>
//   .primary-button {
//     background-color: var(--lumo-primary-color);
//     color: var(--lumo-primary-contrast-color);
//   }
// </style>

Spacing Utilities

Spacing utilities provide CSS custom properties for margins and paddings, enabling consistent spacing throughout your application.

import '@vaadin/vaadin-lumo-styles/spacing.js';

// Usage in HTML
// <style>
//   .content {
//     padding: var(--lumo-space-m);
//     margin: var(--lumo-space-l);
//   }
// </style>

Other packages similar to @vaadin/vaadin-lumo-styles

bootstrap

Bootstrap is a popular front-end framework that provides a wide range of CSS styles and components for building responsive web applications. Unlike @vaadin/vaadin-lumo-styles, which is specifically designed for Vaadin components, Bootstrap offers a more general-purpose set of styles and components that can be used with any HTML elements.

material-components-web

Material Components for the web is a library that implements Google's Material Design guidelines. It provides a set of UI components and styles similar to @vaadin/vaadin-lumo-styles but follows the Material Design principles. It is suitable for developers looking to implement Material Design in their web applications.

tailwindcss

Tailwind CSS is a utility-first CSS framework that provides low-level utility classes for building custom designs. Unlike @vaadin/vaadin-lumo-styles, which offers predefined styles for Vaadin components, Tailwind CSS allows developers to create custom designs by composing utility classes.

README

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 style modules. Note, that you don’t need to use Polymer to build your application in order to use Lumo.

Documentation

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

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 components 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.

Big Thanks

Cross-browser Testing Platform and Open Source <3 Provided by Sauce Labs.

Contributing

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

Running demos and tests in a browser

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

2. Make sure you have npm and Bower installed.

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

4. Run npm start, 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:3000/components/vaadin-lumo-styles/demo

Adding or updating icons

1. Open icons/Lumo Icons.sketch using Sketch

2. Follow the instructions in the Sketch document

3. Run npm install to install dependencies

4. Run gulp icons to generate new versions of iconset.html and font-icons.html

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 components 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