Interface LimePluginLoader

Interface for the loader component that is loaded when the app starts

Hierarchy

Properties

context platform

Methods

componentWillLoad componentWillUpdate connectedCallback disconnectedCallback

Properties

context

context: LimeWebComponentContext

The context describing where this component is running.

The context provides information about the current limetype and record ID (if viewing/editing a specific record). Components can use this to load relevant data and understand their operating environment.

Example

// Load current record if we have an ID
if (context.id) {
    const repo = platform.get(PlatformServiceName.LimeObjectRepository);
    const object = await repo.loadObject(context.limetype, context.id);
}

platform

platform: LimeWebComponentPlatform

Reference to the platform service container.

Use this to access all platform services like repositories, HTTP client, command bus, navigator, and more. The platform instance is shared across all components in the same application context.

Example

const http = platform.get(PlatformServiceName.Http);
const commandBus = platform.get(PlatformServiceName.CommandBus);

Methods

componentWillLoad

  • Do any initializations required for the plugin in this method

    Returns any

componentWillUpdate

  • This method will never be called since the component will never be updated. It must still be present on the component though.

    Returns any

connectedCallback

  • This method will be invoked every time the component is inserted into the DOM. For a plugin loader component, it should happen only once. The method must be present on the component for technical reasons.

    Returns any

disconnectedCallback

  • This method will be invoked every time the component is removed from the DOM. For a plugin loader component, it should never happen since the component will live during the whole lifespan of the application. The method must be present on the component for technical reasons.

    Returns any

Settings

Member Visibility

Theme