All Downloads are FREE. Search and download functionalities are using the official Maven repository.

package.web-types.json Maven / Gradle / Ivy

{
  "$schema": "https://json.schemastore.org/web-types",
  "name": "@vaadin/item",
  "version": "24.4.7",
  "description-markup": "markdown",
  "contributions": {
    "html": {
      "elements": [
        {
          "name": "vaadin-item",
          "description": "`` is a Web Component providing layout for items in tabs and menus.\n\n```\n  \n    Item content\n  \n```\n\n### Selectable\n\n`` has the `selected` property and the corresponding state attribute.\nCurrently, the component sets the `selected` to false, when `disabled` property is set to true.\nBut other than that, the `` does not switch selection by itself.\nIn general, it is the wrapper component, like ``, which should update\nthe `selected` property on the items, e. g. on mousedown or when Enter / Spacebar is pressed.\n\n### Styling\n\nThe following shadow DOM parts are available for styling:\n\nPart name    | Description\n-------------|----------------\n`checkmark`  | The graphical checkmark shown for a selected item\n`content`    | The element that wraps the slot\n\nThe following state attributes are available for styling:\n\nAttribute    | Description\n-------------|-------------\n`active`     | Set when the item is pressed down, either with mouse, touch or the keyboard.\n`disabled`   | Set when the item is disabled.\n`focus-ring` | Set when the item is focused using the keyboard.\n`focused`    | Set when the item is focused.\n`selected`   | Set when the item is selected\n\nSee [Styling Components](https://vaadin.com/docs/latest/styling/styling-components) documentation.",
          "attributes": [
            {
              "name": "disabled",
              "description": "If true, the user cannot interact with this element.",
              "value": {
                "type": [
                  "boolean",
                  "null",
                  "undefined"
                ]
              }
            },
            {
              "name": "selected",
              "description": "If true, the item is in selected state.",
              "value": {
                "type": [
                  "boolean"
                ]
              }
            },
            {
              "name": "theme",
              "description": "The theme variants to apply to the component.",
              "value": {
                "type": [
                  "string",
                  "null",
                  "undefined"
                ]
              }
            }
          ],
          "js": {
            "properties": [
              {
                "name": "disabled",
                "description": "If true, the user cannot interact with this element.",
                "value": {
                  "type": [
                    "boolean",
                    "null",
                    "undefined"
                  ]
                }
              },
              {
                "name": "value",
                "description": "Submittable string value. The default value is the trimmed text content of the element.",
                "value": {
                  "type": [
                    "string"
                  ]
                }
              },
              {
                "name": "selected",
                "description": "If true, the item is in selected state.",
                "value": {
                  "type": [
                    "boolean"
                  ]
                }
              },
              {
                "name": "label",
                "description": "String that can be set to visually represent the selected item in `vaadin-select`.",
                "value": {
                  "type": [
                    "string"
                  ]
                }
              }
            ],
            "events": []
          }
        }
      ]
    }
  }
}




© 2015 - 2024 Weber Informatics LLC | Privacy Policy