PageHeader
A clear page title, supporting context, and relevant actions.
Live TypeScript example
Try the component here, then use the source below in your application.
- JavaScript
- 0.9 KiB
- Component CSS
- 0.9 KiB
- Shared theme CSS
- 3.8 KiBonce per application
How sizes are measured
The JavaScript figure includes this component’s required helpers. CSS includes its styling dependencies. Each entry is bundled separately for ES2022, minified, then compressed with gzip level 9. Your bundler may share helpers across components. Images, fonts, examples and application code are excluded.
Before compression: JavaScript 2.0 KiB; component CSS 3.3 KiB. These figures describe browser assets, not the complete package download.
View all component measurements →Combine a page title, description, and application actions.
import '@blukavantui/web/theme.css'
import {createPageHeader} from '@blukavantui/web/page-header';
import '@blukavantui/web/page-header.css';
export function mount(host: HTMLElement) {
return createPageHeader(host, {
SectionLabel: "Workspace",
Title: "Customers",
Description: "A consistent title and context for each page.",
Breadcrumbs: [
{ Label: "Components", Url: "#button" },
{ Label: "Customers" },
],
});
}
const instance = mount(document.getElementById('example')!)
// When this page or framework component is removed:
// instance.destroy()
Install the library and add the host element
npm install https://blukavantui.blutekmedia.com/downloads/blukavantui-web-0.6.2.tgz<div id="example"></div>This example uses the downloadable @blukavantui/web package. Your application handles persistence and authentication through its typed callbacks. The starter ZIP includes this same example.
createPageHeader
Pass options as the second argument. Keep the returned instance to update options or dispose it when its view is removed.
import { createPageHeader } from '@blukavantui/web/page-header';
import '@blukavantui/web/page-header.css';Load @blukavantui/web/theme.css once in your app shell.createPageHeader(host: HTMLElement, options: PageHeaderOptions)Reference for @blukavantui/web 0.6.2. Required and optional follow the shipped TypeScript declarations; optional does not imply a particular default. Pass typed arrays and objects directly where shown.
Options
7| Name | Type / requirement | Usage |
|---|---|---|
Title | stringRequired | The displayed title. |
Description | stringOptional | Supporting text beneath the title. |
SectionLabel | stringOptional | |
HeadingLevel | 1 | 2 | 3Optional | Heading level to fit the surrounding document hierarchy. |
Actions | SlotOptional | Action slot: pass your own DOM node or text. |
Breadcrumbs | Breadcrumb[]Optional | |
ExtendedClass | stringOptional | Additional CSS class names on the component root. |
Instance methods & properties
3| Name | Signature / type | Usage |
|---|---|---|
element | HTMLElement | Root owned by this instance. Dispose before removing its host. |
update | (patch: Partial<PageHeaderOptions>) => void | Apply a partial options update to this instance. |
destroy | () => void | Dispose the instance and its listeners when the view is removed. |
Related data types
Expand a type for its fields and allowed values.
Breadcrumb
interface Breadcrumb {
Label: string;
Url?: string;
}CommonOptions
interface CommonOptions {
ExtendedClass?: string;
}Slot
type Slot = Node | string;Use these inputs, events, actions and structures in Service Studio. Names and data bindings are specific to the native Blocks.
Included in the planned free BluKavantUI Community edition. The official OutSystems Forge release is coming soon. View Community scope →
Open OutSystems showcase ↗- Web runtime
- Supported
- TypeScript
- Supported
- OutSystems
- Supported
Statuses describe the component’s rendered code and interactions. Supply accessible content and follow the component guidance when integrating it.
Accessibility guidance →Purpose and use
Use the page header to orient people before they act. Add a short description, a section label, and only actions that affect this page.
Keyboard design guidance
Use one main heading per page. Actions remain labelled and keyboard accessible. Breadcrumbs provide a separate navigation landmark.
See the support status above for review coverage and any limitations.
In your application
Provide useful labels, preserve visible focus, and test the component with your actual content. Use text alongside status colors and check contrast in each state.
Events0No events yet.
Interact with an example to see its events.