com.vaadin.flow.component.page.

Interface AppShellConfigurator

  • All Superinterfaces:

    Serializable


    public interface AppShellConfigurator
extends Serializable

    A marker interface to configure the index.hml page when using client-side bootstrapping. This class supports the following annotations that affect the generated index.html page (also known as 'application shell'):

    • Meta: appends an HTML <meta> tag to the bottom of the <head> element
    • Inline: inlines a static content in any point of the document
    • Viewport: defines the viewport tag of the page
    • BodySize: configures the size of the body
    • PageTitle: establishes the page title
    • Push: configures automatic server push
    • PWA: defines application PWA properties

    There is a single application shell for the entire Vaadin application, and therefore there can be at max one class implementing AppShellConfigurator.

    NOTE: the application shell class is the only valid target for the page configuration annotations listed above. The application would fail to start if any of these annotations is wrongly placed on a class other than the application shell class.

    @Meta(name = "Author", content = "Donald Duck") @PWA(name = "My Fun Application", shortName = "fun-app") @Inline("my-custom-javascript.js") @Viewport("width=device-width, initial-scale=1") @BodySize(height = "100vh", width = "100vw") @PageTitle("my-title") CPush(value = PushMode.AUTOMATIC, transport = Transport.WEBSOCKET_XHR) public class AppShell implements AppShellConfigurator { }

    Since:

    3.0

    • Method Summary

      All Methods
      Modifier and Type Method and Description
      default void configurePage(AppShellSettings settings)

      Configure the initial application shell settings when called.

    • Method Detail

      • configurePage

        default void configurePage(AppShellSettings settings)

        Configure the initial application shell settings when called.

        Parameters:

        settings - initial application shell settings