Lime Web Components API Documentation - v6.24.0
    Preparing search index...

    Interface LimePackageMetadataBeta

    Metadata describing a package or addon using Lime Web Components.

    This metadata is defined in the package's package.json file under the lime field. The system reads this metadata before installing a package to ensure compatibility between the package and the target Lime CRM client environment.

    Packages should declare which platforms they support to prevent installation in incompatible environments.

    // In package.json
    {
      "name": "my-addon",
      "version": "1.0.0",
      "lime": {
        "platforms": ["LimeCRMWebClient", "LimeCRMDesktopClient"]
      }
    }
    interface LimePackageMetadata {
        platforms?: (
            "LimeCRMWebClient"
            | "LimeCRMDesktopClient"
            | "LimeCRMWebAdminClient"
        )[];
    }
    Index

    Properties

    platforms?

    Properties

    platforms?: (
        "LimeCRMWebClient"
        | "LimeCRMDesktopClient"
        | "LimeCRMWebAdminClient"
    )[]

    List of platform types this package is compatible with.

    If specified, the package will only be loaded on the listed platforms. Omitting this field means the package is compatible with all platforms.

    Platform types:

    • LimeCRMWebClient - Standard web browser client
    • LimeCRMDesktopClient - Desktop application client
    • LimeCRMWebAdminClient - Administrative web interface
    // Web-only package
    {
      "lime": {
        "platforms": ["LimeCRMWebClient", "LimeCRMWebAdminClient"]
      }
    }

    Settings

    Member Visibility

    On This Page

    Properties