tabspackage.web-types.json Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of vaadin-webcomponents Show documentation
Show all versions of vaadin-webcomponents Show documentation
Mvnpm composite: Vaadin webcomponents
The newest version!
{
"$schema": "https://json.schemastore.org/web-types",
"name": "@vaadin/tabs",
"version": "24.5.3",
"description-markup": "markdown",
"contributions": {
"html": {
"elements": [
{
"name": "vaadin-tab",
"description": "`` is a Web Component providing an accessible and customizable tab.\n\n```\n \n Tab 1\n \n```\n\nThe following state attributes are available for styling:\n\nAttribute | Description | Part name\n-----------|-------------|------------\n`disabled` | Set to a disabled tab | :host\n`focused` | Set when the element is focused | :host\n`focus-ring` | Set when the element is keyboard focused | :host\n`selected` | Set when the tab is selected | :host\n`active` | Set when mousedown or enter/spacebar pressed | :host\n`orientation` | Set to `horizontal` or `vertical` depending on the direction of items | :host\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": "",
"value": {
"type": [
"string"
]
}
},
{
"name": "selected",
"description": "If true, the item is in selected state.",
"value": {
"type": [
"boolean"
]
}
}
],
"events": []
}
},
{
"name": "vaadin-tabs",
"description": "`` is a Web Component for organizing and grouping content into sections.\n\n```\n \n Page 1 \n Page 2 \n Page 3 \n Page 4 \n \n```\n\n### Styling\n\nThe following shadow DOM parts are available for styling:\n\nPart name | Description\n------------------|--------------------------------------\n`back-button` | Button for moving the scroll back\n`tabs` | The tabs container\n`forward-button` | Button for moving the scroll forward\n\nThe following state attributes are available for styling:\n\nAttribute | Description | Part name\n-----------|-------------|------------\n`orientation` | Tabs disposition, valid values are `horizontal` and `vertical`. | :host\n`overflow` | It's set to `start`, `end`, none or both. | :host\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.\nWhen the element is disabled, the selected item is\nnot updated when `selected` property is changed.",
"value": {
"type": [
"boolean",
"null",
"undefined"
]
}
},
{
"name": "selected",
"description": "The index of the selected tab.",
"value": {
"type": [
"number",
"null",
"undefined"
]
}
},
{
"name": "orientation",
"description": "Set tabs disposition. Possible values are `horizontal|vertical`",
"value": {
"type": [
"TabsOrientation"
]
}
},
{
"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.\nWhen the element is disabled, the selected item is\nnot updated when `selected` property is changed.",
"value": {
"type": [
"boolean",
"null",
"undefined"
]
}
},
{
"name": "selected",
"description": "The index of the selected tab.",
"value": {
"type": [
"number",
"null",
"undefined"
]
}
},
{
"name": "orientation",
"description": "Set tabs disposition. Possible values are `horizontal|vertical`",
"value": {
"type": [
"TabsOrientation"
]
}
}
],
"events": [
{
"name": "selected-changed",
"description": "Fired when the selection is changed.\nNot fired when used in `multiple` selection mode."
},
{
"name": "items-changed",
"description": "Fired when the `items` property changes."
}
]
}
}
]
}
}
}