77![ npm bundle size (version)] ( https://img.shields.io/bundlephobia/minzip/react-creme )
88[ ![ codecov] ( https://codecov.io/gh/prabhuignoto/react-creme/branch/master/graph/badge.svg?token=JEL70TGE8Q )] ( https://codecov.io/gh/prabhuignoto/react-creme )
99[ ![ Snyk] ( https://snyk.io/test/github/prabhuignoto/react-creme/badge.svg )] ( https://snyk.io/test/github/prabhuignoto/react-creme )
10- [ ![ Quality Gate Status] ( https://sonarcloud.io/api/project_badges/measure?project=react-creme&metric=alert_status )] ( https://sonarcloud.io/summary/new_code?id=react-creme )
11- [ ![ CodeFactor] ( https://www.codefactor.io/repository/github/prabhuignoto/react-creme/badge )] ( https://www.codefactor.io/repository/github/prabhuignoto/react-creme )
12- [ ![ CodeQL] ( https://github.com/prabhuignoto/react-creme/actions/workflows/codeql-analysis.yml/badge.svg )] ( https://github.com/prabhuignoto/react-creme/actions/workflows/codeql-analysis.yml )
10+ <!-- [](https://sonarcloud.io/summary/new_code?id=react-creme) -->
11+ <!-- [](https://github.com/prabhuignoto/react-creme/actions/workflows/codeql-analysis.yml) -->
1312[ ![ dev status] ( https://img.shields.io/badge/status-beta-green )] ( https://img.shields.io/badge/status-beta-green )
1413[ ![ GitHub license] ( https://img.shields.io/github/license/prabhuignoto/react-creme )] ( https://github.com/prabhuignoto/react-creme/blob/master/LICENSE )
1514![ npm] ( https://img.shields.io/npm/v/react-creme )
@@ -23,100 +22,145 @@ Modern UI Toolkit for React
2322
2423[ Explore the Components] ( https://react-creme.vercel.app/ )
2524
26- <h2 >Features </h2 >
25+ <h2 >Highlights </h2 >
2726
28- - 💎 High Quality React components.
29-
30- - 💪 Robust components written in Typescript.
31-
32- - ♿ Accessible UI Components.
33-
34- - 🌈 57 UI Components.
35-
36- - 🛠️ Customizable components.
37-
38- - 🎨 Themeable components.
39-
40- - ⚙️ Minimal Third party dependencies.
41-
42- - 🪶 Tree-shakeable: Import only what you need (~ 12-20kb per component) or use the full library (~ 115kb gzipped with all 57 components and CSS).
27+ - 57 production-ready React components built with TypeScript 5.9 (strict).
28+ - Accessible by default with ARIA-friendly patterns and keyboard support.
29+ - CSS Modules, design tokens, and theming via ` ThemeProvider ` .
30+ - Namespaced entry points for tree-shaking; fully typed API surface.
31+ - Light dependency stack focused on React, TypeScript, and CSS Modules.
32+ - React 19 ready; ships ESM and CJS plus type declarations.
4333
4434<h2 >Table of Contents</h2 >
4535
36+ - [ ✨ Key Features] ( #-key-features )
37+ - [ 📦 Packaging & Bundles] ( #-packaging--bundles )
38+ - [ 🧰 Tooling & Quality] ( #-tooling--quality )
4639- [ 🚀 Getting Started] ( #-getting-started )
47- - [ ☕ Usage] ( #-usage )
40+ - [ ☕ Quick Usage] ( #-quick-usage )
41+ - [ 🎨 Theming] ( #-theming )
4842- [ 🌍 Browser Support] ( #-browser-support )
49- - [ 🍫 Examples & Documentation] ( #-examples--documentation )
50- - [ 🔨 Build] ( #-build )
51- - [ 🤝Contributing] ( #contributing )
43+ - [ 🍫 Documentation] ( #-documentation )
44+ - [ 🔨 Build & Test] ( #-build--test )
45+ - [ 🤝 Contributing] ( #-contributing )
46+
47+ ## ✨ Key Features
48+
49+ - Comprehensive component set: forms, navigation, overlays, data display, media, layout, disclosure, feedback, core primitives.
50+ - Theming-first: design tokens, CSS variables, and ` ThemeProvider ` to keep brand control.
51+ - Tree-shakeable namespaces to keep bundles lean; side effects minimized.
52+ - Accessibility baked in: keyboard interactions and sensible ARIA defaults.
53+ - Type-safe: emitted declarations for every entry point; IntelliSense-friendly.
54+
55+ ## 📦 Packaging & Bundles
56+
57+ - Package name: ` react-creme ` (unscoped).
58+ - Namespaced imports (recommended):
59+ - ` react-creme/core ` , ` react-creme/forms ` , ` react-creme/feedback ` , ` react-creme/data-display ` ,
60+ ` react-creme/navigation ` , ` react-creme/overlay ` , ` react-creme/layout ` , ` react-creme/disclosure ` ,
61+ ` react-creme/media ` .
62+ - Measured bundles (latest build):
63+ - Full ESM bundle: ~ 119 KB gzipped.
64+ - CSS bundle: ~ 47 KB gzipped.
65+ - Examples (ESM): core ~ 36 KB, forms ~ 80 KB, data-display ~ 88 KB, navigation ~ 64 KB, overlay ~ 60 KB.
66+ - Legacy root import ` react-creme ` remains for compatibility.
67+
68+ ## 🧰 Tooling & Quality
69+
70+ - Build: Vite 6 and Bun build pipeline; Turborepo for orchestration.
71+ - Linting: ESLint, Stylelint, Oxlint; format via Prettier.
72+ - Tests: Vitest + Testing Library; coverage tracked with Codecov.
73+ - Security and analysis: Snyk, SonarCloud, CodeQL, CodeFactor.
74+ - Supported runtimes: Node >= 20.18.1, Bun >= 1.1.0.
5275
5376## 🚀 Getting Started
5477
55- Install the package using npm or yarn
78+ Install with your preferred package manager:
5679
5780``` sh
58- yarn add react-creme
59-
60- or
61-
6281npm install react-creme
82+ yarn add react-creme
83+ pnpm add react-creme
84+ bun add react-creme
85+ ```
6386
87+ Import the bundled styles once (typically in your root entry point):
88+ ``` ts
89+ import ' react-creme/css' ;
6490```
6591
66- ## ☕ Usage
92+ Use namespaced entry points for tree-shaking:
6793
68- ``` sh
69- import { Button } from " react-creme" ;
94+ - ` react-creme/core ` — buttons, ThemeProvider, utilities
95+ - ` react-creme/forms ` — inputs, sliders, switches, file upload
96+ - ` react-creme/feedback ` — notifications, loaders, progress
97+ - ` react-creme/data-display ` — tables, tags, timelines
98+ - ` react-creme/navigation ` — tabs, breadcrumbs, menus
99+ - ` react-creme/overlay ` — dialogs, drawers, tooltips
100+ - ` react-creme/layout ` — layout primitives
101+ - ` react-creme/disclosure ` — accordion and collapsible surfaces
102+ - ` react-creme/media ` — media helpers
70103
71- const App = () => {
72- return (
73- < div>
74- < Button> Welcome to react-creme< /Button>
75- < /div>
76- );
77- };
104+ Full bundle (ESM) is ~ 119 KB gzipped; CSS bundle is ~ 47 KB gzipped. The legacy root import ` react-creme ` remains available for compatibility.
78105
79- export default App;
80- ` ` `
106+ ## ☕ Quick Usage
81107
82- # # 🌍 Browser Support
108+ ``` tsx
109+ import { Button , ThemeProvider } from " react-creme/core" ;
110+ import " react-creme/css" ;
83111
84- | ! [Chrome](https://raw.githubusercontent.com/alrra/browser-logos/master/src/chrome/chrome_48x48.png) | ! [Firefox](https://raw.githubusercontent.com/alrra/browser-logos/master/src/firefox/firefox_48x48.png) | ! [IE](https://raw.githubusercontent.com/alrra/browser-logos/master/src/edge/edge_48x48.png) | ! [Opera](https://raw.githubusercontent.com/alrra/browser-logos/master/src/opera/opera_48x48.png) | ! [Safari](https://raw.githubusercontent.com/alrra/browser-logos/master/src/safari/safari_48x48.png) |
85- | --------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------ | --------------------------------------------------------------------------------------------------- |
86- | Chrome | Firefox | Microsoft Edge | Opera | Safari |
112+ function App() {
113+ return (
114+ <ThemeProvider >
115+ <Button >Welcome to react-creme</Button >
116+ </ThemeProvider >
117+ );
118+ }
87119
88- # # 🍫 Examples & Documentation
120+ export default App ;
121+ ```
89122
90- For more thorough examples and the API details visit the [main site](https://react-creme.vercel.app)
123+ ## 🎨 Theming
91124
92- # # 🔨 Build
125+ Theme tokens are provided via ` ThemeProvider ` from ` react-creme/core ` . Define your palette, typography, and sizing once and components across namespaces inherit it. Example:
93126
94- To build everything
127+ ``` tsx
128+ import { ThemeProvider , Theme } from " react-creme/core" ;
129+ import { Input } from " react-creme/forms" ;
130+ import " react-creme/css" ;
95131
96- ` ` ` sh
97- bun build
132+ const theme: Theme = {
133+ colors: { primary: " #0074B7" },
134+ fontSizes: { md: 16 , sm: 14 },
135+ };
136+
137+ function App() {
138+ return (
139+ <ThemeProvider theme = { theme } >
140+ <Input placeholder = " Search" />
141+ </ThemeProvider >
142+ );
143+ }
98144```
99145
100- To build the library
146+ ## 🌍 Browser Support
101147
102- ` ` ` sh
103- bun build:lib
104- ` ` `
148+ | ![ Chrome ] ( https://raw.githubusercontent.com/alrra/browser-logos/master/src/chrome/chrome_48x48.png ) | ![ Firefox ] ( https://raw.githubusercontent.com/alrra/browser-logos/master/src/firefox/firefox_48x48.png ) | ![ IE ] ( https://raw.githubusercontent.com/alrra/browser-logos/master/src/edge/edge_48x48.png ) | ![ Opera ] ( https://raw.githubusercontent.com/alrra/browser-logos/master/src/opera/opera_48x48.png ) | ![ Safari ] ( https://raw.githubusercontent.com/alrra/browser-logos/master/src/safari/safari_48x48.png ) |
149+ | --------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------ | --------------------------------------------------------------------------------------------------- |
150+ | Chrome | Firefox | Microsoft Edge | Opera | Safari |
105151
106- To build and run the documentation
152+ ## 🍫 Documentation
107153
108- ` ` ` sh
109- bun build:doc
110- cd ./packages/documentation/expo_dist && bunx serve .
111- ` ` `
154+ Full docs, live examples, and API reference: [ react-creme.vercel.app] ( https://react-creme.vercel.app )
112155
113- To run the Unit tests
156+ ## 🔨 Build & Test
114157
115- ` ` ` sh
116- bun test
117- ` ` `
158+ - Build everything: ` bun build `
159+ - Build library only: ` bun build:lib `
160+ - Build docs: ` bun build:doc ` then ` cd packages/documentation/expo_dist && bunx serve . `
161+ - Tests: ` bun test `
118162
119- # # 🤝Contributing
163+ ## 🤝 Contributing
120164
121165Contributions, ideas and PR's are welcome!. Please read the [ guidelines] ( /CONTRIBUTING.md ) for more details.
122166
0 commit comments