@nhatdev94/common-ui 1.1.14 → 1.1.15

package/README.md

@@ -0,0 +1,253 @@
+# 📦 Common UI Library
+
+**Package Name:** `@nhatdev94/common-ui`\
+**Document Version:** 1.1\
+**Last Updated:** 
+**Owner:**
+**Status:** 
+
+------------------------------------------------------------------------
+
+## Requirements
+
+This package requires:
+
+- React 18+
+- Tailwind CSS v4
+
+------------------------------------------------------------------------
+
+🚀 Hướng dẫn tích hợp cho dự án mới
+
+Để sử dụng thư viện trong các dự án mới (Vite, Next.js, v.v.), vui lòng làm theo các bước hướng dẫn dưới đây.
+
+1️⃣ Cài đặt
+
+``` bash
+npm install @nhatdev94/common-ui
+```
+
+2️⃣ Thiết lập Styles & Themes
+
+Mở file CSS chính của bạn (ví dụ: src/index.css hoặc app/globals.css) và cấu hình như sau:
+
+``` bash
+@import "tailwindcss";
+
+/* -----------------------------------------------------------
+ * IMPORT THEME
+ * Cung cấp màu sắc, biến CSS nền và thiết lập layout cơ bản.
+ * ----------------------------------------------------------- */
+@import "@nhatdev94/common-ui/themes/default.css";
+
+```
+
+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:
+
+``` bash
+@source "../node_modules/@nhatdev94/common-ui/dist/**/*.js";
+```
+
+------------------------------------------------------------------------
+
+🛠 Cách sử dụng Component
+
+Sau khi thiết lập xong, bạn có thể bắt đầu sử dụng các component trong dự án của mình:
+
+``` bash
+import { Button } from '@nhatdev94/common-ui';
+
+export default function App() {
+  return (
+    <div className="flex gap-4 p-8">
+      <Button variant="primary">Click Me</Button>
+      <Button variant="outline">Cancel</Button>
+    </div>
+  );
+}
+```
+
+------------------------------------------------------------------------
+
+🛠 **Quy trình Cập nhật và Nâng cấp Package (Workflow)**
+
+1. **Giai đoạn Cập nhật Package (Pkg Side)**
+
+Khi có yêu cầu thay đổi tính năng hoặc sửa lỗi trong package:
+
+- **Modify Code**: Thực hiện thay đổi logic trong source code của package.
+- **Test**: Chạy unit test của package để đảm bảo không làm hỏng các tính năng cũ.
+- **Bump Version**: Cập nhật phiên bản trong file package.json theo nguyên tắc Semantic Versioning (SemVer):
+    + *Major (v1.0.0 -> v2.0.0)*: Có thay đổi lớn, không tương thích ngược.
+    + *Minor (v1.0.0 -> v1.1.0)*: Thêm tính năng mới nhưng vẫn tương thích ngược.
+    + *Patch (v1.0.0 -> v1.0.1)*: Sửa lỗi nhỏ.
+- **Build & Publish**: Chạy lệnh build (nếu có) và đẩy lên Registry (NPM, GitHub Packages, hoặc Azure Artifacts).
+ 
+```bash
+npm publish
+```
+
+2. **Giai đoạn Tích hợp vào Ứng dụng (App Side)**
+
+Sau khi package đã có phiên bản mới trên kho lưu trữ, ứng dụng chính cần được cập nhật:
+- **Upgrade Command**: Sử dụng lệnh để cài đặt phiên bản cụ thể.
+```bash
+npm install @nhatdev94/common-ui@latest
+```
+- **Regression Test**: Chạy ứng dụng chính để kiểm tra xem package mới có hoạt động trơn tru với các module khác không.
+
+------------------------------------------------------------------------
+
+# 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,6 +1,6 @@
 {
   "name": "@nhatdev94/common-ui",
-  "version": "1.1.14",
+  "version": "1.1.15",
   "description": "",
   "main": "dist/index.cjs",
   "module": "dist/index.js",