@edmicro/olkit 1.1.2 → 1.1.4

package/README.md

@@ -15,6 +15,7 @@ Thư viện thành phần giao diện người dùng (UI Components) chuẩn ho
 ---
 
 ## 📦 1. Cài đặt
+
 ```bash
 # Cài đặt qua Bun
 bun add @edmicro/olkit
@@ -26,7 +27,6 @@ npm install @edmicro/olkit
 yarn add @edmicro/olkit
 ```
 
-
 ---
 
 ## 🎨 2. Cấu hình Styles (Bắt buộc)
@@ -51,7 +51,6 @@ Thêm file `olkit.css` vào mục `styles` trong file `angular.json` của dự
 >
 > ⚠️ **Lưu ý:** Sau khi lưu file `angular.json`, hãy **khởi động lại dev server** (`Ctrl + C` và chạy lại `ng serve` / `npm start`) để Angular áp dụng stylesheet mới.
 
-
 ---
 
 ## 🚀 3. Hướng dẫn sử dụng Components
@@ -60,15 +59,15 @@ Do tất cả component đều là **Standalone**, bạn chỉ cần import comp
 
 ```typescript
 import { Component } from '@angular/core';
-import { 
-  OlButton, 
+import {
+  OlButton,
   OlDownloadAppButton,
-  OlAlert, 
-  OlAccordion, 
+  OlAlert,
+  OlAccordion,
   OlAccordionItem,
   OlModal,
   OlTabs,
-  OlTabItem
+  OlTabItem,
 } from '@edmicro/olkit';
 
 @Component({
@@ -82,9 +81,9 @@ import {
     OlAccordionItem,
     OlModal,
     OlTabs,
-    OlTabItem
+    OlTabItem,
   ],
-  templateUrl: './dashboard.component.html'
+  templateUrl: './dashboard.component.html',
 })
 export class DashboardComponent {
   isModalOpen = false;
@@ -100,6 +99,7 @@ export class DashboardComponent {
 ## 💻 4. Code Mẫu Chi Tiết Từng Component
 
 ### 🔘 Buttons (`<ol-button>`)
+
 Hỗ trợ đầy đủ biến thể theo Figma Ôn Luyện: `brand` (#2B4182), `green` (#007A55), `red` (#C70036), `orange` (#FF5A1F), `ghost`, `tertiary`, `dark`, `white`.
 
 ```html
