Skip to content

KLayout

Handling the overall layout of a page.

Install

bash
pnpm add @ikun-ui/layout
bash
yarn add @ikun-ui/layout
bash
npm install @ikun-ui/layout

Basic usage

KLayout consists of 5 components, namely KContainer, KMain, KFooter, KAside, and KHeader.

Some common combination examples are given below

KContainer Props

NameTypeDefaultDescription
directionvertical | horizontal-vertical when nested with KHeader or KFooter; horizontal otherwise
clsstring'-'Additional class for component
attrsRecord<string, string>{}Additional attributes

KContainer Slots

NameDescription
headerCustomize header content, Please pass in the KHeader component
defaultCustomize default content
footerCustomize footer content, Please pass in the KFooter component

KMain Props

NameTypeDefaultDescription
clsstring'-'Additional class for component
attrsRecord<string, string>{}Additional attributes

KMain Slots

NameDescription
defaultCustomize default content

KFooter Props

NameTypeDefaultDescription
heigthstring'-'Heigth of footer
clsstring'-'Additional class for component
attrsRecord<string, string>{}Additional attributes

KFooter Slots

NameDescription
defaultCustomize default content

KHeader Props

NameTypeDefaultDescription
heigthstring'-'Heigth of header
clsstring'-'Additional class for component
attrsRecord<string, string>{}Additional attributes

KHeader Slots

NameDescription
defaultCustomize default content

KAside Props

NameTypeDefaultDescription
widthstring'-'Width of aside
clsstring'-'Additional class for component
attrsRecord<string, string>{}Additional attributes

KAside Slots

NameDescription
defaultCustomize default content

MIT Licensed