@aristobyte-ui/card 1.0.43
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 +81 -0
- package/package.json +83 -0
package/README.md
ADDED
|
@@ -0,0 +1,81 @@
|
|
|
1
|
+
# @aristobyte-ui/anchor
|
|
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 fully-typed, ripple-enabled Anchor component for AristoByteUI with multiple variants and seamless integration with SCSS modules and design tokens.
|
|
15
|
+
|
|
16
|
+
## 📦 Installation
|
|
17
|
+
|
|
18
|
+
```bash
|
|
19
|
+
# Install via Yarn
|
|
20
|
+
yarn add -D @aristobyte-ui/anchor
|
|
21
|
+
|
|
22
|
+
# Or via npm
|
|
23
|
+
npm install -D @aristobyte-ui/anchor
|
|
24
|
+
|
|
25
|
+
# Or via pnpm
|
|
26
|
+
pnpm add -D @aristobyte-ui/anchor
|
|
27
|
+
```
|
|
28
|
+
|
|
29
|
+
## 🛠 Usage
|
|
30
|
+
|
|
31
|
+
```tsx
|
|
32
|
+
import { Anchor } from "@aristobyte-ui/anchor";
|
|
33
|
+
|
|
34
|
+
<Anchor href="https://aristobyte.com" variant="primary">
|
|
35
|
+
Visit AristoByte
|
|
36
|
+
</Anchor>;
|
|
37
|
+
```
|
|
38
|
+
|
|
39
|
+
##
|
|
40
|
+
|
|
41
|
+
📂 Presets Available
|
|
42
|
+
**Variants**: `default` | `primary` | `secondary`
|
|
43
|
+
|
|
44
|
+
Ripple effect automatically applied on click
|
|
45
|
+
|
|
46
|
+
## 🔧 Example in a Package
|
|
47
|
+
|
|
48
|
+
```tsx
|
|
49
|
+
<Anchor href="/docs" variant="secondary">
|
|
50
|
+
Documentation
|
|
51
|
+
</Anchor>
|
|
52
|
+
```
|
|
53
|
+
|
|
54
|
+
## 📊 Why This Matters
|
|
55
|
+
|
|
56
|
+
- **Performance-first**: Lightweight CSS ensures fast rendering and smooth transitions.
|
|
57
|
+
- **Fully typed**: TypeScript-first API ensures predictable usage and IDE autocomplete.
|
|
58
|
+
- **AristoByteUI ready**: Seamlessly integrates with design tokens and SCSS modules.
|
|
59
|
+
- **Flexible**: Supports multiple variants and ripple-enabled interactive feedback.
|
|
60
|
+
|
|
61
|
+
## 🏆 Philosophy
|
|
62
|
+
|
|
63
|
+
- **Modular architecture**: Anchor component is fully composable.
|
|
64
|
+
- **Declarative styling**: SCSS modules keep styles maintainable and scoped.
|
|
65
|
+
- **Strict typing & runtime flexibility**: Props fully typed while allowing runtime overrides.
|
|
66
|
+
- **Developer experience optimized**: Easy to use with predictable behavior and minimal boilerplate.
|
|
67
|
+
|
|
68
|
+
## 📜 License
|
|
69
|
+
|
|
70
|
+
[MIT](./LICENSE) © AristoByte
|
|
71
|
+
|
|
72
|
+
## 🛡 Shields Showcase
|
|
73
|
+
|
|
74
|
+
<p align="center">
|
|
75
|
+
<img src="https://img.shields.io/badge/Consistency-100%25-green?style=for-the-badge&logo=typescript" />
|
|
76
|
+
<img src="https://img.shields.io/badge/Maintained-Active-brightgreen?style=for-the-badge&logo=github" />
|
|
77
|
+
<img src="https://img.shields.io/badge/Strictness-High-critical?style=for-the-badge&logo=eslint" />
|
|
78
|
+
<img src="https://img.shields.io/badge/Declarations-Enabled-blue?style=for-the-badge&logo=typescript" />
|
|
79
|
+
<img src="https://img.shields.io/badge/Monorepo-Turbo-green?style=for-the-badge&logo=monorepo" />
|
|
80
|
+
<img src="https://img.shields.io/badge/Interop-ESM%2FCJS-orange?style=for-the-badge&logo=javascript" />
|
|
81
|
+
</p>
|
package/package.json
ADDED
|
@@ -0,0 +1,83 @@
|
|
|
1
|
+
{
|
|
2
|
+
"name": "@aristobyte-ui/card",
|
|
3
|
+
"description": "AristoByteUI Card component: a versatile container for displaying content and UI elements.",
|
|
4
|
+
"version": "1.0.43",
|
|
5
|
+
"license": "MIT",
|
|
6
|
+
"private": false,
|
|
7
|
+
"author": "AristoByte <info@aristobyte.com>",
|
|
8
|
+
"homepage": "https://www.npmjs.com/package/@aristobyte-ui/card",
|
|
9
|
+
"repository": {
|
|
10
|
+
"type": "git",
|
|
11
|
+
"url": "git+https://github.com/aristobyte-team/aristobyte-ui.git",
|
|
12
|
+
"directory": "packages/card"
|
|
13
|
+
},
|
|
14
|
+
"bugs": {
|
|
15
|
+
"url": "https://github.com/aristobyte-team/aristobyte-ui.git/issues"
|
|
16
|
+
},
|
|
17
|
+
"engines": {
|
|
18
|
+
"node": ">=20.17.0",
|
|
19
|
+
"npm": ">=10.8.2",
|
|
20
|
+
"yarn": ">=1.22.22"
|
|
21
|
+
},
|
|
22
|
+
"keywords": [
|
|
23
|
+
"aristobyte",
|
|
24
|
+
"aristobyte-ui",
|
|
25
|
+
"card",
|
|
26
|
+
"link",
|
|
27
|
+
"button",
|
|
28
|
+
"ripple",
|
|
29
|
+
"typescript",
|
|
30
|
+
"scss",
|
|
31
|
+
"react",
|
|
32
|
+
"ui-component",
|
|
33
|
+
"component-library",
|
|
34
|
+
"frontend",
|
|
35
|
+
"ui-kit"
|
|
36
|
+
],
|
|
37
|
+
"files": [
|
|
38
|
+
"dist"
|
|
39
|
+
],
|
|
40
|
+
"publishConfig": {
|
|
41
|
+
"access": "public"
|
|
42
|
+
},
|
|
43
|
+
"main": "dist/index.js",
|
|
44
|
+
"module": "dist/index.mjs",
|
|
45
|
+
"types": "dist/index.d.ts",
|
|
46
|
+
"exports": {
|
|
47
|
+
".": {
|
|
48
|
+
"import": "./dist/index.mjs",
|
|
49
|
+
"require": "./dist/index.js"
|
|
50
|
+
}
|
|
51
|
+
},
|
|
52
|
+
"scripts": {
|
|
53
|
+
"build": "tsup",
|
|
54
|
+
"lint": "eslint . --max-warnings 0",
|
|
55
|
+
"generate:component": "turbo gen react-component",
|
|
56
|
+
"check-types": "tsc --noEmit"
|
|
57
|
+
},
|
|
58
|
+
"dependencies": {
|
|
59
|
+
"@aristobyte-ui/utils": "^1.0.43",
|
|
60
|
+
"esbuild-sass-plugin": "^3.3.1",
|
|
61
|
+
"framer-motion": "^12.23.9",
|
|
62
|
+
"react": "^19.1.0",
|
|
63
|
+
"react-dom": "^19.1.0",
|
|
64
|
+
"sass": "^1.89.0",
|
|
65
|
+
"shiki": "^3.7.0",
|
|
66
|
+
"tsup": "^8.5.0"
|
|
67
|
+
},
|
|
68
|
+
"devDependencies": {
|
|
69
|
+
"@aristobyte-ui/eslint-config": "^1.0.43",
|
|
70
|
+
"@aristobyte-ui/typescript-config": "^1.0.43",
|
|
71
|
+
"@turbo/gen": "^2.5.0",
|
|
72
|
+
"@types/node": "^24.3.0",
|
|
73
|
+
"@types/react": "19.1.0",
|
|
74
|
+
"@types/react-dom": "19.1.1",
|
|
75
|
+
"autoprefixer": "^10.4.21",
|
|
76
|
+
"eslint": "^9.27.0",
|
|
77
|
+
"postcss": "^8.5.3",
|
|
78
|
+
"sass-embedded": "^1.91.0",
|
|
79
|
+
"tailwindcss": "^4.1.7",
|
|
80
|
+
"tsup": "^8.5.0",
|
|
81
|
+
"typescript": "^5.8.3"
|
|
82
|
+
}
|
|
83
|
+
}
|