Official documentation for the with-props library
This is the official documentation site for with-props, a lightweight React utility library for creating polymorphic components with preset default properties.
- Getting Started - Installation and basic usage
- Advanced Usage - Advanced patterns and best practices
- API Reference - Complete API documentation
- Examples - Real-world examples
- Node.js >= 22
- npm, yarn, or pnpm
# Install dependencies
npm install
# Start development server
npm run dev
# Build for production
npm run build
# Preview production build
npm run previewwith-props-docs/
├── .dumirc.ts # Dumi configuration
├── docs # Documentation files
│ ├── index.md # Home page
│ ├── guide # Guide section
│ │ ├── getting-started.md
│ │ ├── advanced.md
│ │ ├── api.md
│ │ └── examples.md
│ ├── components # Components overview
│ └── playground # Interactive playground
├── public # Static assets
└── workbox-config.cjs # PWA configuration
Contributions to the documentation are welcome! Please feel free to submit a Pull Request.
- Fork the repository
- Create your feature branch (
git checkout -b feature/amazing-feature) - Commit your changes (
git commit -m 'Add some amazing feature') - Push to the branch (
git push origin feature/amazing-feature) - Open a Pull Request
MIT