akku-kit 1.0.0-alpha.0 → 1.0.0-alpha.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 +110 -0
- package/dist/components/Form/SwitchButtonField/SwitchButtonField.d.ts +1 -1
- package/dist/components/Tabs/Tabs.d.ts +4 -0
- package/dist/components/Tabs/Tabs.stories.d.ts +20 -0
- package/dist/components/Tabs/Tabs.types.d.ts +12 -0
- package/dist/components/Tabs/index.d.ts +2 -0
- package/dist/components/Typography/Display/Display.stories.d.ts +1 -1
- package/dist/components/Typography/Display/Display.types.d.ts +1 -1
- package/dist/components/Typography/Label/Label.d.ts +4 -0
- package/dist/components/Typography/Label/Label.types.d.ts +9 -0
- package/dist/components/Typography/Label/index.d.ts +2 -0
- package/dist/components/Typography/Label/label.stories.d.ts +50 -0
- package/dist/index.cjs.js +5 -5
- package/dist/index.cjs.js.map +1 -1
- package/dist/index.d.ts +3 -0
- package/dist/index.esm.js +5 -5
- package/dist/index.esm.js.map +1 -1
- package/package.json +23 -5
package/README.md
ADDED
@@ -0,0 +1,110 @@
|
|
1
|
+
# ⚡️ akku-kit
|
2
|
+
|
3
|
+
akku-kit is a modern, TypeScript-based UI framework built specifically for Akku projects. It includes a growing collection of reusable, accessible, and customizable components.
|
4
|
+
|
5
|
+
## ✨ Features
|
6
|
+
|
7
|
+
- 🎯 Tailored for Akku ecosystem
|
8
|
+
- ⚡ Lightweight and performant
|
9
|
+
- 🎨 Theming and responsive design support
|
10
|
+
- 🧩 Ready-to-use UI components
|
11
|
+
- 🧪 Powered by TypeScript
|
12
|
+
|
13
|
+
## 📦 Components (v1.0.0)
|
14
|
+
|
15
|
+
- `Button`
|
16
|
+
- `Input`
|
17
|
+
- `Checkbox`
|
18
|
+
- `Radio`
|
19
|
+
- `Select`
|
20
|
+
- `Modal`
|
21
|
+
- `Avatar`
|
22
|
+
- `Badge`
|
23
|
+
- `Tooltip`
|
24
|
+
- `Tabs`
|
25
|
+
- `Card`
|
26
|
+
- `Switch`
|
27
|
+
- `Textarea`
|
28
|
+
- `Loader`
|
29
|
+
- `Alert`
|
30
|
+
- `Breadcrumb`
|
31
|
+
- `Pagination`
|
32
|
+
|
33
|
+
> More components coming in future releases.
|
34
|
+
|
35
|
+
## 📥 Installation
|
36
|
+
|
37
|
+
```bash
|
38
|
+
npm install akku-kit
|
39
|
+
```
|
40
|
+
|
41
|
+
## 🚀 Usage
|
42
|
+
|
43
|
+
```tsx
|
44
|
+
import { Button } from 'akku-kit';
|
45
|
+
|
46
|
+
export default function App() {
|
47
|
+
return <Button variant="primary">Click Me</Button>;
|
48
|
+
}
|
49
|
+
```
|
50
|
+
|
51
|
+
## 🧪 Run Storybook for Live Preview
|
52
|
+
|
53
|
+
```bash
|
54
|
+
npm start
|
55
|
+
# or
|
56
|
+
npm run storybook
|
57
|
+
```
|
58
|
+
|
59
|
+
## 🔖 Versioning Workflow
|
60
|
+
|
61
|
+
- `1.0.0-alpha.0`: First alpha build
|
62
|
+
- `1.0.0-alpha.1`: Second alpha build
|
63
|
+
- `1.0.0-beta.0`: First beta build
|
64
|
+
- `1.0.0-rc.0`: First release candidate
|
65
|
+
- `1.0.0`: Final stable release
|
66
|
+
|
67
|
+
## 🚚 Prerelease Workflow
|
68
|
+
|
69
|
+
Start a prerelease series:
|
70
|
+
|
71
|
+
```bash
|
72
|
+
npm version premajor --preid alpha
|
73
|
+
npm run build
|
74
|
+
npm publish --tag alpha
|
75
|
+
```
|
76
|
+
|
77
|
+
Next alpha releases:
|
78
|
+
|
79
|
+
```bash
|
80
|
+
npm version prerelease
|
81
|
+
npm run build
|
82
|
+
npm publish --tag alpha
|
83
|
+
```
|
84
|
+
|
85
|
+
Promote to beta:
|
86
|
+
|
87
|
+
```bash
|
88
|
+
npm version prerelease --preid beta
|
89
|
+
npm run build
|
90
|
+
npm publish --tag beta
|
91
|
+
```
|
92
|
+
|
93
|
+
Stable release:
|
94
|
+
|
95
|
+
```bash
|
96
|
+
npm version 2.0.0
|
97
|
+
npm run build
|
98
|
+
npm publish
|
99
|
+
```
|
100
|
+
|
101
|
+
## 🧑💻 Contribution
|
102
|
+
|
103
|
+
1. Clone the repo
|
104
|
+
2. Run `npm install`
|
105
|
+
3. Develop with `npm start`
|
106
|
+
4. Submit a PR!
|
107
|
+
|
108
|
+
---
|
109
|
+
|
110
|
+
License: MIT © 2025 akku-kit Team
|
@@ -1,4 +1,4 @@
|
|
1
1
|
import React from "react";
|
2
2
|
import type { ToggleButtonFieldProps } from "./SwitchButtonField.types";
|
3
|
-
declare const SwitchButtonField: React.FC<ToggleButtonFieldProps>;
|
3
|
+
export declare const SwitchButtonField: React.FC<ToggleButtonFieldProps>;
|
4
4
|
export default SwitchButtonField;
|
@@ -0,0 +1,20 @@
|
|
1
|
+
/// <reference types="react" />
|
2
|
+
import { StoryObj } from "@storybook/react";
|
3
|
+
import Tabs from "./Tabs";
|
4
|
+
import { TabsProps } from "./Tabs.types";
|
5
|
+
declare const meta: {
|
6
|
+
title: string;
|
7
|
+
component: import("react").FC<TabsProps>;
|
8
|
+
tags: string[];
|
9
|
+
argTypes: {
|
10
|
+
onChange: {
|
11
|
+
action: string;
|
12
|
+
};
|
13
|
+
};
|
14
|
+
};
|
15
|
+
export default meta;
|
16
|
+
type Story = StoryObj<typeof Tabs>;
|
17
|
+
export declare const Default: Story;
|
18
|
+
export declare const WithDisabledTab: Story;
|
19
|
+
export declare const WithInitialActiveTab: Story;
|
20
|
+
export declare const WithMultipleTabs: Story;
|
@@ -0,0 +1,12 @@
|
|
1
|
+
/// <reference types="react" />
|
2
|
+
export interface TabItem {
|
3
|
+
key: string;
|
4
|
+
label: string;
|
5
|
+
children: React.ReactNode;
|
6
|
+
disabled?: boolean;
|
7
|
+
}
|
8
|
+
export interface TabsProps {
|
9
|
+
activeKey: string;
|
10
|
+
items: TabItem[];
|
11
|
+
onChange: (key: string) => void;
|
12
|
+
}
|
@@ -7,7 +7,7 @@ declare const meta: {
|
|
7
7
|
tags: string[];
|
8
8
|
argTypes: {
|
9
9
|
variant: {
|
10
|
-
options: ("xs-semibold" | "sm-semibold" | "lg-semibold" | "md-semibold")[];
|
10
|
+
options: ("xs-semibold" | "xs-bold" | "sm-semibold" | "lg-semibold" | "md-semibold")[];
|
11
11
|
control: {
|
12
12
|
type: "radio";
|
13
13
|
};
|
@@ -1,5 +1,5 @@
|
|
1
1
|
/// <reference types="react" />
|
2
|
-
export type DisplayVariant = "xs-semibold" | "sm-semibold" | "lg-semibold" | "md-semibold";
|
2
|
+
export type DisplayVariant = "xs-semibold" | "xs-bold" | "sm-semibold" | "lg-semibold" | "md-semibold";
|
3
3
|
export type TextColor = "primary" | "secondary" | "tertiary" | "brand-600" | "brand-700" | "success" | "white" | "placeholder";
|
4
4
|
export type TextAlign = "left" | "center" | "right";
|
5
5
|
export type HeadingElement = "h1" | "h2" | "h3" | "h4" | "h5" | "h6" | "div";
|
@@ -0,0 +1,9 @@
|
|
1
|
+
/// <reference types="react" />
|
2
|
+
export interface LabelProps {
|
3
|
+
variant?: "xs-regular" | "xs-medium" | "xs-semibold" | "sm-regular" | "sm-medium" | "sm-semibold" | "md-regular" | "md-semibold" | "lg-semibold" | "lg-bold" | "xl-semibold";
|
4
|
+
required?: boolean;
|
5
|
+
children: React.ReactNode;
|
6
|
+
className?: string;
|
7
|
+
as?: React.ElementType;
|
8
|
+
}
|
9
|
+
export type LabelVariant = "xs-regular" | "xs-medium" | "xs-semibold" | "sm-regular" | "sm-medium" | "sm-semibold" | "md-regular" | "md-semibold" | "lg-semibold" | "lg-bold" | "xl-semibold";
|
@@ -0,0 +1,50 @@
|
|
1
|
+
/// <reference types="react" />
|
2
|
+
import { StoryObj } from "@storybook/react";
|
3
|
+
import Label from "./Label";
|
4
|
+
declare const meta: {
|
5
|
+
title: string;
|
6
|
+
component: import("react").FC<import("./Label.types").LabelProps>;
|
7
|
+
tags: string[];
|
8
|
+
argTypes: {
|
9
|
+
variant: {
|
10
|
+
options: ("xs-semibold" | "sm-semibold" | "lg-semibold" | "md-semibold" | "xs-medium" | "sm-regular" | "sm-medium" | "md-regular" | "lg-bold" | "xl-semibold" | "xs-regular")[];
|
11
|
+
control: {
|
12
|
+
type: "select";
|
13
|
+
};
|
14
|
+
};
|
15
|
+
required: {
|
16
|
+
control: "boolean";
|
17
|
+
};
|
18
|
+
as: {
|
19
|
+
options: string[];
|
20
|
+
control: {
|
21
|
+
type: "select";
|
22
|
+
};
|
23
|
+
};
|
24
|
+
children: {
|
25
|
+
control: "text";
|
26
|
+
};
|
27
|
+
};
|
28
|
+
args: {
|
29
|
+
variant: "sm-medium";
|
30
|
+
children: string;
|
31
|
+
};
|
32
|
+
};
|
33
|
+
export default meta;
|
34
|
+
type Story = StoryObj<typeof Label>;
|
35
|
+
export declare const Default: Story;
|
36
|
+
export declare const ExtraSmallRegular: Story;
|
37
|
+
export declare const ExtraSmallMedium: Story;
|
38
|
+
export declare const ExtraSmallSemiBold: Story;
|
39
|
+
export declare const SmallRegular: Story;
|
40
|
+
export declare const SmallSemibold: Story;
|
41
|
+
export declare const SmallMedium: Story;
|
42
|
+
export declare const MediumRegular: Story;
|
43
|
+
export declare const MediumSemibold: Story;
|
44
|
+
export declare const LargeSemibold: Story;
|
45
|
+
export declare const LargeBold: Story;
|
46
|
+
export declare const ExtraLargeSemibold: Story;
|
47
|
+
export declare const RequiredLabel: Story;
|
48
|
+
export declare const WithSpanElement: Story;
|
49
|
+
export declare const CenterAlignedLabel: Story;
|
50
|
+
export declare const SmallMediumRequired: Story;
|