Framework Reference โ
Complete technical documentation of the KIMU framework for developers.
๐ง Core Classes โ
The fundamental classes that constitute the heart of the framework:
- KimuApp - Singleton for application configuration and lifecycle
- KimuComponentElement - Base class for all components
- KimuEngine - Rendering engine and template management
- KimuExtensionManager - Dynamic extension manager
- KimuRender - Lit-based rendering system
- KimuAssetManager - Asset and resource management
- KimuStore - Data persistence with IndexedDB
๐ท๏ธ Decorators โ
Decorators for component registration and configuration:
- @KimuComponent - Decorator for Web Components registration
๐ Types and Interfaces โ
TypeScript definitions for typing and metadata:
- KimuExtensionMeta - Extension metadata
- KimuAsset - Asset and resource types
- KimuLang - Supported language configuration
๐งฉ Extension System โ
Complete guide to KIMU's modular system:
- Extension Overview - Introduction to the extension system
- Creating an Extension - Step-by-step guide to develop extensions
- Extension Lifecycle - Complete extension lifecycle
- Extension Manifest - Configuration and metadata
- Build and Deployment - Compilation and distribution
- Best Practices - Guidelines and recommended practices
๐๏ธ Architectural Patterns โ
Patterns and best practices used in the framework:
- Pattern Overview - Introduction to architectural patterns
- Singleton Pattern - Managing unique instances in the framework
- Observer Pattern - Notification and communication system
- Asset Loading Pattern - Efficient resource loading
๐ฏ How to Use This Section โ
This documentation is organized for:
- Developers who want to extend KIMU
- Contributors who want to improve the framework
- Architects who want to understand the internal design
Each section includes:
- Complete functionality description
- Practical code examples
- Best practices and patterns
- Reference links
๐ก Tip: Start with KimuApp to understand the general architecture, then explore KimuComponentElement to learn how to create components.