procode-vs-theme
Version:
VarStreet VS Theme - A comprehensive SCSS theme package for ProCode framework with variables, components, layout, and utilities for flexible design system usage
64 lines (44 loc) • 1.48 kB
Markdown
# VarStreet VS Theme
A comprehensive SCSS theme package for the VarStreet ProCode framework with modern styling and design system components.
## 🌟 Features
- **Modular Architecture**: Import only what you need for optimal bundle size
- **Design System**: Colors, fonts, spacing, and design tokens
- **Component Styles**: Pre-styled UI components
- **Layout System**: Flexible layout components and grid systems
- **Utility Classes**: Spacing, typography, borders, shadows and other utilities
- **TypeScript Support**: Full type definitions and theme configuration
## 📦 Installation
```bash
npm install procode-vs-theme
```
### Peer Dependencies
```bash
npm install sass --save-dev
```
## 🛠️ Usage
### Complete Theme
```scss
// Import all theme styles
@import 'procode-vs-theme/scss';
```
### Modular Imports
```scss
// Import specific modules
@import 'procode-vs-theme/src/base/color';
@import 'procode-vs-theme/src/components/buttons';
@import 'procode-vs-theme/src/utilities/spacing';
```
### TypeScript Integration
```typescript
import { components, variables } from 'procode-vs-theme';
import { getThemeConfig } from 'procode-vs-theme';
```
## 📋 Requirements
- Node.js 16+
- SCSS processor (sass)
- Modern build system (Webpack, Vite, etc.)
- TypeScript 4.0+ (optional)
## 📄 License
MIT
## 🤝 Contributing
Contributions are welcome! Please read our contributing guidelines.