# kol-nav

<!-- Auto Generated Below -->


## Properties

| Property                | Attribute                  | Description                                                                                                                                                                                                                      | Type                                              | Default      |
| ----------------------- | -------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------- | ------------ |
| `_collapsible`          | `_collapsible`             | Defines if navigation nodes can be collapsed or not. Enabled by default.                                                                                                                                                         | `boolean \| undefined`                            | `true`       |
| `_hasCompactButton`     | `_has-compact-button`      | Creates a button below the navigation, that toggles _collapsible. Only available for _orientation="vertical".                                                                                                                    | `boolean \| undefined`                            | `false`      |
| `_hasIconsWhenExpanded` | `_has-icons-when-expanded` | Shows icons next to the navigation item labels, even when the navigation is not collapsed.                                                                                                                                       | `boolean \| undefined`                            | `false`      |
| `_hideLabel`            | `_hide-label`              | Hides the caption by default and displays the caption text with a tooltip when the interactive element is focused or the mouse is over it.                                                                                       | `boolean \| undefined`                            | `false`      |
| `_label` _(required)_   | `_label`                   | Defines the visible or semantic label of the component (e.g. aria-label, label, headline, caption, summary, etc.).                                                                                                               | `string`                                          | `undefined`  |
| `_links` _(required)_   | `_links`                   | Defines the list of links, buttons or texts to render.                                                                                                                                                                           | `ButtonOrLinkOrTextWithChildrenProps[] \| string` | `undefined`  |
| `_orientation`          | `_orientation`             | <span class="text-red-500">**[DEPRECATED]**</span> Will be removed in the next major version. The navigation defaults to vertical orientation.<br/><br/>Defines whether the orientation of the component is horizontal or vertical. | `"horizontal" \| "vertical" \| undefined`         | `'vertical'` |


----------------------------------------------


