Custom component

Custom components are small, self-contained elements of code that can be used and re-used when building widgets. Custom components contains the following elements: definition (QEXT) file, main JavaScript file and optional assets such as JavaScript libraries, images, and fonts.

Download specification

component interface

Properties

  • componentName string
    Required

    The name of the component

  • restrict string
    Required
  • link link
    Required
    Show link properties
    • link() function
      Required
      Parameters
      • scope object
        Required
      • element $Element
        Required
      • attrs object
        Required

Parameters

  • scope object
    Required
  • element $Element
    Required
  • attrs object
    Required

qext interface

Properties

  • name string
    Required

    The name of the custom component.

  • description string
    Required

    Provides a meaningful description of your custom component.

  • type string
    Required

    Extension type. Should always be 'component' for custom components.

  • version string
    Required

    Version of your custom component. Uses the semantic version concept.

  • author string

    Author of the custom component.