ModuleHeader API
API reference docs for the Stash ModuleHeader component. Learn about the props, CSS, and other APIs of this exported module.
Import
ts
import ModuleHeader from '@leaflink/stash/ModuleHeader.vue';Props
| Name | Type | Default | Description |
|---|---|---|---|
| description | string | '' | Header description, aka subtitle. Will get overridden by the `description` slot if provided. |
| preventActionsWrap | boolean | false | Stop the actions slot from force-wrapping on medium and smalls screens. |
| size | "small" | "medium" | "large" | medium | Size of the header. - `small` = `h4` - `medium` = `h3` - `large` = `h2` |
| title | string | '' | Header title. Will get overridden by the `title` slot if provided. |
| underline | boolean | false | Displays a border at the bottom |
Slots
| Name | Description |
|---|---|
| media | Place an illustration that sits next to the header title & description. |
| title | Header title. **Deprecated**: Use the default slot or the `title` prop instead. |
| default | Header title. |
| description | Header description, aka subtitle. Falls back to the `description` prop. |
| actions | Add action buttons or other CTAs. |
Events
None