procode-vs-template
Version:
VarStreet Template Library - A comprehensive React template system with widget factories, action handlers, and SCSS styling for dynamic template creation
70 lines (46 loc) • 1.58 kB
Markdown
# VarStreet Template Library
A comprehensive React template system with widget factories, action handlers, and SCSS styling for dynamic template creation.
## 🌟 Features
- **TemplateWidgetFactory**: Dynamic widget creation and management system
- **TemplateActionFactory**: Action handler and template action management
- **TypeScript Support**: Full type definitions included
- **Modular Architecture**: Import only what you need
- **SCSS Styling**: Built-in template styling system
## 📦 Installation
```bash
npm install procode-vs-template
```
### Peer Dependencies
```bash
npm install react react-dom react-router-dom react-beautiful-dnd
```
## 🛠️ Usage
### Basic Usage
```tsx
import TemplateWidgetFactory from 'procode-vs-template';
const factory = new TemplateWidgetFactory();
const widget = factory.createWidget({
widgetType: 'button',
config: { title: 'Click Me' },
uiElementGroupData: {}
});
```
### Import Options
```tsx
// Import factories
import { TemplateWidgetFactory, TemplateActionFactory } from 'procode-vs-template/factories';
// Import actions
import { TemplateActionFactory } from 'procode-vs-template/actions';
// Import styles
import 'procode-vs-template/styles';
```
## 📋 Requirements
- React 18.2.0+
- TypeScript 5.0.2+
- Node.js 16+
## 📄 License
MIT
## 🤝 Contributing
Contributions are welcome! Please read our contributing guidelines.
## Support
For support and questions, please visit our documentation or create an issue in the repository.