desy-html 16.0.4 → 17.0.0

package/src/templates/components/tree/params.tree.yaml

@@ -1,173 +1,173 @@
-params:
-- name: type
-  type: string
-  required: false
-  description: Type of input control to render. Admitted values are `navigation`, `checkbox` and `radio` or not set. Defaults to `radio`.
-- name: searchbar
-  type: component
-  required: false
-  description: A searchbar component to filter the items. Inherits all the searchbar component params.
-- name: lazyRendering
-  type: boolean
-  required: false
-  description: If true, the tree enables lazy rendering mode (doesn't paint children nodes until the user unfolds a parent). Defaults to false.
-- name: ariaLabel
-  type: text
-  required: false
-  description: aria-label for nav tag. Should be a description of tree type navigation.
-- name: hasUnderline
-  type: boolean
-  required: false
-  description: If `true`, all items will be underlined except the disabled ones or the ones that have no href.
-- name: describedBy
-  type: string
-  required: false
-  description: One or more element IDs to add to the input `aria-describedby` attribute without a fieldset, used to provide additional descriptive information for screenreader users.
-- name: fieldset
-  type: object
-  required: false
-  description: Options for the fieldset component (e.g. legend).
-  isComponent: true
-- name: hint
-  type: object
-  required: false
-  description: Options for the hint component (e.g. text).
-  isComponent: true
-- name: errorMessage
-  type: object
-  required: false
-  description: Options for the error message component. The error message component will not display if you use a falsy value for `errorMessage`, for example `false` or `null`.
-  isComponent: true
-- name: formGroup
-  type: object
-  required: false
-  description: Options for the form-group wrapper
-  params:
-  - name: classes
-    type: string
-    required: false
-    description: Classes to add to the form group (e.g. to show error state for the whole group)
-- name: idPrefix
-  type: string
-  required: false
-  description: String to prefix id for each item if no id is specified on each item.
-- name: name
-  type: string
-  required: true
-  description: Name attribute for all checkbox/radio items.
-- name: heading
-  type: object
-  required: true
-  description: Options for the heading
-  params:
-  - name: text
-    type: string
-    required: true
-    description: If `html` is set, this is not required. Text to use within the heading. If `html` is provided, the `text` argument will be ignored.
-  - name: html
-    type: string
-    required: true
-    description: If `text` is set, this is not required. HTML to use within the heading. If `html` is provided, the `text` argument will be ignored.
-  - name: classes
-    type: string
-    required: false
-    description: Classes to add to the heading.
-  - name: id
-    type: string
-    required: false
-    description: Specific id attribute for the component. If omitted, then idPrefix option will be applied.
-- name: headingLevel
-  type: number
-  required: false
-  description: If headingLevel is 1, the parent heading tag needed inside this component will be a h1, if 2 will be a h2, and so on.
-- name: items
-  type: array
-  required: true
-  description: Array of tree items objects.
-  params:
-  - name: text
-    type: string
-    required: true
-    description: If `html` is set, this is not required. Text to use within each tree item label. If `html` is provided, the `text` argument will be ignored.
-  - name: html
-    type: string
-    required: true
-    description: If `text` is set, this is not required. HTML to use within each tree item label. If `html` is provided, the `text` argument will be ignored.
-  - name: href
-    type: string
-    required: false
-    description: Item link in tree type navigation.
-  - name: id
-    type: string
-    required: false
-    description: Specific id attribute for the item. If omitted, then idPrefix option will be applied.
-  - name: name
-    type: string
-    required: true
-    description: Specific name for the checkbox/radio item. If omitted, then component global `name` string will be applied.
-  - name: value
-    type: string
-    required: true
-    description: Value for the checkbox/radio input.
-  - name: label
-    type: object
-    required: false
-    description: Provide attributes and classes to each checkbox/radio item label.
-    isComponent: true
-  - name: hint
-    type: object
-    required: false
-    description: Provide hint to each checkbox/radio item.
-    isComponent: true
-  - name: checked
-    type: boolean
-    required: false
-    description: If true, checkbox/radio will be checked.
-  - name: isIndeterminate
-    type: boolean
-    required: false
-    description: If true, the checkbox will have an additional indeterminate state to show a partial true. Only for checkbox item.
-  - name: indeterminateChecked
-    type: boolean
-    required: false
-    description: If true, the checkbox will have an indeterminate checked initial state. This will override isChecked value. Only for checkbox item.
-  - name: disabled
-    type: boolean
-    required: false
-    description: If true, tree will be disabled.
-  - name: classes
-    type: string
-    required: false
-    description: Classes to add to the item.
-  - name: attributes
-    type: object
-    required: false
-    description: HTML attributes (for example data attributes) to add to the item.
-  - name: expanded
-    type: boolean
-    required: false
-    description: If true, tree sub will be expanded.
-  - name: sub
-    type: boolean
-    required: false
-    description: If true, content provided will be revealed when the item is expanded.
-  - name: sub.classes
-    type: string
-    required: false
-    description: Classes to add to the sub container.
-  - name: sub.attributes
-    type: string
-    required: false
-    description: HTML attributes (for example data attributes) to add to the sub container.
-  - name: sub.items
-    type: array
-    required: false
-    description: Provide subitems for the sub reveal. Each items have same params as this item.
-- name: classes
-  type: string
-  required: false
-  description: Classes to add to the tree container.
-- name: attributes
-  type: object
-  required: false
-  description: HTML attributes (for example data attributes) to add to the tree container.
+params:
+- name: type
+  type: string
+  required: false
+  description: Type of input control to render. Admitted values are `navigation`, `checkbox` and `radio` or not set. Defaults to `radio`.
+- name: searchbar
+  type: component
+  required: false
+  description: A searchbar component to filter the items. Inherits all the searchbar component params.
+- name: lazyRendering
+  type: boolean
+  required: false
+  description: If true, the tree enables lazy rendering mode (doesn't paint children nodes until the user unfolds a parent). Defaults to false.
+- name: ariaLabel
+  type: text
+  required: false
+  description: aria-label for nav tag. Should be a description of tree type navigation.
+- name: hasUnderline
+  type: boolean
+  required: false
+  description: If `true`, all items will be underlined except the disabled ones or the ones that have no href.
+- name: describedBy
+  type: string
+  required: false
+  description: One or more element IDs to add to the input `aria-describedby` attribute without a fieldset, used to provide additional descriptive information for screenreader users.
+- name: fieldset
+  type: object
+  required: false
+  description: Options for the fieldset component (e.g. legend).
+  isComponent: true
+- name: hint
+  type: object
+  required: false
+  description: Options for the hint component (e.g. text).
+  isComponent: true
+- name: errorMessage
+  type: object
+  required: false
+  description: Options for the error message component. The error message component will not display if you use a falsy value for `errorMessage`, for example `false` or `null`.
+  isComponent: true
+- name: formGroup
+  type: object
+  required: false
+  description: Options for the form-group wrapper
+  params:
+  - name: classes
+    type: string
+    required: false
+    description: Classes to add to the form group (e.g. to show error state for the whole group)
+- name: idPrefix
+  type: string
+  required: false
+  description: String to prefix id for each item if no id is specified on each item.
+- name: name
+  type: string
+  required: true
+  description: Name attribute for all checkbox/radio items.
+- name: heading
+  type: object
+  required: true
+  description: Options for the heading
+  params:
+  - name: text
+    type: string
+    required: true
+    description: If `html` is set, this is not required. Text to use within the heading. If `html` is provided, the `text` argument will be ignored.
+  - name: html
+    type: string
+    required: true
+    description: If `text` is set, this is not required. HTML to use within the heading. If `html` is provided, the `text` argument will be ignored.
+  - name: classes
+    type: string
+    required: false
+    description: Classes to add to the heading.
+  - name: id
+    type: string
+    required: false
+    description: Specific id attribute for the component. If omitted, then idPrefix option will be applied.
+- name: headingLevel
+  type: number
+  required: false
+  description: If headingLevel is 1, the parent heading tag needed inside this component will be a h1, if 2 will be a h2, and so on.
+- name: items
+  type: array
+  required: true
+  description: Array of tree items objects.
+  params:
+  - name: text
+    type: string
+    required: true
+    description: If `html` is set, this is not required. Text to use within each tree item label. If `html` is provided, the `text` argument will be ignored.
+  - name: html
+    type: string
+    required: true
+    description: If `text` is set, this is not required. HTML to use within each tree item label. If `html` is provided, the `text` argument will be ignored.
+  - name: href
+    type: string
+    required: false
+    description: Item link in tree type navigation.
+  - name: id
+    type: string
+    required: false
+    description: Specific id attribute for the item. If omitted, then idPrefix option will be applied.
+  - name: name
+    type: string
+    required: true
+    description: Specific name for the checkbox/radio item. If omitted, then component global `name` string will be applied.
+  - name: value
+    type: string
+    required: true
+    description: Value for the checkbox/radio input.
+  - name: label
+    type: object
+    required: false
+    description: Provide attributes and classes to each checkbox/radio item label.
+    isComponent: true
+  - name: hint
+    type: object
+    required: false
+    description: Provide hint to each checkbox/radio item.
+    isComponent: true
+  - name: checked
+    type: boolean
+    required: false
+    description: If true, checkbox/radio will be checked.
+  - name: isIndeterminate
+    type: boolean
+    required: false
+    description: If true, the checkbox will have an additional indeterminate state to show a partial true. Only for checkbox item.
+  - name: indeterminateChecked
+    type: boolean
+    required: false
+    description: If true, the checkbox will have an indeterminate checked initial state. This will override isChecked value. Only for checkbox item.
+  - name: disabled
+    type: boolean
+    required: false
+    description: If true, tree will be disabled.
+  - name: classes
+    type: string
+    required: false
+    description: Classes to add to the item.
+  - name: attributes
+    type: object
+    required: false
+    description: HTML attributes (for example data attributes) to add to the item.
+  - name: expanded
+    type: boolean
+    required: false
+    description: If true, tree sub will be expanded.
+  - name: sub
+    type: boolean
+    required: false
+    description: If true, content provided will be revealed when the item is expanded.
+  - name: sub.classes
+    type: string
+    required: false
+    description: Classes to add to the sub container.
+  - name: sub.attributes
+    type: string
+    required: false
+    description: HTML attributes (for example data attributes) to add to the sub container.
+  - name: sub.items
+    type: array
+    required: false
+    description: Provide subitems for the sub reveal. Each items have same params as this item.
+- name: classes
+  type: string
+  required: false
+  description: Classes to add to the tree container.
+- name: attributes
+  type: object
+  required: false
+  description: HTML attributes (for example data attributes) to add to the tree container.