@hmiproject/helio-sdk
    Preparing search index...

    Function createLibraryExtension

    • Creates a HELIO library extension.

      Extensions can hold multiple elements, actions and dynamic properties. When imported into a HELIO project these will be added to the library and can be accessed like items from the HELIO core.

      Parameters

      • options: {
            actions?: CreateActionResult<any>[];
            author: string;
            description: string;
            dynamicProperties?: CreateDynamicPropertyResult<any>[];
            elements?: CreateElementResult<any>[];
            icons?: CreateIconResult[];
            minimumRequiredHelioVersion: "25.4.0";
            name: string;
            version: string;
        }
        • Optionalactions?: CreateActionResult<any>[]
        • author: string

          Author name for this extension

          Will be shown in the IDE

          'My Company'
          
        • description: string

          User-facing description for this extension

          Will be shown in the IDE

          'Adds a set of custom control to HELIO'
          
        • OptionaldynamicProperties?: CreateDynamicPropertyResult<any>[]
        • Optionalelements?: CreateElementResult<any>[]
        • Optionalicons?: CreateIconResult[]
        • minimumRequiredHelioVersion: "25.4.0"

          Minimum required HELIO version.

          This is always enforced by the TypeScript type to match the SDK's required version.

          Warning: Ignoring the type will lead to unexpected behavior at runtime.

        • name: string

          User-facing name for this extension

          Will be shown in the IDE

          'My Extension'
          
        • version: string

          Version number for this extension

          Must follow semantic versioning/semver specification, i.e. MAJOR.MINOR.PATCH.

          '1.9.2'
          

      Returns CreateLibraryExtensionResult

        const ns = createNamespace({ name: 'com.my-company' });

      const extension = createLibraryExtension({
      name: 'My Extension',
      description: 'Adds a set of custom control to HELIO',
      version: '1.0.0',
      author: 'My Company',
      minimumRequiredHelioVersion: '25.4.0',
      elements: [customButton, customInput],
      });