Publish and use component packages

更新时间:
复制 MD 格式

This topic describes how to publish a component package to the marketplace so you can share and use your custom components.

Prerequisites

Ensure that you have finished editing the component package. For more information, see Edit a component package.

Publish a component package

  1. On the App Development page, in the Development Tools section, click Component Development.

  2. On the Component Development page, on the Public Component Package tab, find the component package that you want to publish and choose one of the following methods:
    • In the Actions column, click Publish.
    • In the Actions column, click Edit. On the Edit Component Package page, click Publish in the upper-right corner of the component list.
  3. In the Publish dialog box, enter the release notes for the new version and click OK.
    Important You must provide an accurate and clear description of the updates in the component package. This information helps the IoT Studio review team quickly understand the changes, test the package, and process your publication request.
    You will be redirected to the Public Component Package tab on the Component Development page. The review status of the submitted component package changes to Under Review.

    The following table describes the component package statuses.

    Status Description
    Ready to Publish
    • The component package is created.
    • An approved component package is edited and updated.
    Under Review The component package has been submitted for publication.
    Approved The component package under review has been approved.
    Rejected The component package under review was not approved.
    Important
    • A component package must be published in IoT Studio to be available to other users.
    • You cannot modify the configuration of a component package while it is under review.
    • Under the same Alibaba Cloud account, if you publish a public solution that contains a private custom component, the page may display incorrectly and the component may fail to load. Therefore, before you publish a public solution, ensure that all its custom components are in a public component package.

Use a component package

You can use a component package in two different scenarios.

Scenario 1: A developer uses their own published component package.

  1. In the component list on the left side of the web-based visual editor, expand the component drop-down list and select the name of the published component package.
  2. Drag the component to the canvas to use it.

Scenario 2: A developer uses a component package published by another developer.

Note Other developers must enable the trial to use the components in the package.
  1. In the component list on the left side of the web-based visual editor, expand the component drop-down list and select the name of the published component package.
    Note In the component list, a Not Enabled notification appears next to component packages that you have not yet enabled.
    After you select a component package, you can view its developer, version number, and description.
    • Click View Documentation to view its help documentation.
    • The components in the package are grayed out and cannot be dragged to the canvas.
    • Hover over a component to preview its icon and description.
  2. Click Enable Trial to use the component package.
    Note After you enable the component package, the component panel shows only the package's developer information.
  3. Drag the component to the canvas to use it.

After a package upgrade

When you publish a new version of a component package, the results depend on your changes, as described in the following table:
Actions Result
You modify an existing custom component.
  • If an older version of the component is already in use on a web-based visual editor page, the existing component instance continues to work.
  • If you want to add a new instance of the component to the page, you can only add the new version.
You delete an existing component.
  • If the deleted component is already in use on a web-based visual editor page, the existing component instance continues to work.
  • The deleted component no longer appears in the new component package, and you cannot add new instances of it.