@dadehkav/components
v0.0.13
Published
A reusable **React UI component library** built with **TypeScript**, **Bootstrap**, and **Vite**. Designed for real-world applications such as dashboards, admin panels, and form-heavy systems.
Downloads
356
Keywords
Readme
@dadehkav/components
A reusable React UI component library built with TypeScript, Bootstrap, and Vite.
Designed for real-world applications such as dashboards, admin panels, and form-heavy systems.
✨ Features
- ⚛️ React 19 compatible
- 🧩 Fully typed components (TypeScript)
- 🎨 Bootstrap-based styling
- 📦 ES Module & CommonJS builds
- 🌳 Tree-shakable
- 📚 Storybook for development & documentation
- 🚫 Storybook not included in published package
📥 Installation
npm install @dadehkav/components
or
yarn add @dadehkav/components
⚠️ Peer Dependencies
You must have these installed in your project:
npm install react react-dom bootstrap
Make sure
reactandreact-domversions match your project.
🎨 REQUIRED: Styling
This library ships its own compiled CSS file. If you do NOT import it, components will render without styles.
✅ You MUST import the library CSS:
import "@dadehkav/components/components.css";
✅ You MUST also import Bootstrap CSS:
import "bootstrap/dist/css/bootstrap.min.css";
📌 Recommended location:
main.tsx
index.tsx
global layout file
Customize Bootstrap colors
Create custom.scss:
$primary: #519257; $success: #519257; $warning: #d29f58; $info: #6bc9cc; $danger: #ea5455;
@import "bootstrap/scss/bootstrap";
Then import it:
import "./custom.scss";
🚀 Basic Usage
import { SimpleButton } from "@dadehkav/components";
function App() { return ; }
export default App;
🧠 TypeScript
Fully typed components and utilities
Type definitions included in package
If auto-import does not work in your project, ensure your
tsconfig.jsonuses:{ "compilerOptions": { "moduleResolution": "node" } }
📚 Storybook
For development & documentation:
Storybook files are not published. You can view the components by checking the hosted Storybook at:
https://docdadehkavui.dadehkavdehghan.ir
📂 Published Package Contents
- dist/ → compiled JS and CSS
- .d.ts type declarations
- Only production-ready files included
🛠 Tech Stack
- React
- TypeScript
- Vite
- Bootstrap
- Reactstrap
- Storybook
🏷 Versioning
Semantic versioning:
- 0.x.x — early development
- 1.0.0 — first stable release
❤️ Contributing
Feedback and improvements are welcome. Open an issue or PR.
