@nhatdev94/common-ui 1.1.6 → 1.1.8

package/README.md

@@ -0,0 +1,200 @@
+# 📦 Common UI Library
+
+**Package Name:** `@nhatdev94/common-ui`\
+**Document Version:** 1.0\
+**Last Updated:** 
+**Owner:**
+**Status:** 
+
+------------------------------------------------------------------------
+
+## Requirements
+
+This package requires:
+
+- React 18+
+- Tailwind CSS v4
+
+------------------------------------------------------------------------
+
+## Installation
+
+Để sử dụng các thành phần UI, bạn cần cài đặt thư viện và cấu hình Tailwind CSS v4 để nhận diện các lớp tiện ích (utility classes) từ gói package này.
+
+1. Cài đặt package
+npm install @nhatdev94/common-ui
+or
+pnpm add @nhatdev94/common-ui
+
+2. Import Theme
+Thư viện cung cấp các bộ giao diện (themes) khác nhau. Bạn cần import file CSS của theme vào file CSS chính (ví dụ index.css hoặc globals.css) để áp dụng các biến màu sắc và kiểu dáng:
+
+/* Trong file CSS chính của bạn */
+@import "tailwindcss";
+@import "@nhatdev94/common-ui/themes/default.css";
+
+Bạn có thể thay đổi default.css bằng các theme khác nếu thư viện có hỗ trợ (ví dụ: emerald.css).
+
+3. Cấu hình Tailwind v4 (Nếu thiếu Style)
+Nếu bạn nhận thấy các Component hiển thị nhưng bị mất các class tiện ích của Tailwind (như padding, margin, màu sắc động), đó là do Tailwind v4 chưa quét qua mã nguồn của thư viện.
+
+Hãy thêm dòng @source bên dưới phần import trong file CSS:
+@import "tailwindcss";
+@import "@nhatdev94/common-ui/themes/emerald.css";
+
+/* Thêm dòng này nếu Component không hiển thị đúng Style */
+@source "../node_modules/@nhatdev94/common-ui/dist/**/*.js";
+
+------------------------------------------------------------------------
+
+# 1. Executive Summary
+
+`@nhatdev94/common-ui` là thư viện UI component dùng chung cho toàn bộ hệ
+sinh thái frontend của công ty.
+
+Mục tiêu:
+
+-   Chuẩn hóa giao diện giữa các hệ thống
+-   Giảm duplication code
+-   Tăng tốc độ phát triển
+-   Đảm bảo tính nhất quán (consistency)
+-   Tăng khả năng maintain và scale
+
+------------------------------------------------------------------------
+
+# 2. Scope
+
+## 2.1 In Scope
+
+-   Atomic UI Components (Button, Input, Modal, Table, etc.)
+-   Design tokens (color, spacing, typography)
+-   Accessibility compliant components
+
+## 2.2 Out of Scope
+
+-   Business logic
+-   API integration
+-   Global state management
+-   Application routing
+-   Domain-specific UI
+
+------------------------------------------------------------------------
+
+# 3. Architecture Overview
+
+## 3.1 Design Principles
+
+1.  Component-driven development
+2.  Stateless by default
+3.  Business-agnostic
+4.  Backward-compatible changes
+5.  Accessibility-first mindset
+
+------------------------------------------------------------------------
+
+## 3.2 Tech Stack
+
+-   React 18+
+-   TypeScript
+-   TailwindCSS
+-   Storybook
+-   Vitest
+-   tsup
+
+------------------------------------------------------------------------
+
+# 4. Folder Structure
+
+``` bash
+common-ui/
+ ├─ src/
+ │   ├─ components/
+ │   ├─ hooks/
+ │   ├─ lib/
+ │   ├─ stories/
+ │   ├─ themes/
+ │   └─ index.ts
+ ├─ .storybook/
+ ├─ dist/
+ ├─ package.json
+ ├─ tsconfig.json
+ ├─ tsup.config.json
+ └─ README.md
+```
+
+------------------------------------------------------------------------
+
+# 5. Component Standards
+
+## Naming Convention
+
+-   PascalCase cho component name
+-   KebabCase cho file name
+-   Props interface: `ComponentNameProps`
+-   Không sử dụng default export
+
+## Rules
+
+-   Không gọi API
+-   Không import từ application layer
+-   Không chứa business validation logic
+-   Không phụ thuộc Redux / Zustand / App Context
+
+------------------------------------------------------------------------
+
+# 6. Storybook Governance
+
+-   Mỗi component bắt buộc có story
+-   Có default state và variants
+-   Có edge cases
+
+Run:
+
+``` bash
+npm run storybook
+```
+
+Build:
+
+``` bash
+npm run build-storybook
+```
+
+------------------------------------------------------------------------
+
+# 7. Versioning Policy
+
+Tuân theo Semantic Versioning:
+
+  Type    Meaning
+  ------- ------------------
+  MAJOR   Breaking changes
+  MINOR   New feature
+  PATCH   Bug fix
+
+------------------------------------------------------------------------
+
+# 8. CI/CD Workflow
+
+1.  Pull Request
+2.  Lint & Test (planned)
+3.  Review
+4.  Merge to main
+5.  Automated publish (planned)
+
+------------------------------------------------------------------------
+
+# 9. Security & Performance
+
+-   Tree-shakeable exports
+-   Không bundle React
+-   ESM & CJS output
+-   Audit dependency định kỳ
+
+------------------------------------------------------------------------
+
+# 10. Conclusion
+
+`@nhatdev94/common-ui` là nền tảng UI governance cho toàn bộ frontend
+ecosystem, đảm bảo consistency, scalability và maintainability cho sản
+phẩm.

