@tatamicks/core
v0.3.2
Published
A headless, extensible document editor for React with grid-based layout system
Downloads
1,879
Readme
@tatamicks/core
A headless, extensible document editor for React with grid-based layout system.
Features
- 🎯 Headless Architecture - Complete control over UI rendering
- 🔌 Plugin System - Extensible block types through plugins
- 📐 Grid-based Layout - Precise positioning with grid system
- 🎨 CSS Modules - Scoped styling without conflicts
- 📝 TypeScript - Full type safety
- ⚛️ React 18+ - Modern React features
Installation
npm install @tatamicks/core react react-domQuick Start
waiting for documentation...
Basic Usage
waiting for documentation...
With Plugins
waiting for documentation...
API Reference
NoteEditor Props
| Prop | Type | Required | Description |
|------|------|----------|-------------|
| initialBlocks | Block[] | Yes | Initial block data |
| onChange | (blocks: Block[]) => void | Yes | Callback when blocks change |
| plugins | Plugin[] | No | Array of plugins to use |
| gridSize | number | No | Grid cell size in pixels (default: 20) |
| className | string | No | Additional CSS class |
Architecture
This library follows a headless architecture pattern, providing:
- Core Components:
NoteForm,NoteEdit,NoteView - Plugin System: Extensible block types
- State Management: Controlled component pattern
- Grid System: Precise layout control
Development
# Install dependencies
npm install
# Run development server
npm run dev
# Build library
npm run build
# Run tests
npm test
# Type checking
npm run typecheckLicense
MIT © 2025 yonpachi (株式会社torchi) – yatch
Links
- GitHub Repository
- Documentation
- Issues
- 株式会社torchi
