Description lists
Communicate structured metadata as semantic term-value pairs.
Live preview
- Project
- Northstar Studio
- Status
- Active
- Region
- India
- Visibility
- Private
HTML
<dl class="xsh-descriptions">
<div>
<dt>Project</dt>
<dd>Northstar Studio</dd>
</div>
<div>
<dt>Status</dt>
<dd>
<span class="xsh-badge xsh-badge--success">Active</span>
</dd>
</div>
<div>
<dt>Region</dt>
<dd>India</dd>
</div>
<div>
<dt>Visibility</dt>
<dd>Private</dd>
</div>
</dl>Installation & markup
Include the local stylesheet and script once on the page, then place the component inside a data-xsh-ui root. The example above works without a build system.
<link rel="stylesheet" href="/dist/xshna-ui.css">
<div data-xsh-ui>
<!-- Add the HTML example above -->
</div>
<script defer src="/dist/xshna-ui.js"></script>Component API
Public classes, attributes and hooks used by this example. Keep the xsh- prefix intact.
| Identifier | Contract |
|---|---|
xsh-descriptions | Used by the example markup and component styles or behavior. |
dl | Used by the example markup and component styles or behavior. |
dt | Used by the example markup and component styles or behavior. |
dd | Used by the example markup and component styles or behavior. |
Accessibility & keyboard
Description-list semantics expose the relationship between terms and values.
Implementation note. Use tables for comparable rows and descriptions for individual record details.
Interaction contract
Behavioral components use the shared delegated runtime; visual-only primitives rely on semantic HTML and CSS. Runtime controls emit bubbling xsh:* CustomEvents; bind application handlers to those events when server persistence, API data or navigation is required.