package/package.json

@@ -1,49 +1,49 @@
-{
-  "name": "@nhatdev94/common-ui",
-  "version": "1.1.6",
-  "description": "",
-  "main": "dist/index.cjs",
-  "module": "dist/index.js",
-  "types": "dist/index.d.ts",
-  "files": [
-    "dist"
-  ],
-  "exports": {
-    ".": {
-      "import": "./dist/index.js",
-      "require": "./dist/index.cjs",
-      "types": "./dist/index.d.ts"
-    },
-    "./themes/*": "./dist/themes/*"
-  },
-  "sideEffects": [
-    "**/*.css"
-  ],
-  "scripts": {
-    "build": "tsup && npm run copy-themes",
-    "copy-themes": "copyfiles -u 1 \"src/themes/*.css\" dist"
-  },
-  "keywords": [],
-  "author": "",
-  "license": "ISC",
-  "type": "commonjs",
-  "dependencies": {
-    "class-variance-authority": "^0.7.1",
-    "clsx": "^2.1.1",
-    "lucide-react": "^0.576.0",
-    "next-themes": "^0.4.6",
-    "radix-ui": "^1.4.3",
-    "sonner": "^2.0.7",
-    "tailwind-merge": "^3.5.0"
-  },
-  "devDependencies": {
-    "@types/react": "^19.2.14",
-    "copyfiles": "^2.4.1",
-    "react": "^19.2.4",
-    "tsup": "^8.5.1",
-    "typescript": "^5.9.3"
-  },
-  "peerDependencies": {
-    "react": ">=18"
-  }
-}
+{
+  "name": "@nhatdev94/common-ui",
+  "version": "1.1.8",
+  "description": "",
+  "main": "dist/index.cjs",
+  "module": "dist/index.js",
+  "types": "dist/index.d.ts",
+  "files": [
+    "dist"
+  ],
+  "exports": {
+    ".": {
+      "import": "./dist/index.js",
+      "require": "./dist/index.cjs",
+      "types": "./dist/index.d.ts"
+    },
+    "./themes/*": "./dist/themes/*"
+  },
+  "sideEffects": [
+    "**/*.css"
+  ],
+  "scripts": {
+    "build": "tsup && npm run copy-themes",
+    "copy-themes": "copyfiles -u 1 \"src/themes/*.css\" dist"
+  },
+  "keywords": [],
+  "author": "",
+  "license": "ISC",
+  "type": "commonjs",
+  "dependencies": {
+    "class-variance-authority": "^0.7.1",
+    "clsx": "^2.1.1",
+    "lucide-react": "^0.576.0",
+    "next-themes": "^0.4.6",
+    "radix-ui": "^1.4.3",
+    "sonner": "^2.0.7",
+    "tailwind-merge": "^3.5.0"
+  },
+  "devDependencies": {
+    "@types/react": "^19.2.14",
+    "copyfiles": "^2.4.1",
+    "react": "^19.2.4",
+    "tsup": "^8.5.1",
+    "typescript": "^5.9.3"
+  },
+  "peerDependencies": {
+    "react": ">=18"
+  }
+}