packages/api-generator/src/locale/en/VTreeview.json - master - githubmirror/vuetify

packages/api-generator/src/locale/en/VTreeview.json
44 строки3 KB
Rambaud Pierrick
docs: add description to all the component in the web-types (#22563)
22 апр 2026, 19:19
22 апр 2026, 19:1901b0a53
{
  "description": "Useful for displaying nested uniform data.",
  "props": {
    "activatable": "Allows user to mark a node as active by clicking on it.",
    "color": "Applies specified color to the active node - supports utility colors (for example `success` or `purple`) or css color (`#033` or `rgba(255, 0, 0, 0.5)`). Find a list of built-in classes on the [colors page](/styles/colors#material-colors).",
    "disabled": "Disables selection for all nodes.",
    "expandIcon": "Icon used to indicate that a node can be expanded.",
    "fluid": "Removes indentation from nested items.",
    "hideActions": "Hide the expand icon and loading indicator next to each item title.",
    "indeterminateIcon": "Icon used when node is in an indeterminate state. Only visible when `selectable` is `true`.",
    "itemChildren": "Property on supplied `items` that contains its children.",
    "items": "An array of items used to build the treeview.",
    "loadChildren": "A function used when dynamically loading children. If this prop is set, then the supplied function will be run if expanding an item that has a `item-children` property that is an empty array. Supports returning a Promise.",
    "loadingIcon": "Icon used when node is in a loading state.",
    "modelValue": "Allows one to control which nodes are selected. The array contains the values of currently selected items. It is equivalent to the `v-model:selected`",
    "openAll": "When `true` will cause all branch nodes to be opened when component is mounted.",
    "openOnClick": "When `true` will cause nodes to be opened by clicking anywhere on it, instead of only opening by clicking on expand icon. When using this prop with `activatable` you will be unable to mark nodes with children as active.",
    "returnObject": "When `true` will make `v-model`, `v-model:selected, `v-model:activated` and `v-model:opened` return the complete object instead of just the key.",
    "rounded": "Provides an alternative active style for `v-treeview` node. Only visible when `activatable` is `true` and should not be used in conjunction with the `shaped` prop.",
    "search": "The search model for filtering results.",
    "selectable": "Will render a checkbox next to each node allowing them to be selected. Additionally, the **[openOnClick](/api/v-treeview/#props-open-on-click)** property will be applied internally.",
    "selectedColor": "The color of the selection checkbox.",
    "separateRoots": "Applies to `default` variant of `indent-lines`. Prevents showing lines between root-level nodes.",
    "indentLines": "Controls visibility and variant of the indent lines.",
    "indentLinesColor": "Sets color of indent lines",
    "indentLinesOpacity": "Sets opacity of indent lines",
    "collapseIcon": "Icon to display when the list item is expanded."
  },
  "slots": {
    "append": "Appends content after label.",
    "prepend": "Prepends content before label.",
    "header": "Slot for expandable nodes (all items that are not leafs).",
    "footer": "Slot for footer below expanded children.",
    "subheader": "Slot for custom subheader.",
    "divider": "Slot for custom divider."
  },
  "events": {
    "click:open": "Emits the item when it is clicked to open.",
    "click:select": "Emits the item when it is clicked to select.",
    "update:activated": "Emits the array of active items when this value changes.",
    "update:opened": "Emits the array of open items when this value changes.",
    "update:selected": "Emits the array of selected items when this value changes."
  }
}