API Reference
Complete API documentation for components, utilities, and framework core
🎨 Looking for interactive examples and quick start guides?
Visit the Developer Documentation for live demos and usage patterns
📦 Component APIs
Comprehensive API documentation for all 28 VWF components with props, events, and usage examples.
Form Components
- • Button - Interactive button with states
- • Input - Text input with validation
- • Password - Secure password input
- • TextArea - Multi-line text input
- • Select - Dropdown select
- • Checkbox - Single checkbox
- • RadioButton/RadioGroup - Radio selections
- • Toggle/ToggleGroup - Toggle switches
- • Slider - Range slider
- • OTPInput - One-time password input
- • ListBox - Accessible listbox
Display Components
- • Avatar/AvatarGroup - User avatars
- • Badge - Status badges and labels
- • Card - Content containers
- • Skeleton - Loading placeholders
- • EmptyState - Empty state messages
- • List/NavigationList/CheckList - Lists
- • Link - Styled links
Feedback Components
- • Toast - Notification toasts
- • Modal - Dialog modals
- • Alert - Alert messages
Layout & Navigation
- • NavigationHeader - Main navigation
- • SecondaryNav - Tab navigation
- • NavDrawer - Side drawer navigation
- • Header - Page headers
- • Logo - VWF logo component
🔧 Utilities & Helpers
Core utilities for routing, state management, validation, and component composition.
Component Utilities
- • parseArgs() - Component argument parsing
- • cx() - Class name composition
- • filterClassName() - Tailwind conflict resolution
- • val() - Universal value resolver
Framework Utilities
- • router - File-based navigation
- • validator - Form validation library
- • Lifecycle hooks (postMount, preUnmount)
- • Route metadata and guards
⚡ Framework Core APIs
VanJS core APIs and VWF extensions for building reactive applications.
VanJS Core
- • van.state() - Reactive state management
- • van.derive() - Computed reactive values
- • van.tags - HTML element creation
- • van.add() - Dynamic DOM updates
VWF Extensions
- • Message pattern - Validation feedback
- • CSS variable utilities
- • Component flexibility (parseArgs)
- • Smart conflict resolution
Explore vwf
Discover what vwf can do