@aristobyte-ui/utils 2.8.0 โ 2.8.1
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 +73 -0
- package/package.json +7 -1
package/README.md
ADDED
|
@@ -0,0 +1,73 @@
|
|
|
1
|
+
# `@aristobyte-ui/utils`
|
|
2
|
+
|
|
3
|
+
<p align="center">
|
|
4
|
+
<img src="https://img.shields.io/badge/TypeScript-5.8-blue?style=for-the-badge&logo=typescript&logoColor=white" alt="TypeScript" />
|
|
5
|
+
<img src="https://img.shields.io/badge/Build-Turbo-green?style=for-the-badge&logo=turbo&logoColor=white" alt="TurboRepo" />
|
|
6
|
+
<img src="https://img.shields.io/badge/Lint-Strict-red?style=for-the-badge&logo=eslint&logoColor=white" alt="ESLint" />
|
|
7
|
+
<img src="https://img.shields.io/badge/License-MIT-black?style=for-the-badge&logo=open-source-initiative&logoColor=white" alt="License" />
|
|
8
|
+
<img src="https://img.shields.io/badge/AristoByte-UI-purple?style=for-the-badge&logo=react&logoColor=white" alt="AristoByte UI" />
|
|
9
|
+
<img src="https://img.shields.io/badge/Node-20.17.0+-339933?style=for-the-badge&logo=node.js&logoColor=white" alt="Node.js >=20.17.0" />
|
|
10
|
+
<img src="https://img.shields.io/badge/Yarn-1.22+-2C8EBB?style=for-the-badge&logo=yarn&logoColor=white" alt="Yarn >=1.22" />
|
|
11
|
+
<img src="https://img.shields.io/badge/NPM-10.8+-CB3837?style=for-the-badge&logo=npm&logoColor=white" alt="NPM >=10.8" />
|
|
12
|
+
</p>
|
|
13
|
+
|
|
14
|
+
A collection of shared utility functions for AristoByte projects, designed to provide reusable helpers, streamline common operations, and ensure consistency across applications and packages.
|
|
15
|
+
|
|
16
|
+
## ๐ฆ Installation
|
|
17
|
+
|
|
18
|
+
```bash
|
|
19
|
+
# Install via Yarn
|
|
20
|
+
yarn add -D @aristobyte-ui/utils
|
|
21
|
+
|
|
22
|
+
# Or via npm
|
|
23
|
+
npm install -D @aristobyte-ui/utils
|
|
24
|
+
|
|
25
|
+
# Or via pnpm
|
|
26
|
+
pnpm add -D @aristobyte-ui/utils
|
|
27
|
+
```
|
|
28
|
+
|
|
29
|
+
## ๐ Usage
|
|
30
|
+
|
|
31
|
+
```tsx
|
|
32
|
+
import { Icons } from '@aristobyte-ui/utils';
|
|
33
|
+
|
|
34
|
+
export const Demo = () => (
|
|
35
|
+
<div>
|
|
36
|
+
<Icons.PaperCode size={18} color="#51a2ff" />
|
|
37
|
+
</div>
|
|
38
|
+
);
|
|
39
|
+
```
|
|
40
|
+
|
|
41
|
+
| Prop | Type | Default | Description |
|
|
42
|
+
| | - | -- | -- |
|
|
43
|
+
| size | `number` | `24` | Defines the spinner animation style |
|
|
44
|
+
| color | `"#000000"`, `"#24f7b2"`, Any hex color |
|
|
45
|
+
|
|
46
|
+
## ๐ Why This Matters
|
|
47
|
+
|
|
48
|
+
- **Performance-first:** Engineered with lightweight, GPU-accelerated CSS keyframes for smooth, non-blocking animations.
|
|
49
|
+
- **Fully typed:** TypeScript-first API ensures strict type safety and predictable integration across multiple projects.
|
|
50
|
+
- **AristoByteUI ready:** Fully interoperable with AristoByteโs design tokens, semantic color palette, and styling architecture.
|
|
51
|
+
- **Flexible:** Supports multiple animation types, semantic variants, and responsive sizing to fit any UI scenario.
|
|
52
|
+
|
|
53
|
+
## ๐ Philosophy
|
|
54
|
+
|
|
55
|
+
- **Modular architecture:** Components are built for maximum reusability and composability.
|
|
56
|
+
- **Declarative styling:** SCSS modules maintain a clean separation of concerns while leveraging design tokens.
|
|
57
|
+
- **Strict typing & runtime flexibility:** Type-safe props with optional runtime overrides.
|
|
58
|
+
- **Developer experience optimized:** Intuitive API with predictable behavior and minimal setup.
|
|
59
|
+
|
|
60
|
+
## ๐ License
|
|
61
|
+
|
|
62
|
+
[MIT](./LICENSE) ยฉ AristoByte
|
|
63
|
+
|
|
64
|
+
## ๐ก Shields Showcase
|
|
65
|
+
|
|
66
|
+
<p align="center">
|
|
67
|
+
<img src="https://img.shields.io/badge/Consistency-100%25-green?style=for-the-badge&logo=typescript" />
|
|
68
|
+
<img src="https://img.shields.io/badge/Maintained-Active-brightgreen?style=for-the-badge&logo=github" />
|
|
69
|
+
<img src="https://img.shields.io/badge/Strictness-High-critical?style=for-the-badge&logo=eslint" />
|
|
70
|
+
<img src="https://img.shields.io/badge/Declarations-Enabled-blue?style=for-the-badge&logo=typescript" />
|
|
71
|
+
<img src="https://img.shields.io/badge/Monorepo-Turbo-green?style=for-the-badge&logo=monorepo" />
|
|
72
|
+
<img src="https://img.shields.io/badge/Interop-ESM%2FCJS-orange?style=for-the-badge&logo=javascript" />
|
|
73
|
+
</p>
|
package/package.json
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@aristobyte-ui/utils",
|
|
3
3
|
"description": "A collection of shared utility functions for AristoByte projects, designed to provide reusable helpers, streamline common operations, and ensure consistency across applications and packages.",
|
|
4
|
-
"version": "2.8.
|
|
4
|
+
"version": "2.8.1",
|
|
5
5
|
"license": "MIT",
|
|
6
6
|
"private": false,
|
|
7
7
|
"author": "AristoByte <info@aristobyte.com>",
|
|
@@ -37,6 +37,12 @@
|
|
|
37
37
|
"aristobyte-ui.settings.scss"
|
|
38
38
|
],
|
|
39
39
|
"exports": {
|
|
40
|
+
".": {
|
|
41
|
+
"types": "./es/index.d.ts",
|
|
42
|
+
"import": "./es/index.js",
|
|
43
|
+
"require": "./lib/index.js"
|
|
44
|
+
},
|
|
45
|
+
"./package.json": "./package.json",
|
|
40
46
|
"./styles": "./aristobyte-ui.settings.scss"
|
|
41
47
|
},
|
|
42
48
|
"publishConfig": {
|