Components Reference
Complete reference for all available components with detailed specifications, properties, and examples.
Text Components
Section titled “Text Components”Heading
Section titled “Heading”Large, bold text for page titles and section headers.
Properties:
text(string): The heading text
Example:
component Heading text: "Dashboard"component Heading text: "User Management"Rendering: Bold text at 24-28px font size
Standard body text for content and descriptions.
Properties:
content(string): The text content
Example:
component Text content: "This is body text"component Text content: "User profile information goes here"Rendering: Regular text at 14-16px font size
Small, often bold text used for form field labels.
Properties:
text(string): Label text
Example:
component Label text: "Email Address"component Label text: "Password"Rendering: Small bold text at 12-14px font size
Input Components
Section titled “Input Components”Single-line text input field.
Properties:
label(string): Field labelplaceholder(string): Placeholder text
Example:
component Input label: "Email" placeholder: "you@example.com"component Input label: "Search" placeholder: "Type to search..."Rendering: Rectangular input box with border and optional label above
Textarea
Section titled “Textarea”Multi-line text input field.
Properties:
label(string): Field labelplaceholder(string): Placeholder textrows(number): Number of visible rows (default: 4)
Example:
component Textarea label: "Comments" rows: 5component Textarea label: "Message" placeholder: "Type your message here" rows: 3Rendering: Tall rectangular input box with scrolling capability
Select
Section titled “Select”Dropdown selection field.
Properties:
label(string): Field labelitems(string, CSV): Comma-separated list of options
Example:
component Select label: "Role" items: "Admin,User,Guest"component Select label: "Status" items: "Active,Inactive,Pending"Rendering: Dropdown button with list of options
Checkbox
Section titled “Checkbox”Boolean checkbox input.
Properties:
label(string): Checkbox labelchecked(boolean, optional): Whether checkbox is checked (default: false)
Example:
component Checkbox label: "I agree to terms" checked: truecomponent Checkbox label: "Subscribe to newsletter"component Checkbox label: "Remember me" checked: falseRendering: Small square checkbox with label text
Single-select radio button (typically used in groups).
Properties:
label(string): Radio button labelchecked(boolean, optional): Whether radio is selected (default: false)
Example:
component Radio label: "Option A" checked: truecomponent Radio label: "Option B"component Radio label: "Personal" checked: falseRendering: Circular radio button with label text
Toggle
Section titled “Toggle”Boolean toggle switch.
Properties:
label(string): Toggle labelenabled(boolean, optional): Whether toggle is enabled (default: false)
Example:
component Toggle label: "Dark Mode" enabled: truecomponent Toggle label: "Enable notifications"component Toggle label: "Auto-save" enabled: falseRendering: Sliding toggle switch with label
Button Components
Section titled “Button Components”Button
Section titled “Button”Clickable action button.
Properties:
text(string): Button labelvariant(string): Visual style -primary|secondary|ghost(default:secondary)
Variants:
primary: Prominent filled button (usually blue)secondary: Medium emphasis button (gray)ghost: Low emphasis button (outline only)
Example:
component Button text: "Save" variant: primarycomponent Button text: "Cancel" variant: secondarycomponent Button text: "Learn More" variant: ghostRendering: Rectangular button with text, styled according to variant
IconButton
Section titled “IconButton”Button with icon instead of text.
Properties:
icon(string): Icon name (e.g., “search”, “menu”, “close”)
Example:
component IconButton icon: "search"component IconButton icon: "menu"component IconButton icon: "settings"Rendering: Square button containing icon symbol
Navigation Components
Section titled “Navigation Components”Topbar
Section titled “Topbar”Top navigation bar/header.
Properties:
title(string): Main titlesubtitle(string, optional): Secondary subtitleuser(string, optional): User name or identifier for badgeactions(string, optional): Action items (comma-separated)
Example:
component Topbar title: "Dashboard"component Topbar title: "Dashboard" subtitle: "Welcome back"component Topbar title: "Settings" user: "john_doe"component Topbar title: "Admin" actions: "Help,Logout"Rendering: Horizontal bar at top of screen with logo/title and optional user menu
SidebarMenu
Section titled “SidebarMenu”Vertical menu for navigation.
Properties:
items(string, CSV): Menu item labelsactive(number): Index of active item (default: 0)
Example:
component SidebarMenu items: "Home,Users,Settings,Help" active: 0component SidebarMenu items: "Dashboard,Analytics,Reports,Admin" active: 1Rendering: Vertical list of menu items, with one highlighted as active
Sidebar
Section titled “Sidebar”Side navigation panel.
Properties:
title(string): Sidebar titleitems(string, CSV): Navigation item labels
Example:
component Sidebar title: "Navigation" items: "Home,Profile,Settings"component Sidebar title: "Dashboard" items: "Overview,Users,Reports,Logs"Rendering: Vertical panel with title and navigation items
Breadcrumbs
Section titled “Breadcrumbs”Navigation hierarchy showing current page location.
Properties:
items(string, CSV): Breadcrumb labels (required)separator(string, optional): Separator character between items (default: ”/”)
Example:
component Breadcrumbs items: "Home,Users,Detail"component Breadcrumbs items: "Dashboard,Products,Electronics,Laptops" separator: ">"component Breadcrumbs items: "Admin,Settings,Preferences" separator: " > "Rendering: Horizontal path showing navigation hierarchy
Tabbed interface with multiple panels.
Properties:
items(string, CSV): Tab labelsactiveIndex(number): Index of active tab (default: 0)
Example:
component Tabs items: "Overview,Details,Comments" activeIndex: 0component Tabs items: "Profile,Settings,Privacy,Security" activeIndex: 1Rendering: Horizontal tabs with one highlighted as active
Data Components
Section titled “Data Components”Data table with rows and columns.
Properties:
columns(string, CSV): Column headers (required)rows(number): Number of mock rows to display (default: 5)
Example:
component Table columns: "Name,Email,Status" rows: 8component Table columns: "ID,Name,Email,Role" rows: 10component Table columns: "Date,Amount,Status,Notes" rows: 15Rendering: Grid table with header row and mock data rows
Simple list of items.
Properties:
items(string, CSV): List item labelstitle(string, optional): List title/headeritemsMock(number, optional): Number of mock items to generate
Example:
component List items: "JavaScript,TypeScript,Python,Java"component List items: "Feature 1,Feature 2,Feature 3,Feature 4"component List title: "Recent Activity" items: "Login,Purchase,Invite,Export"Rendering: Vertical list with bullet points or numbers
Media Components
Section titled “Media Components”Placeholder for image content.
Properties:
placeholder(string): Shape -square|landscape|portrait|avatar|circleheight(number, optional): Height in pixels (default: 200)src(string, optional): Image source URL
Example:
component Image placeholder: "square" height: 250component Image placeholder: "landscape" height: 300component Image placeholder: "avatar" height: 100Rendering: Rectangular placeholder image with appropriate aspect ratio
Icon symbol.
Properties:
name(string): Icon identifier (e.g., “search”, “star”, “heart”)
Example:
component Icon name: "search"component Icon name: "settings"component Icon name: "download"Rendering: Small icon symbol inline with text
Display Components
Section titled “Display Components”Divider
Section titled “Divider”Horizontal or vertical separator line.
Properties:
- None required
Example:
component DividerRendering: Thin horizontal line for visual separation
Small label/tag for status or categorization.
Properties:
text(string): Badge labelvariant(string): Style -primary|secondary|success|warning|error|info(default:primary)
Example:
component Badge text: "New" variant: primarycomponent Badge text: "Active" variant: successcomponent Badge text: "Alert" variant: warningRendering: Small rounded label with colored background
Alert/notification message box.
Properties:
type(string): Alert type -info|success|warning|error(required)message(string): Alert message content
Example:
component Alert type: "success" message: "Changes saved successfully"component Alert type: "error" message: "Something went wrong"component Alert type: "warning" message: "This action cannot be undone"component Alert type: "info" message: "New updates available"Rendering: Colored box with icon, title, and message
Information Display
Section titled “Information Display”StatCard
Section titled “StatCard”Statistics card displaying metric and value.
Properties:
title(string): Metric label/titlevalue(string): Metric value to display
Example:
component StatCard title: "Total Users" value: "1,234"component StatCard title: "Revenue" value: "$45,678"component StatCard title: "Growth" value: "+12.5%"Rendering: Card with large value and small label below
Code block display.
Properties:
code(string): Code content to display
Example:
component Code code: "const x = 10; console.log(x);"component Code code: "function sum(a, b) { return a + b; }"component Code code: "SELECT * FROM users WHERE active = true;"Rendering: Monospace text in gray background box
ChartPlaceholder
Section titled “ChartPlaceholder”Placeholder for various chart types.
Properties:
type(string): Chart type -bar|line|pie|area(default:bar)height(number): Height in pixels (default: 200)
Example:
component ChartPlaceholder type: "bar" height: 250component ChartPlaceholder type: "line" height: 300component ChartPlaceholder type: "pie" height: 200Rendering: Chart area with placeholder bars/lines/segments
Modal & Overlay
Section titled “Modal & Overlay”Modal dialog box.
Properties:
title(string): Modal titlecontent(string): Modal content
Example:
component Modal title: "Confirm Action" content: "Are you sure you want to continue?"component Modal title: "Delete User" content: "This action cannot be undone"Rendering: Centered overlay dialog with title and content
Loading & Feedback
Section titled “Loading & Feedback”Spinner
Section titled “Spinner”Loading spinner animation.
Properties:
- None required
Example:
component SpinnerRendering: Animated circular loading indicator
Component Summary
Section titled “Component Summary”| Component | Type | Use Case |
|---|---|---|
| Heading | Text | Page titles |
| Text | Text | Body content |
| Label | Text | Form labels |
| Input | Input | Single-line input |
| Textarea | Input | Multi-line input |
| Select | Input | Dropdown choice |
| Checkbox | Input | Multiple choice |
| Radio | Input | Single choice |
| Toggle | Input | Boolean toggle |
| Button | Button | Clickable action |
| IconButton | Button | Icon-based action |
| Topbar | Navigation | Header bar |
| SidebarMenu | Navigation | Vertical menu |
| Sidebar | Navigation | Side panel |
| Breadcrumbs | Navigation | Navigation path |
| Tabs | Navigation | Tabbed content |
| Table | Data | Data grid |
| List | Data | Item list |
| Image | Media | Image placeholder |
| Icon | Media | Icon symbol |
| Divider | Display | Visual separator |
| Badge | Display | Status label |
| Alert | Display | Alert message |
| StatCard | Info | Metric display |
| Code | Info | Code block |
| ChartPlaceholder | Info | Chart area |
| Modal | Overlay | Dialog box |
| Spinner | Feedback | Loading indicator |
Total: 28 Components