@@ -140,6 +140,7 @@ Hỗ trợ đầy đủ biến thể theo Figma Ôn Luyện: `brand` (#2B4182),
 ---
 
 ### 📲 Nút Tải Ứng Dụng (`<ol-download-app-button>`)
+
 Nút tải chuẩn nhận diện App Store & Google Play từ Figma Ôn Luyện (tự động thích ứng Light/Dark mode).
 
 ```html
@@ -155,6 +156,7 @@ Nút tải chuẩn nhận diện App Store & Google Play từ Figma Ôn Luyện
 ---
 
 ### 🔔 Alerts (`<ol-alert>`)
+
 Thông báo phản hồi ngữ cảnh: `info`, `danger` (red), `success` (green), `warning` (orange), `dark`.
 
 ```html
@@ -170,25 +172,19 @@ Thông báo phản hồi ngữ cảnh: `info`, `danger` (red), `success` (green)
 </ol-alert>
 
 <!-- Thông báo dạng Border Accent -->
-<ol-alert color="danger" [border]="true">
-  Lỗi bảo mật: Phiên làm việc đã hết hạn.
-</ol-alert>
+<ol-alert color="danger" [border]="true"> Lỗi bảo mật: Phiên làm việc đã hết hạn. </ol-alert>
 ```
 
 ---
 
 ### 🪟 Modals (`<ol-modal>`)
+
 Cửa sổ hộp thoại tương tác cao, có thể backdrop dismiss, ESC key, nhiều kích thước:
 
 ```html
 <ol-button color="brand" (click)="isModalOpen = true">Mở Modal</ol-button>
 
-<ol-modal 
-  [(isOpen)]="isModalOpen" 
-  title="Xác nhận nộp bài thi" 
-  size="md"
-  [dismissible]="true"
->
+<ol-modal [(isOpen)]="isModalOpen" title="Xác nhận nộp bài thi" size="md" [dismissible]="true">
   <p class="text-sm text-gray-600 dark:text-gray-300">
     Bạn còn 3 câu chưa hoàn thành. Bạn có chắc chắn muốn nộp bài thi ngay bây giờ không?
   </p>
@@ -242,20 +238,49 @@ Cửa sổ hộp thoại tương tác cao, có thể backdrop dismiss, ESC key,
 
 ---
 
-## 🛠️ 5. Cập nhật phiên bản mới
+## 📜 5. Nhật ký thay đổi
+
+Mọi thay đổi đáng kể của thư viện — kèm hướng dẫn nâng cấp cho các bản có thay
+đổi phá vỡ — ghi trong nhật ký:
+
+<p align="center">
+  <a href="https://gitlab.edmicro.io/onluyenpub/olkit-source/-/blob/master/CHANGELOG.md">
+    <img alt="Xem nhật ký thay đổi"
+         src="https://img.shields.io/badge/%F0%9F%93%96%20Xem%20nh%E1%BA%ADt%20k%C3%BD%20thay%20%C4%91%E1%BB%95i-CHANGELOG.md-2B4182?style=for-the-badge" />
+  </a>
+</p>
+
+👉 **[Mở CHANGELOG.md](https://gitlab.edmicro.io/onluyenpub/olkit-source/-/blob/master/CHANGELOG.md)** — dùng liên kết này nếu nút trên không hiện
+(npmjs.com chặn một số ảnh từ miền ngoài).
 
-Khi có bản phát hành mới từ GitLab, bạn chỉ cần chạy lệnh cập nhật:
+> 💡 Đọc nhật ký **trước khi nâng phiên bản**. Số hiệu của thư viện này là
+> `patch` cả ở những bản có thay đổi phá vỡ, nên đừng dựa vào số để đoán —
+> các bản đó có khối cảnh báo ⚠ ở đầu mục, kèm mã trước/sau và việc cần làm.
+
+---
+
+## 🛠️ 6. Cập nhật phiên bản mới
 
 ```bash
-# Cập nhật lại package từ repository
-npm install git+https://gitlab.edmicro.io/onluyenpub/olkit-deploy.git#v1.0.1
+# Nâng lên bản mới nhất
+npm install @edmicro/olkit@latest
+
+# Hoặc ghim đúng một phiên bản
+npm install @edmicro/olkit@1.1.4
+
+# Xem các bản đã phát hành
+npm view @edmicro/olkit versions
 ```
 
+> Cách cài từ GitLab (`npm install git+https://…olkit-deploy.git#v1.0.1`) đã
+> **bỏ** — gói phát hành trên NPM registry công khai từ bản 1.0.x.
+
 ---
 
 ## 📄 License & Bản quyền
 
 ### Giấy phép chính
+
 Dự án này được cấp phép theo **MIT License**  
 Copyright (c) 2026 EDMicro
 
@@ -263,22 +288,24 @@ Copyright (c) 2026 EDMicro
 
 Dự án này tích hợp các thành phần mã nguồn mở từ bên thứ ba, mỗi thành phần giữ nguyên điều khoản giấy phép gốc:
 
-| Thành phần | License | Commercial Use | Attribution Required |
-|------------|---------|----------------|---------------------|
-| **Flowbite** | MIT | ✅ | Giữ copyright notice |
-| **Myna UI Icons** | MIT | ✅ | Giữ copyright notice |
-| **Solar Icons** | **CC BY 4.0** | ✅ | **✅ Bắt buộc** |
+| Thành phần        | License       | Commercial Use | Attribution Required |
+| ----------------- | ------------- | -------------- | -------------------- |
+| **Flowbite**      | MIT           | ✅             | Giữ copyright notice |
+| **Myna UI Icons** | MIT           | ✅             | Giữ copyright notice |
+| **Solar Icons**   | **CC BY 4.0** | ✅             | **✅ Bắt buộc**      |
 
 #### ⚠️ Lưu ý quan trọng về Solar Icons
 
-**Solar Icon Set** của 480 Design được cấp phép theo **Creative Commons Attribution 4.0 International (CC BY 4.0)**. 
+**Solar Icon Set** của 480 Design được cấp phép theo **Creative Commons Attribution 4.0 International (CC BY 4.0)**.
 
 Điều này có nghĩa:
+
 - ✅ Bạn có thể sử dụng cho mục đích thương mại
 - ✅ Bạn có thể chỉnh sửa, tùy biến màu sắc, kích thước
 - ⚠️ **BẮT BUỘC ghi công tác giả** (attribution) khi sử dụng
 
 **Attribution mẫu:**
+
 ```
 Solar Icons by 480 Design
 Licensed under CC BY 4.0
@@ -288,6 +315,7 @@ https://creativecommons.org/licenses/by/4.0/
 #### Chi tiết đầy đủ
 
 Xem chi tiết các giấy phép trong:
+
 - [`LICENSE`](../../LICENSE) - Giấy phép MIT chính của dự án
 - [`THIRD-PARTY-NOTICES`](../../THIRD-PARTY-NOTICES) - Thông báo đầy đủ về license bên thứ ba
 - [`LICENSES/`](../../LICENSES/) - Bản gốc các giấy phép:
@@ -298,6 +326,7 @@ Xem chi tiết các giấy phép trong:
 ---
 
 ## 📞 Liên hệ
+
 - **Đơn vị phát triển**: EDMICRO - Đội ngũ Frontend Ôn Luyện V4
 - **Figma Design System**: [Ôn Luyện Design System](https://www.figma.com/design/lip4g3PkcupVurtCxXCkEz/%C3%94n-Luy%E1%BB%87n-Design-System?node-id=2542-21012)
 - **GitLab Repository**: [https://gitlab.edmicro.io/onluyenpub/olkit-deploy](https://gitlab.edmicro.io/onluyenpub/olkit-deploy)