Package com.vaadin.flow.component.page

Annotation Interface ColorScheme

@Retention(RUNTIME) @Target(TYPE) @Inherited @Documented public @interface ColorScheme
Defines the color scheme for the application using the CSS color-scheme property.

This annotation should be placed on a class that implements AppShellConfigurator to set the initial color scheme for the entire application.

Example usage: 

 @ColorScheme(ColorScheme.Value.SYSTEM)
 public class AppShell implements AppShellConfigurator {
 }

The color scheme can also be changed programmatically at runtime using Page.setColorScheme(ColorScheme.Value).

See Also:

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Class
    Description
    static enum 
    ColorScheme.Value
    Enumeration of supported color scheme values.

  • Optional Element Summary

    Optional Elements
    Modifier and Type
    Optional Element
    Description
    ColorScheme.Value
    value
    The initial color scheme for the application.

  • Element Details

    • value

      ColorScheme.Value value
      The initial color scheme for the application.
      Returns:
      the color scheme value
      Default:
      NORMAL