@scalably/ui 0.1.0 → 0.2.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 Scalably
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -1,5 +1,9 @@
 # Scalably UI Component Library
 
+![npm version](https://img.shields.io/npm/v/@scalably/ui)
+![build status](https://github.com/quangnle/scalably-components/actions/workflows/pr-checks.yml/badge.svg?branch=main)
+![license](https://img.shields.io/npm/l/@scalably/ui)
+
 A modern, accessible, and fully isolated React component library built with TypeScript and Tailwind CSS. Designed to work seamlessly across multiple projects without style conflicts.
 
 ## 🚀 Features
@@ -55,6 +59,8 @@ export default function App() {
 }
 ```
 
+Note: Toasts in this library are intentionally declarative. Render a `Toast` inside a `ToastContainer` when you want it visible (e.g., based on component state). This avoids hidden globals and keeps UI state predictable. If you prefer an imperative API, you can wrap your own tiny helper around local state to toggle a `Toast` component.
+
 ### 3. Add the provider once (recommended)
 
 Instead of adding the `sui-scope` class manually, wrap your app with the provider:
@@ -149,9 +155,9 @@ All components use prefixed Tailwind classes (`sui-*`) to ensure complete style
   <Button>Isolated Button</Button>
 </div>
 
-// ❌ Avoid - mixing prefixed and non-prefixed classes
-<div className="p-4"> {/* This won't conflict */}
-  <Button>Button with ui-* classes</Button>
+// ✅ Your global styles won't break the components
+<div className="p-4 bg-red-500"> {/* These global classes won't affect the button's styles */}
+  <Button>Isolated Button</Button>
 </div>
 ```
 
@@ -222,14 +228,14 @@ Visit our Storybook documentation for:
 
 ### Colors
 
-- **Primary**: `#36499B` - Main brand color for primary actions
-- **Secondary**: `#F2F6FC` - Light background colors with multiple levels
-- **Success**: `#22BC4D` - Green for positive actions and success states
-- **Warning**: `#FF7A00` - Orange for caution and in-progress states
-- **Info**: `#2772F0` - Blue for informational content
-- **Error**: `#EA3540` - Red for destructive actions and errors
-- **Inactive**: `#777E90` - Gray for inactive or completed states
-- **Disabled**: `#B2BBC7` - Light gray for disabled elements
+- **Primary**: `#36499B` – Main brand color for primary actions (`sui-bg-primary`, `sui-text-primary`)
+- **Secondary**: `#F2F6FC` – Light background colors (`sui-bg-secondary`, `sui-text-secondary`)
+- **Success**: `#22BC4D` – Positive actions and success states (`sui-bg-success`, `sui-text-success`)
+- **Warning**: `#FF7A00` – Caution and in-progress states (`sui-bg-warning`, `sui-text-warning`)
+- **Info**: `#2772F0` – Informational content (`sui-bg-info`, `sui-text-info`)
+- **Error**: `#EA3540` – Destructive actions and errors (`sui-bg-error`, `sui-text-error`)
+- **Inactive**: `#777E90` – Inactive or completed states (`sui-text-inactive`, `sui-border-inactive`)
+- **Disabled**: `#B2BBC7` – Disabled elements (`sui-text-disabled`, `sui-border-disabled`)
 
 ### Typography
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@scalably/ui",
-  "version": "0.1.0",
+  "version": "0.2.0",
   "description": "Scalably Design System - Shared UI Components",
   "type": "module",
   "main": "./dist/index.js",