Descriptions
Responsive label/value details with optional row actions and semantic colors.
Live TypeScript example
Try the component here, then use the source below in your application.
- JavaScript
- 2.8 KiB
- Component CSS
- 0.8 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 6.4 KiB; component CSS 2.3 KiB. These figures describe browser assets, not the complete package download.
View all component measurements →Interact with the Descriptions example. The code below shows its actual inputs and callbacks.
import '@blukavantui/web/theme.css'
import {createDescriptions} from '@blukavantui/web/descriptions';
import '@blukavantui/web/descriptions.css';
export function mount(host: HTMLElement) {
return createDescriptions(host, {
"Title": "Account details",
"Columns": 2,
"IsBordered": true,
"Items": [
{
"Key": "name",
"Label": "Customer",
"Value": "Jordan Lee"
},
{
"Key": "account",
"Label": "Account",
"Value": "BLU-1042"
},
{
"Key": "email",
"Label": "Email address",
"Value": "jordan@example.com"
},
{
"Key": "status",
"Label": "Status",
"Value": "Active",
"Color": "Success"
},
{
"Key": "plan",
"Label": "Plan",
"Value": "Business · Annual",
"ActionLabel": "Manage plan"
},
{
"Key": "renewal",
"Label": "Next renewal",
"Value": "October 11, 2027"
},
{
"Key": "notes",
"Label": "Notes",
"Value": "Priority support and shared team workspaces are included.",
"Span": 2
}
]
}, { ItemClick: key => { host.dataset.detail = key; } });
}
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.
createDescriptions
Pass options as the second argument and callbacks in the third argument. Keep the returned instance to update options or dispose it when its view is removed.
import { createDescriptions } from '@blukavantui/web/descriptions';
import '@blukavantui/web/descriptions.css';Load @blukavantui/web/theme.css once in your app shell.createDescriptions(host: HTMLElement, options: T.DescriptionsOptions, events?: T.DescriptionsEvents)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
6| Name | Type / requirement | Usage |
|---|---|---|
Items | BluDescriptionItem[]Required | Ordered label/value records with stable keys. |
Title | stringOptional | Optional section heading. |
Columns | numberOptional | Requested columns, 1–3; narrow screens collapse automatically. |
IsBordered | booleanOptional | Shows cell borders and tinted labels. |
EmptyText | stringOptional | Message for an empty list. |
ExtendedClass | stringOptional | Additional CSS classes on the component root. |
Callbacks
2| Name | Type / requirement | Usage |
|---|---|---|
ItemClick | (key: string) => unknownOptional | |
Error | (message: string) => unknownOptional |
Instance methods & properties
3| Name | Signature / type | Usage |
|---|---|---|
element | HTMLElement | Root owned by this instance. Dispose before removing its host. |
update | (patch: Partial<T.DescriptionsOptions>) => 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.
BluDescriptionItem
interface BluDescriptionItem {
/** Unique detail identifier. */
Key: string;
/** Field caption. */
Label: string;
/** Display value, rendered as text. */
Value: string;
/** Number of columns occupied (1–3). */
Span?: number;
/** Shared ComponentColor code for the value. */
Color?: string;
/** Optional action caption; emits OnItemClick. */
ActionLabel?: 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
Responsive label/value details with optional row actions and semantic colors.
Keyboard design guidance
Labels and values use a semantic definition list. Optional item actions are keyboard accessible.
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.