xref: /interface/sdk-js/api/config/hml/basic/xcomponent.json

{
  "name": "xcomponent",
  "version": [
    {
      "name": "v8.0"
    }
  ],
  "syscap": [
    "SystemCapability.ArkUI.ArkUI.Full"
  ],
  "description": [
    {
      "name": "The <xcomponent> component provides plugin components for third-party vendors to develop components."
    }
  ],
  "attributes": [
    {
      "name": "id",
      "required": true,
      "description": [
        {
          "name": "Unique ID of a component."
        }
      ],
      "type": "string"
    },
    {
      "name": "ref",
      "required": false,
      "description": [
        {
          "name": "Used to register reference information for elements or child components. The reference information is registered with the parent component on $refs."
        }
      ],
      "type": "string"
    },
    {
      "name": "type",
      "required": true,
      "description": [
        {
          "name": "Used to specify the xcomponent surface type."
        }
      ],
      "type": "enum",
      "options": [
        {
          "name": "surface"
        }
      ]
    },
    {
      "name": "libraryname",
      "required": false,
      "description": [
        {
          "name": "Used to specify the library file name of napi so."
        }
      ],
      "type": "string"
    }
  ],
  "events": [
    {
      "name": "load",
      "description": [
        {
          "name": "Triggered when plug-in loading is complete."
        }
      ]
    },
    {
      "name": "destroy",
      "description": [
        {
          "name": "Triggered when plug-in uninstallation is complete."
        }
      ]
    },
    {
      "name": "touchstart",
      "version": [
        {
          "name": "v4.0"
        }
      ],
      "description": [
        {
          "name": "The tapping starts"
        }
      ]
    },
    {
      "name": "touchmove",
      "version": [
        {
          "name": "v4.0"
        }
      ],
      "description": [
        {
          "name": "The tapping moves."
        }
      ]
    },
    {
      "name": "touchcancel",
      "version": [
        {
          "name": "v4.0"
        }
      ],
      "description": [
        {
          "name": "The tapping is interrupted."
        }
      ]
    },
    {
      "name": "touchend",
      "version": [
        {
          "name": "v4.0"
        }
      ],
      "description": [
        {
          "name": "The tapping ends."
        }
      ]
    },
    {
      "name": "click",
      "syscap": [
        "SystemCapability.ArkUI.ArkUI.Full",
        "SystemCapability.ArkUI.ArkUI.Lite"
      ],
      "version": [
        {
          "name": "v4.0"
        }
      ],
      "description": [
        {
          "name": "A component is clicked.",
          "syscap": [
            "SystemCapability.ArkUI.ArkUI.Full",
            "SystemCapability.ArkUI.ArkUI.Lite"
          ]
        }
      ]
    },
    {
      "name": "longpress",
      "syscap": [
        "SystemCapability.ArkUI.ArkUI.Full",
        "SystemCapability.ArkUI.ArkUI.Lite"
      ],
      "version": [
        {
          "name": "v4.0"
        }
      ],
      "description": [
        {
          "name": "A component is long pressed.",
          "syscap": [
            "SystemCapability.ArkUI.ArkUI.Full",
            "SystemCapability.ArkUI.ArkUI.Lite"
          ]
        }
      ]
    },
    {
      "name": "doubleclick",
      "syscap": [
        "SystemCapability.ArkUI.ArkUI.Full",
        "SystemCapability.ArkUI.ArkUI.Lite"
      ],
      "version": [
        {
          "name": "v4.0"
        }
      ],
      "description": [
        {
          "name": "A component is double clicked.",
          "syscap": [
            "SystemCapability.ArkUI.ArkUI.Full",
            "SystemCapability.ArkUI.ArkUI.Lite"
          ]
        }
      ]
    },
    {
      "name": "pinchstart",
      "syscap": [
        "SystemCapability.ArkUI.ArkUI.Full",
        "SystemCapability.ArkUI.ArkUI.Lite"
      ],
      "version": [
        {
          "name": "v4.0"
        }
      ],
      "description": [
        {
          "name": "The pinch starts.",
          "syscap": [
            "SystemCapability.ArkUI.ArkUI.Full",
            "SystemCapability.ArkUI.ArkUI.Lite"
          ]
        }
      ]
    },
    {
      "name": "pinchupdate",
      "syscap": [
        "SystemCapability.ArkUI.ArkUI.Full",
        "SystemCapability.ArkUI.ArkUI.Lite"
      ],
      "version": [
        {
          "name": "v4.0"
        }
      ],
      "description": [
        {
          "name": "The pinch updates.",
          "syscap": [
            "SystemCapability.ArkUI.ArkUI.Full",
            "SystemCapability.ArkUI.ArkUI.Lite"
          ]
        }
      ]
    },
    {
      "name": "pinchend",
      "syscap": [
        "SystemCapability.ArkUI.ArkUI.Full",
        "SystemCapability.ArkUI.ArkUI.Lite"
      ],
      "version": [
        {
          "name": "v4.0"
        }
      ],
      "description": [
        {
          "name": "The pinch ends.",
          "syscap": [
            "SystemCapability.ArkUI.ArkUI.Full",
            "SystemCapability.ArkUI.ArkUI.Lite"
          ]
        }
      ]
    },
    {
      "name": "pinchcancel",
      "syscap": [
        "SystemCapability.ArkUI.ArkUI.Full",
        "SystemCapability.ArkUI.ArkUI.Lite"
      ],
      "version": [
        {
          "name": "v4.0"
        }
      ],
      "description": [
        {
          "name": "The pinch is interrupted.",
          "syscap": [
            "SystemCapability.ArkUI.ArkUI.Full",
            "SystemCapability.ArkUI.ArkUI.Lite"
          ]
        }
      ]
    },
    {
      "name": "drag",
      "syscap": [
        "SystemCapability.ArkUI.ArkUI.Full",
        "SystemCapability.ArkUI.ArkUI.Lite"
      ],
      "version": [
        {
          "name": "v7.0"
        }
      ],
      "description": [
        {
          "name": "The duration of drag.",
          "syscap": [
            "SystemCapability.ArkUI.ArkUI.Full",
            "SystemCapability.ArkUI.ArkUI.Lite"
          ]
        }
      ]
    },
    {
      "name": "dragstart",
      "syscap": [
        "SystemCapability.ArkUI.ArkUI.Full",
        "SystemCapability.ArkUI.ArkUI.Lite"
      ],
      "version": [
        {
          "name": "v7.0"
        }
      ],
      "description": [
        {
          "name": "The drag starts.",
          "syscap": [
            "SystemCapability.ArkUI.ArkUI.Full",
            "SystemCapability.ArkUI.ArkUI.Lite"
          ]
        }
      ]
    },
    {
      "name": "dragend",
      "syscap": [
        "SystemCapability.ArkUI.ArkUI.Full",
        "SystemCapability.ArkUI.ArkUI.Lite"
      ],
      "version": [
        {
          "name": "v7.0"
        }
      ],
      "description": [
        {
          "name": "The drag ends.",
          "syscap": [
            "SystemCapability.ArkUI.ArkUI.Full",
            "SystemCapability.ArkUI.ArkUI.Lite"
          ]
        }
      ]
    },
    {
      "name": "dragenter",
      "syscap": [
        "SystemCapability.ArkUI.ArkUI.Full",
        "SystemCapability.ArkUI.ArkUI.Lite"
      ],
      "version": [
        {
          "name": "v7.0"
        }
      ],
      "description": [
        {
          "name": "The drag enters.",
          "syscap": [
            "SystemCapability.ArkUI.ArkUI.Full",
            "SystemCapability.ArkUI.ArkUI.Lite"
          ]
        }
      ]
    },
    {
      "name": "dragover",
      "syscap": [
        "SystemCapability.ArkUI.ArkUI.Full",
        "SystemCapability.ArkUI.ArkUI.Lite"
      ],
      "version": [
        {
          "name": "v7.0"
        }
      ],
      "description": [
        {
          "name": "The drag overs.",
          "syscap": [
            "SystemCapability.ArkUI.ArkUI.Full",
            "SystemCapability.ArkUI.ArkUI.Lite"
          ]
        }
      ]
    },
    {
      "name": "dragleave",
      "syscap": [
        "SystemCapability.ArkUI.ArkUI.Full",
        "SystemCapability.ArkUI.ArkUI.Lite"
      ],
      "version": [
        {
          "name": "v7.0"
        }
      ],
      "description": [
        {
          "name": "The drag leaves.",
          "syscap": [
            "SystemCapability.ArkUI.ArkUI.Full",
            "SystemCapability.ArkUI.ArkUI.Lite"
          ]
        }
      ]
    },
    {
      "name": "drop",
      "syscap": [
        "SystemCapability.ArkUI.ArkUI.Full",
        "SystemCapability.ArkUI.ArkUI.Lite"
      ],
      "version": [
        {
          "name": "v7.0"
        }
      ],
      "description": [
        {
          "name": "The drag drops.",
          "syscap": [
            "SystemCapability.ArkUI.ArkUI.Full",
            "SystemCapability.ArkUI.ArkUI.Lite"
          ]
        }
      ]
    },
    {
      "name": "focus",
      "version": [
        {
          "name": "v4.0"
        }
      ],
      "description": [
        {
          "name": "A component gains focus. The <span> component cannot gain focus."
        }
      ]
    },
    {
      "name": "blur",
      "version": [
        {
          "name": "v4.0"
        }
      ],
      "description": [
        {
          "name": "A component loses focus. The <span> component cannot lose focus."
        }
      ]
    },
    {
      "name": "key",
      "version": [
        {
          "name": "v4.0"
        }
      ],
      "description": [
        {
          "name": "A user presses a key on the remote control. Available return values are as follows:\ntrue: returned if the page processes the key event.\nfalse: returned if the default logic is used to process the key event.\nIf no value is returned, false is used as the return value."
        }
      ]
    },
    {
      "name": "swipe",
      "syscap": [
        "SystemCapability.ArkUI.ArkUI.Full",
        "SystemCapability.ArkUI.ArkUI.Lite"
      ],
      "version": [
        {
          "name": "v5.0"
        }
      ],
      "description": [
        {
          "name": "A user quickly swipes on a component.",
          "syscap": [
            "SystemCapability.ArkUI.ArkUI.Full",
            "SystemCapability.ArkUI.ArkUI.Lite"
          ]
        }
      ]
    },
    {
      "name": "attached",
      "version": [
        {
          "name": "v6.0"
        }
      ],
      "description": [
        {
          "name": "The current component is mounted to the render tree."
        }
      ]
    },
    {
      "name": "detached",
      "version": [
        {
          "name": "v6.0"
        }
      ],
      "description": [
        {
          "name": "The current component is removed from the render tree."
        }
      ]
    },
    {
      "name": "accessibility",
      "version": [
        {
          "name": "v4.0"
        }
      ],
      "description": [
        {
          "name": "Event dispatched by the accessibility service."
        }
      ]
    }
  ],
  "supportedSubComponents": false,
  "supportedSubComponentsRestriction": [],
  "unSupportSubComponentsRestriction": [],
  "parentComponentsRestriction": []
}