Trails Packages
    Preparing search index...

    Interface CustomElementOptions

    Options for the createCustomElement function.

    interface CustomElementOptions {
        advanced?: AdvancedCustomElementOptions;
        appMetadata?: ApplicationMetadata;
        chakraSystemConfig?: SystemConfig;
        component?: ComponentType<Record<string, string>>;
        config?: ApplicationConfig;
        resolveConfig?(ctx: ConfigContext): Promise<ApplicationConfig | undefined>;
    }
    Index

    Properties

    advanced? appMetadata? chakraSystemConfig? component? config?

    Methods

    resolveConfig?

    Properties

    advanced?: AdvancedCustomElementOptions

    Advanced configuration that alters the behavior of the custom element.

    appMetadata?: ApplicationMetadata

    Application metadata (packages, services etc.). This is usually autogenerated by importing the virtual "open-pioneer:app" module.

    chakraSystemConfig?: SystemConfig

    Chakra styled system object.

    Used to configure chakra's theme.

    component?: ComponentType<Record<string, string>>

    Rendered UI component.

    config?: ApplicationConfig

    Application defined configuration.

    This option can be used to override default properties of the application's packages.

    All instances of the web component will share this static configuration.

    Methods

    • Function to provide additional application defined configuration parameters.

      Compared to config, this function receives a context object that allows the developer to provide dynamic properties on a per-application instance basis.

      Parameters returned by this function take precedence over the ones defined by config.

      Parameters

      Returns Promise<ApplicationConfig | undefined>

    Settings

    Member Visibility

    On This Page

    Properties
    Methods