@mendix/extensions-api - v0.3.0
    Preparing search index...

    Interface IComponent

    Interface that a component should implement, so its lifecycle method can be called by the framework.

    interface IComponent {
        loaded(
            componentContext: ComponentContext,
            componentInput: Readonly<Record<string, unknown>>,
        ): Promise<void>;
    }
    Index

    Methods

    Methods

    • Called when the component is initially loaded.

      Parameters

      • componentContext: ComponentContext

        Object that uniquely identifies the component that is being loaded.

      • componentInput: Readonly<Record<string, unknown>>

        Input parameters passed to the component (such as dialogId or currently open document.)

      Returns Promise<void>