Lumo Variants

Lumo has global variants that you can use to quickly customize all components and built-in component variants that can be used to style individual component instances quickly.

Dark Mode

Dark mode is commonly used in low-light environments or during night-time.

Caution
The dark variant is not supported in Internet Explorer 11. See the issue in GitHub.

JavaJavaScriptHTML

In server-side views, use the variant attribute of the @Theme annotation. See Using Themes for more information.

UsingComponentThemes.java

Expand code

  1. @Theme(value = Lumo.class, variant = Lumo.DARK)

You can also use the same attribute on any element which is in the global style scope (see Style Scopes).

For server-side components, you can use the Element API to set the attribute value. Some components offer specific API for setting theme variants.

Java

  1. VerticalLayout dark = new VerticalLayout();
  2. dark.getElement().setAttribute("theme", Lumo.DARK);

For client-side components/templates you can add the attribute directly to the HTML element.

HTML

  1. <vaadin-vertical-layout theme="dark"></vaadin-vertical-layout>

Compact

The compact variant reduces the font size and the sizing and spacing of all components, allowing you to place more components on the screen.

The compact variant is applied by importing an additional style sheet, which sets new values for the Typography and Sizing and Spacing CSS properties. You can view the values from the source code.

Java

  1. @JsModule("@vaadin/vaadin-lumo-styles/presets/compact.js")
  2. @Theme(Lumo.class)
  3. public class CompactApp extends Div {
  4. }

JavaScript

  1. import '@vaadin/vaadin-lumo-styles/presets/compact.js';

Component Variants

You can find a component’s Lumo variants from its HTML examples online, from the “Theme Variants” section.