KDescriptions

Display multiple fields in list form.

Install

pnpm

pnpm add @ikun-ui/descriptions @ikun-ui/descriptions-item

yarn

yarn add @ikun-ui/descriptions @ikun-ui/descriptions-item

npm

npm install @ikun-ui/descriptions @ikun-ui/descriptions-item

Basic usage

UserInfo

Username

ikun svelte

Telephone

18868686868

Place

Zhengzhou

Remarks

Address

No.666, Jinshui District, Zhengzhou, Henan Province

Sizes

sm

md

lg

With border

Username

ikun svelte

Telephone

18868686868

Place

Zhengzhou

Remarks

Address

No.666, Jinshui District, Zhengzhou, Henan Province

Without border

Username

ikun svelte

Telephone

18868686868

Place

Zhengzhou

Remarks

Address

No.666, Jinshui District, Zhengzhou, Henan Province

Vertical

sm

md

lg

Vertical With border

Username

ikun svelte

Telephone

18868686868

Place

Zhengzhou

Remarks

Address

No.666, Jinshui District, Zhengzhou, Henan Province

Vertical Without border

Username

ikun svelte

Telephone

18868686868

Place

Zhengzhou

Remarks

Address

No.666, Jinshui District, Zhengzhou, Henan Province

Descriptions Props

Name	Type	Default	Description
title	string	''	title text, display on the top left
extra	string	''	extra text, display on the top right
border	boolean	false	with or without border
column	number	3	numbers of Descriptions Item in one line
direction	horizontal / vertical	horizontal	direction of descriptions
size	sm / md / lg	md	size of descriptions
cls	string	''	Additional class for component
attrs	Record<string, string>	{}	Additional attributes

Descriptions Slots

Name	Description
title	Customize title content
extra	Customize extra content
default	Customize default content

DescriptionsItem Props

Name	Type	Default	Description
label	string	''	label text
cls	string	''	Additional class for component
attrs	Record<string, string>	{}	Additional attributes

DescriptionsItem Slots

Name	Description
label	Customize label content
default	Customize default content