Banner
Installation
npx shadcn@latest add https://ui.timkit.cn/r/banner.json
Usage
import { Banner } from "@/components/ui/banner"
Examples
Structured API
Component
banner
Logic
none
Runtime Frameworks
ReactVueWeappHTML
Supported Platforms
WebWeChat Mini Program
Configuration
| Prop | Type | Default | Description |
|---|---|---|---|
| logic.provider* | enum (zag | native | none) | none | State and interaction provider used by this component. |
| logic.machine | string | - | Underlying state machine identifier when provider is zag. |
| platforms* | array | Web, WeChat Mini Program | Platforms officially supported by this schema. |
| frameworks* | array | React, Vue, Weapp, HTML | Framework demos/code currently available in registry files. |
| dependencies | array | @timui/core | Runtime package dependencies required by this registry item. |
| optionalPeerDependencies | array | - | Optional peer dependencies used by this registry item. |
| registryDependencies | array | - | Dependent Timkit registry components/hook entries. |
Props
| Prop | Type | Default | Description |
|---|---|---|---|
| variant | enum (default | success | warning | destructive) | default | Visual style of the banner message. |
| dismissible | boolean | false | Whether the banner can be dismissed by the user. |
Events
| Prop | Type | Default | Description |
|---|---|---|---|
| onClose | event | - | Callback fired when the banner is dismissed. |
Slots
| Prop | Type | Default | Description |
|---|---|---|---|
| default | slot | - | The banner segments |
Parts
| Prop | Type | Default | Description |
|---|---|---|---|
| root* | root | - | The banner container |
| content | part | - | The content wrapper |
| icon | part | - | The icon section |
| title | part | - | The banner title |
| description | part | - | The banner description |
| actions | part | - | The actions section |
This API reference is generated from `/packages/core` component schemas to keep React/Vue/Weapp docs consistent.
Extended notes are not available for this component yet.
On This Page
Banner
Installation
npx shadcn@latest add https://ui.timkit.cn/r/banner.json
Usage
import { Banner } from "@/components/ui/banner"
Examples
Structured API
Component
banner
Logic
none
Runtime Frameworks
ReactVueWeappHTML
Supported Platforms
WebWeChat Mini Program
Configuration
| Prop | Type | Default | Description |
|---|---|---|---|
| logic.provider* | enum (zag | native | none) | none | State and interaction provider used by this component. |
| logic.machine | string | - | Underlying state machine identifier when provider is zag. |
| platforms* | array | Web, WeChat Mini Program | Platforms officially supported by this schema. |
| frameworks* | array | React, Vue, Weapp, HTML | Framework demos/code currently available in registry files. |
| dependencies | array | @timui/core | Runtime package dependencies required by this registry item. |
| optionalPeerDependencies | array | - | Optional peer dependencies used by this registry item. |
| registryDependencies | array | - | Dependent Timkit registry components/hook entries. |
Props
| Prop | Type | Default | Description |
|---|---|---|---|
| variant | enum (default | success | warning | destructive) | default | Visual style of the banner message. |
| dismissible | boolean | false | Whether the banner can be dismissed by the user. |
Events
| Prop | Type | Default | Description |
|---|---|---|---|
| onClose | event | - | Callback fired when the banner is dismissed. |
Slots
| Prop | Type | Default | Description |
|---|---|---|---|
| default | slot | - | The banner segments |
Parts
| Prop | Type | Default | Description |
|---|---|---|---|
| root* | root | - | The banner container |
| content | part | - | The content wrapper |
| icon | part | - | The icon section |
| title | part | - | The banner title |
| description | part | - | The banner description |
| actions | part | - | The actions section |
This API reference is generated from `/packages/core` component schemas to keep React/Vue/Weapp docs consistent.
Extended notes are not available for this component yet.
On This Page