Changelog¶
All notable changes to Dash CopilotKit Components will be documented in this file.
The format is based on Keep a Changelog, and this project adheres to Semantic Versioning.
[Unreleased]¶
Added¶
- Multi-page demo application with modern responsive design
- Comprehensive documentation with MkDocs
- GitHub Actions workflow for documentation deployment
- Custom CSS styling with CSS variables and dark mode support
- Interactive configuration panels for each UI type
- Code examples with syntax highlighting
- Mobile-responsive navigation
Changed¶
- Updated to Dash 3.0 compatibility (removed deprecated
app.run_server()) - Improved component prop validation and error handling
- Enhanced styling with Bootstrap components
- Better mobile responsiveness across all UI types
Fixed¶
- Fixed navbar component compatibility with dash-bootstrap-components 2.0+
- Resolved JSX syntax errors in React components
- Fixed component generation for Python bindings
[0.1.0] - 2024-09-24¶
Added¶
- Initial release of Dash CopilotKit Components
- Support for 4 UI types:
- Chat Interface - Full embedded chat experience
- Popup Chat - Toggleable popup window
- Sidebar Chat - Slide-in sidebar (left/right positioning)
- AI Textarea - AI-powered text input with suggestions
- CopilotKit Cloud integration with public API key support
- Bring-your-own-key option with custom runtime URL
- Comprehensive prop system for customization:
ui_type,api_key,runtime_url,public_api_keyinstructions,labels,placeholder,valuedisabled,className,style,width,heightposition,show_initially- React component built with CopilotKit React libraries
- Python component generation with proper type hints
- Basic usage examples and documentation
- Test suite with component validation
Technical Details¶
- Built with React 18.3.1 and styled-jsx 5.1.0
- CopilotKit dependencies: copilotkit/react-core, copilotkit/react-ui, copilotkit/react-textarea
- Dash 3.0+ compatibility
- TypeScript-style prop validation
- Webpack build system with proper bundling
- Component lazy loading with React.Suspense
Dependencies¶
- dash>=3.0.0
- react>=18.3.1
- react-dom>=18.3.1
- copilotkit/react-core
- copilotkit/react-ui
- copilotkit/react-textarea
- styled-jsx>=5.1.0
Development Milestones¶
Phase 1: Core Component (Completed)¶
- ✅ React component development
- ✅ CopilotKit integration
- ✅ Python bindings generation
- ✅ Basic testing and validation
Phase 2: Demo Application (Completed)¶
- ✅ Multi-page Dash application
- ✅ Modern responsive design
- ✅ Interactive configuration panels
- ✅ Mobile-friendly navigation
Phase 3: Documentation (Completed)¶
- ✅ MkDocs setup with Material theme
- ✅ Comprehensive documentation structure
- ✅ GitHub Actions deployment
- ✅ Custom domain configuration
Phase 4: Future Enhancements (Planned)¶
- 🔄 Advanced customization options
- 🔄 Additional UI themes and styling
- 🔄 Performance optimizations
- 🔄 Extended callback support
- 🔄 Plugin system for extensions
Breaking Changes¶
v0.1.0¶
- Initial release - no breaking changes
Migration Guide¶
From Development to v0.1.0¶
No migration needed - this is the initial release.
Support¶
For questions, issues, or contributions: - 📖 Documentation - 🐛 GitHub Issues - 💬 Discussions