PropertyList

Responsive key-value details for product records.

Preview

A live, theme-aware example rendered with the published component.

Loading preview…

Import

Import the component from its dedicated entry point to keep the dependency and generated bundle explicit.

TSX

tsximport { PropertyList } from "@tavojs/ui/property-list";

Normal Tavo.js applications load component styles through the Tavo.js UI plugin. If the application manages component CSS manually, also import @tavojs/ui/css/property-list.

When to use

Use it when

Use `PropertyList` for responsive key-value records

Choose something else when

Avoid PropertyList when using data components as decorative layout containers.

Examples

PropertyList example

TSX

tsximport { PropertyList } from "@tavojs/ui/property-list";
import { PropertyItem } from "@tavojs/ui";

export function PropertyListExample1() {
  return (
    <>
      <PropertyList>
        <PropertyItem label="Owner">Design Team</PropertyItem>
      </PropertyList>
    </>
  );
}

Common props and defaults

Prop	Type	Default	Description
`className`	`string`	—	Optional class hook applied to the public root element owned by the component.
`divided`	`boolean`	—	Configures divided for this component.
`PropertyItem.label`	`string`	Required	Configures PropertyItem.label for this component.
`PropertyItem.value`	`Child`	—	Configures PropertyItem.value for this component.

Complete TypeScript API

Import from @tavojs/ui/property-list. Published exports: PropertyItem, PropertyItemProps, PropertyList, PropertyListProps.

`PropertyListProps`

Property	Type	Required	Description
`children`	`Child`	No	Inherited children attribute accepted by PropertyList.
`className`	`string`	No	Optional class hook applied to the public root element owned by the component.
`sx`	`Sx`	No	Inherited sx attribute accepted by PropertyList.
`id`	`string`	No	Inherited id attribute accepted by PropertyList.
`role`	`string`	No	Inherited role attribute accepted by PropertyList.
`style`	`Record<string, unknown>`	No	Inherited style attribute accepted by PropertyList.
`title`	`string`	No	Inherited title attribute accepted by PropertyList.
`tabIndex`	`number`	No	Inherited tabIndex attribute accepted by PropertyList.
`hidden`	`boolean`	No	Inherited hidden attribute accepted by PropertyList.
`disabled`	`boolean`	No	Inherited disabled attribute accepted by PropertyList.
`onClick`	`TavoEventHandler<MouseEvent>`	No	Inherited onClick attribute accepted by PropertyList.
`onChange`	`TavoEventHandler<Event>`	No	Inherited onChange attribute accepted by PropertyList.
`onInput`	`TavoEventHandler<Event>`	No	Inherited onInput attribute accepted by PropertyList.
`onKeyDown`	`TavoEventHandler<KeyboardEvent>`	No	Inherited onKeyDown attribute accepted by PropertyList.
`onFocus`	`TavoEventHandler<FocusEvent>`	No	Inherited onFocus attribute accepted by PropertyList.
`onBlur`	`TavoEventHandler<FocusEvent>`	No	Inherited onBlur attribute accepted by PropertyList.
`divided`	`boolean`	No	Configures divided for this component.

`PropertyItemProps`

Property	Type	Required	Description
`children`	`Child`	No	Inherited children attribute accepted by PropertyList.
`className`	`string`	No	Optional class hook applied to the public root element owned by the component.
`sx`	`Sx`	No	Inherited sx attribute accepted by PropertyList.
`id`	`string`	No	Inherited id attribute accepted by PropertyList.
`role`	`string`	No	Inherited role attribute accepted by PropertyList.
`style`	`Record<string, unknown>`	No	Inherited style attribute accepted by PropertyList.
`title`	`string`	No	Inherited title attribute accepted by PropertyList.
`tabIndex`	`number`	No	Inherited tabIndex attribute accepted by PropertyList.
`hidden`	`boolean`	No	Inherited hidden attribute accepted by PropertyList.
`disabled`	`boolean`	No	Inherited disabled attribute accepted by PropertyList.
`onClick`	`TavoEventHandler<MouseEvent>`	No	Inherited onClick attribute accepted by PropertyList.
`onChange`	`TavoEventHandler<Event>`	No	Inherited onChange attribute accepted by PropertyList.
`onInput`	`TavoEventHandler<Event>`	No	Inherited onInput attribute accepted by PropertyList.
`onKeyDown`	`TavoEventHandler<KeyboardEvent>`	No	Inherited onKeyDown attribute accepted by PropertyList.
`onFocus`	`TavoEventHandler<FocusEvent>`	No	Inherited onFocus attribute accepted by PropertyList.
`onBlur`	`TavoEventHandler<FocusEvent>`	No	Inherited onBlur attribute accepted by PropertyList.
`label`	`string`	Yes	Inherited label attribute accepted by PropertyList.
`value`	`import("/Users/hrach/Documents/Projects/Codex/tavo-ui-monorepo/node_modules/@tavojs/core/dist/jsx").Child`	No	Inherited value attribute accepted by PropertyList.

State ownership and DOM target

Concern	Contract
State	No component state contract is exposed; the application owns the rendered content and surrounding behavior.
DOM target	Public passthrough props target the component root. Treat nested elements and private class names as implementation details.

Anatomy and related components

This component exposes one public component root rather than a compound member API.

Limitations

Avoid PropertyList when using data components as decorative layout containers.

Use only the documented props, entry points, and compound members. Internal DOM nesting and CSS class names can change without becoming part of the public component contract.

Accessibility

Data components should preserve readable order and expose labels for non-textual values.

Use captions or nearby headings for tables and charts.
Do not rely on color alone for status.
Keep values and labels available as text.

Component status

Contract	Current value
Maturity	stable
Category	data
Component import	`@tavojs/ui/property-list`
Explicit CSS import	`@tavojs/ui/css/property-list`
Preview	Interactive preview available on this page