@kingsimba/nc-ui 0.1.2 → 0.1.3
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +2 -46
- package/dist/index.cjs.map +1 -1
- package/dist/index.js.map +1 -1
- package/dist/styles.css +3 -0
- package/package.json +2 -1
package/README.md
CHANGED
|
@@ -2,8 +2,9 @@
|
|
|
2
2
|
|
|
3
3
|
A high-performance, lightweight React UI component library and extensible application framework.
|
|
4
4
|
|
|
5
|
+
- 🤖 **AI-Optimized**: Comprehensive [AI reference guide](AI_REFERENCE_GUIDE.md) included
|
|
5
6
|
- 🚀 **Small Footprint**: Only ~75KB bundle size.
|
|
6
|
-
- 🏗️ **Application Framework**: Features a flexible, extensible framework for building windowed apps.
|
|
7
|
+
- 🏗️ **[Application Framework](docs/APP_FRAMEWORK.md)**: Features a flexible, extensible framework for building windowed apps, with [app-specific i18n](./nc-ui-ai-reference/translation-guide.md)
|
|
7
8
|
- 📱 **Cross-Platform**: Optimized for both desktop and mobile experiences.
|
|
8
9
|
|
|
9
10
|
Published on npm as [@kingsimba/nc-ui](https://www.npmjs.com/package/@kingsimba/nc-ui)
|
|
@@ -182,51 +183,6 @@ The library uses CSS variables with `nc-` prefix. Override them in your app:
|
|
|
182
183
|
}
|
|
183
184
|
```
|
|
184
185
|
|
|
185
|
-
## Internationalization (i18n)
|
|
186
|
-
|
|
187
|
-
nc-ui components use `react-i18next` for translations. Components like `Dialog` and `ComboBox` use translation keys prefixed with `common.` (e.g., `common.ok`, `common.cancel`, `common.save`).
|
|
188
|
-
|
|
189
|
-
To provide translations, set up `react-i18next` in your app and include the common keys:
|
|
190
|
-
|
|
191
|
-
```tsx
|
|
192
|
-
// Your app's i18n setup
|
|
193
|
-
import i18n from 'i18next';
|
|
194
|
-
import { initReactI18next } from 'react-i18next';
|
|
195
|
-
|
|
196
|
-
i18n.use(initReactI18next).init({
|
|
197
|
-
resources: {
|
|
198
|
-
en: {
|
|
199
|
-
translation: {
|
|
200
|
-
common: {
|
|
201
|
-
ok: 'OK',
|
|
202
|
-
cancel: 'Cancel',
|
|
203
|
-
save: 'Save',
|
|
204
|
-
delete: 'Delete',
|
|
205
|
-
close: 'Close',
|
|
206
|
-
connect: 'Connect',
|
|
207
|
-
gotit: 'Got it',
|
|
208
|
-
default: 'default',
|
|
209
|
-
noResults: 'No results',
|
|
210
|
-
},
|
|
211
|
-
// ... your other translations
|
|
212
|
-
},
|
|
213
|
-
},
|
|
214
|
-
// Add other languages as needed
|
|
215
|
-
},
|
|
216
|
-
lng: 'en',
|
|
217
|
-
fallbackLng: 'en',
|
|
218
|
-
});
|
|
219
|
-
```
|
|
220
|
-
|
|
221
|
-
If translations are not provided, the raw keys (e.g., `common.ok`) will be displayed.
|
|
222
|
-
|
|
223
|
-
## Documentation
|
|
224
|
-
|
|
225
|
-
- **[Live Demo](https://kingsimba.github.io/nc-ui/)** - Interactive component playground with all props and variants
|
|
226
|
-
- **[AI Reference Guide](AI_REFERENCE_GUIDE.md)** - Comprehensive documentation for AI assistants (GitHub Copilot, Claude, etc.)
|
|
227
|
-
- **[App Framework Guide](docs/APP_FRAMEWORK.md)** - Complete guide to building panel-based applications
|
|
228
|
-
- **[Migration Guide](MIGRATION_GUIDE.md)** - Upgrading from previous versions
|
|
229
|
-
|
|
230
186
|
## Development
|
|
231
187
|
|
|
232
188
|
```bash
|