hml/basic/button.json

{
  "name": "button",
  "version": [
    {
      "name": "v3.0"
    }
  ],
  "description": [
    {
      "name": "The <button> component includes capsule, circle, text, arc, and download buttons."
    }
  ],
  "attributes": [
    {
      "name": "type",
      "required": false,
      "description": [
        {
          "name": "Dynamic modification is not supported. If this attribute is not set, capsule-like buttons are displayed. Different from the capsule button, the four rounded corners of a capsule-like button can be configured using border-radius. Available button types are as follows: capsule: a capsule button with fillets, background color, and text. circle: a circle button which can be used to place icons. text: a text button which displays the text only. arc: an arc button. download: a download button. The download progress bar is added."
        }
      ],
      "type": "enum",
      "options": [
        {
          "name": "capsule"
        },
        {
          "name": "circle"
        },
        {
          "name": "text"
        }
      ]
    },
    {
      "name": "value",
      "required": false,
      "description": [
        {
          "name": "Text value of the button. This attribute is unavailable for circle buttons."
        }
      ],
      "type": "string"
    },
    {
      "name": "icon",
      "required": false,
      "description": [
        {
          "name": "Path of the button icon. This parameter is valid only for the circle button. The supported icon formatformats are JPG, PNG, and SVG."
        }
      ],
      "type": "url"
    },
    {
      "name": "placement",
      "required": false,
      "description": [
        {
          "name": "Position of the button icon in text. This attribute is valid only when type is not set. Available values are as follows: start: The button icon is at the beginning of the text. end: The button icon is at the end of the text. top: The button icon is at the top of the text.bottom: The button icon is at the bottom of the text."
        }
      ],
      "type": "enum",
      "options": [
        {
          "name": "end"
        },
        {
          "name": "start"
        },
        {
          "name": "top"
        },
        {
          "name": "bottom"
        }
      ]
    },
    {
      "name": "waiting",
      "required": false,
      "description": [
        {
          "name": "Waiting status. When waiting is set to true, the waiting transition is displayed on the left of the text. This attribute is unavailable for download buttons and smart watches."
        }
      ],
      "type": "enum",
      "options": [
        {
          "name": "true"
        },
        {
          "name": "false"
        }
      ]
    },
    {
      "name": "id",
      "required": false,
      "description": [
        {
          "name": "Unique ID of a component."
        }
      ],
      "type": "string"
    },
    {
      "name": "style",
      "required": false,
      "description": [
        {
          "name": "Style declaration of a component."
        }
      ],
      "type": "string"
    },
    {
      "name": "class",
      "required": false,
      "description": [
        {
          "name": "Style class of a component, which is used to refer to a style table."
        }
      ],
      "type": "string"
    },
    {
      "name": "disabled",
      "required": false,
      "description": [
        {
          "name": "Whether the component is disabled. If the component is disabled, the component cannot respond to user interaction."
        }
      ],
      "type": "enum",
      "options": [
        {
          "name": "true"
        },
        {
          "name": "false"
        }
      ]
    },
    {
      "name": "voicelabel",
      "required": false,
      "description": [
        {
          "name": "Voice label. When a voice label is triggered, the click event of the component is triggered. NOTE: The voice label takes effect only when the click event is set."
        }
      ],
      "type": "string"
    },
    {
      "name": "subscriptflag",
      "required": false,
      "description": [
        {
          "name": "Voice subscript switch. Available values are as follows: auto: For the <image> and <list-item> components, if subscriptflag is set to auto, the voice subscript is turned on. For other components, if subscriptflag is set to auto, the voice subscript is turned off. on: Turn on the voice subscript. off: Turn off the voice subscript. If no customized subscript is set, the subscript is automatically accumulated from 1. NOTE The voice subscript takes effect only when the click event is set."
        }
      ],
      "type": "enum",
      "options": [
        {
          "name": "auto"
        },
        {
          "name": "on"
        },
        {
          "name": "off"
        }
      ]
    },
    {
      "name": "subscriptlabel",
      "required": false,
      "description": [
        {
          "name": "Custom subscript. After it is set, the subscript is displayed in the way you specified. To make this attribute take effect, you need to turn on the voice subscript."
        }
      ],
      "type": "string"
    },
    {
      "name": "scenelabel",
      "required": false,
      "description": [
        {
          "name": "Available values are as follows: video: Video scenario. For example, to watch a video, a user can say the voiceLabel (usually the video name), play voiceLabel, see voiceLabel, or watch voiceLabel, etc. audio: Music scenario. For example, to listen to a song, a user can say the voiceLabel (usually the song name), play voiceLabel, or listen voiceLabel, etc. page: Page scenario. For example, to go to a page, a user can say the voiceLabel (usually the page name), switch to voiceLabel, go to voiceLabel, or jump to voiceLabel, etc. switch: Switch scenario. For example, to turn on or turn off a switch, a user can say the voiceLabel (usually the switch name), turn on voiceLabel, open voiceLabel, turn off voiceLabel, close voiceLabel, etc. common: Common scenario, which is triggered by the voiceLabel."
        }
      ],
      "type": "enum",
      "options": [
        {
          "name": "video"
        },
        {
          "name": "audio"
        },
        {
          "name": "page"
        },
        {
          "name": "switch"
        },
        {
          "name": "common"
        }
      ]
    },
    {
      "name": "accessibilitygroup",
      "required": false,
      "description": [
        {
          "name": "Accessibility group. If this attribute is set to true, the component and all its child components form an entire selectable component, and the accessibility service will no longer available for the content of its child components."
        }
      ],
      "type": "enum",
      "options": [
        {
          "name": "true"
        },
        {
          "name": "false"
        }
      ]
    },
    {
      "name": "accessibilitytext",
      "required": false,
      "description": [
        {
          "name": "Accessibility text. If a component does not contain text information, it will not be read when the component is selected by the screen reader. In this case, the screen reader user cannot know which component is selected. To solve this problem, you can set this attribute for components without text information. When the component is selected by the screen reader, the specified accessibility text will be read, informing the user which component is selected. If a component with this attribute set contains text information, only the accessibility text will be read."
        }
      ],
      "type": "string"
    },
    {
      "name": "accessibilitydescription",
      "required": false,
      "description": [
        {
          "name": "Accessibility description. You can specify further explanation of the current component, for example, possible operation consequences, especially those cannot be learned from component attributes and accessibility text. You can set a detailed description text for the attribute of the component to help users understand the operation to be performed. If a component contains both text information and the accessibility description, the text is read first and then the accessibility description, when the component is selected."
        }
      ],
      "type": "string"
    },
    {
      "name": "accessibilityimportance",
      "required": false,
      "description": [
        {
          "name": "Accessibility importance, which is used to decide whether a component can be identified by the accessibility service. The value can be auto, yes, no, or no-hide-descendants. The last value forces the screen reader to ignore the current component and all its subcomponents. yes: The current component is selectable for the accessibility service. no: The current component is not selectable for the accessibility service."
        }
      ],
      "type": "string"
    },
    {
      "name": "for",
      "required": false,
      "description": [
        {
          "name": "Expands the current element based on the configured data list."
        }
      ],
      "type": "string"
    },
    {
      "name": "tid",
      "required": false,
      "description": [
        {
          "name": "The tid attribute is used to accelerate the for loop. It is used to improve the re-rendering efficiency when data in a loop changes. The tid attribute specifies the unique ID of each element in the array. If it is not specified, the index of each element in the array is used as the ID. For example, tid='id' indicates that the id attribute of each element is its unique identifier."
        }
      ],
      "type": "string"
    },
    {
      "name": "if",
      "required": false,
      "description": [
        {
          "name": "Whether the element is added or removed."
        }
      ],
      "type": "enum",
      "options": [
        {
          "name": "true"
        },
        {
          "name": "false"
        }
      ]
    },
    {
      "name": "elif",
      "required": false,
      "description": [],
      "type": "enum",
      "options": [
        {
          "name": "true"
        },
        {
          "name": "false"
        }
      ]
    },
    {
      "name": "else",
      "required": false,
      "description": [],
      "type": "string"
    },
    {
      "name": "show",
      "required": false,
      "description": [
        {
          "name": "Whether the element is displayed or hidden."
        }
      ],
      "type": "enum",
      "options": [
        {
          "name": "true"
        },
        {
          "name": "false"
        }
      ]
    }
  ],
  "events": [
    {
      "name": "click",
      "description": [
        {
          "name": "Triggered when a component is clicked."
        }
      ]
    }
  ],
  "supportedSubComponents": false,
  "supportedSubComponentsRestriction": [],
  "unSupportSubComponentsRestriction": [],
  "parentComponentsRestriction": []
}