@safronman/ui-kit-inctagram 0.1.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/LICENSE +21 -0
- package/README.md +64 -0
- package/dist/components/ui/button.d.ts +10 -0
- package/dist/components/ui/typography.d.ts +17 -0
- package/dist/index.d.ts +4 -0
- package/dist/index.js +3154 -0
- package/dist/lib/utils.d.ts +2 -0
- package/dist/styles.css +1 -0
- package/package.json +113 -0
package/LICENSE
ADDED
|
@@ -0,0 +1,21 @@
|
|
|
1
|
+
MIT License
|
|
2
|
+
|
|
3
|
+
Copyright (c) 2026
|
|
4
|
+
|
|
5
|
+
Permission is hereby granted, free of charge, to any person obtaining a copy
|
|
6
|
+
of this software and associated documentation files (the "Software"), to deal
|
|
7
|
+
in the Software without restriction, including without limitation the rights
|
|
8
|
+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
|
9
|
+
copies of the Software, and to permit persons to whom the Software is
|
|
10
|
+
furnished to do so, subject to the following conditions:
|
|
11
|
+
|
|
12
|
+
The above copyright notice and this permission notice shall be included in all
|
|
13
|
+
copies or substantial portions of the Software.
|
|
14
|
+
|
|
15
|
+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
|
16
|
+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
|
17
|
+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
|
18
|
+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
|
19
|
+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
|
20
|
+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
|
21
|
+
SOFTWARE.
|
package/README.md
ADDED
|
@@ -0,0 +1,64 @@
|
|
|
1
|
+
# @safronman/ui-kit-inctagram
|
|
2
|
+
|
|
3
|
+
Reusable React UI components with ready-to-use styles.
|
|
4
|
+
|
|
5
|
+
## Installation
|
|
6
|
+
|
|
7
|
+
```bash
|
|
8
|
+
npm install @safronman/ui-kit-inctagram
|
|
9
|
+
```
|
|
10
|
+
|
|
11
|
+
or
|
|
12
|
+
|
|
13
|
+
```bash
|
|
14
|
+
pnpm add @safronman/ui-kit-inctagram
|
|
15
|
+
```
|
|
16
|
+
|
|
17
|
+
## Usage
|
|
18
|
+
|
|
19
|
+
Import styles once in your app entry:
|
|
20
|
+
|
|
21
|
+
```ts
|
|
22
|
+
import '@safronman/ui-kit-inctagram/styles.css'
|
|
23
|
+
```
|
|
24
|
+
|
|
25
|
+
Import components:
|
|
26
|
+
|
|
27
|
+
```tsx
|
|
28
|
+
import { Button, Typography } from '@safronman/ui-kit-inctagram'
|
|
29
|
+
|
|
30
|
+
export function Example() {
|
|
31
|
+
return (
|
|
32
|
+
<div>
|
|
33
|
+
<Typography variant="h1">UI Kit</Typography>
|
|
34
|
+
<Button>Click me</Button>
|
|
35
|
+
</div>
|
|
36
|
+
)
|
|
37
|
+
}
|
|
38
|
+
```
|
|
39
|
+
|
|
40
|
+
## Peer dependencies
|
|
41
|
+
|
|
42
|
+
- `react >= 18`
|
|
43
|
+
- `react-dom >= 18`
|
|
44
|
+
|
|
45
|
+
## Development scripts
|
|
46
|
+
|
|
47
|
+
- `pnpm dev` - run local dev app.
|
|
48
|
+
- `pnpm build` - build library JS and declaration files to `dist/`.
|
|
49
|
+
- `pnpm lint` - run ESLint.
|
|
50
|
+
- `pnpm storybook` - run Storybook.
|
|
51
|
+
- `pnpm build-storybook` - build static Storybook.
|
|
52
|
+
|
|
53
|
+
## Publishing
|
|
54
|
+
|
|
55
|
+
1. Create an npm automation token and add it to repository secrets as `NPM_TOKEN`.
|
|
56
|
+
2. Create a GitHub release with tag `vX.Y.Z` that matches `package.json` version.
|
|
57
|
+
3. Workflow will install dependencies, run `pnpm build`, `pnpm lint`, and publish to npm automatically.
|
|
58
|
+
4. Manual publish fallback:
|
|
59
|
+
|
|
60
|
+
```bash
|
|
61
|
+
pnpm build
|
|
62
|
+
pnpm lint
|
|
63
|
+
npm publish --access public
|
|
64
|
+
```
|
|
@@ -0,0 +1,10 @@
|
|
|
1
|
+
import * as React from 'react';
|
|
2
|
+
import { type VariantProps } from 'class-variance-authority';
|
|
3
|
+
declare const buttonVariants: (props?: ({
|
|
4
|
+
variant?: "primary" | "secondary" | "outline" | "text" | null | undefined;
|
|
5
|
+
size?: "default" | "xs" | "sm" | "lg" | "icon" | "icon-xs" | "icon-sm" | "icon-lg" | null | undefined;
|
|
6
|
+
} & import("class-variance-authority/types").ClassProp) | undefined) => string;
|
|
7
|
+
declare function Button({ className, variant, size, asChild, ...props }: React.ComponentProps<'button'> & VariantProps<typeof buttonVariants> & {
|
|
8
|
+
asChild?: boolean;
|
|
9
|
+
}): import("react/jsx-runtime").JSX.Element;
|
|
10
|
+
export { Button, buttonVariants };
|
|
@@ -0,0 +1,17 @@
|
|
|
1
|
+
import type { ComponentPropsWithoutRef, ElementType } from 'react';
|
|
2
|
+
type TypographyVariant = 'large' | 'h1' | 'h2' | 'h3' | 'regularText16' | 'boldText16' | 'regularText14' | 'mediumText14' | 'boldText14' | 'smallText' | 'smallTextSemibold' | 'regularLink' | 'smallLink';
|
|
3
|
+
type LinkVariant = 'regularLink' | 'smallLink';
|
|
4
|
+
type NonLinkVariant = Exclude<TypographyVariant, LinkVariant>;
|
|
5
|
+
type TypographyProps<T extends ElementType> = {
|
|
6
|
+
as?: T;
|
|
7
|
+
variant: NonLinkVariant;
|
|
8
|
+
className?: string;
|
|
9
|
+
} & Omit<ComponentPropsWithoutRef<T>, 'as' | 'className'>;
|
|
10
|
+
type TypographyLinkProps = {
|
|
11
|
+
as?: 'a';
|
|
12
|
+
variant: LinkVariant;
|
|
13
|
+
className?: string;
|
|
14
|
+
} & Omit<ComponentPropsWithoutRef<'a'>, 'as' | 'className'>;
|
|
15
|
+
export declare function Typography(props: TypographyLinkProps): React.JSX.Element;
|
|
16
|
+
export declare function Typography<T extends ElementType = 'p'>(props: TypographyProps<T>): React.JSX.Element;
|
|
17
|
+
export type { TypographyVariant };
|
package/dist/index.d.ts
ADDED