@codezee/sixtify-brahma 0.1.1 → 0.2.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 +48 -39
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -1,28 +1,17 @@
|
|
|
1
|
-
#
|
|
1
|
+
# @codezee/sixtify-brahama
|
|
2
2
|
|
|
3
|
-
|
|
3
|
+
A React package that simplifies form creation and table management!
|
|
4
|
+
This package leverages react-hook-form and AG Grid to provide a comprehensive set of input fields and components for building dynamic and powerful forms.
|
|
5
|
+
It also includes a complete Storybook for all components to help you explore and integrate them easily.
|
|
4
6
|
|
|
5
|
-
##
|
|
7
|
+
## Features
|
|
8
|
+
- Integrates seamlessly with react-hook-form for form handling.
|
|
9
|
+
- Includes AG Grid for powerful table management.
|
|
10
|
+
- A wide variety of input components to suit all your needs.
|
|
11
|
+
- Fully documented with Storybook.
|
|
6
12
|
|
|
7
|
-
Run the following command:
|
|
8
13
|
|
|
9
|
-
|
|
10
|
-
npx create-turbo@latest
|
|
11
|
-
```
|
|
12
|
-
|
|
13
|
-
## What's inside?
|
|
14
|
-
|
|
15
|
-
This Turborepo includes the following packages/apps:
|
|
16
|
-
|
|
17
|
-
### Apps and Packages
|
|
18
|
-
|
|
19
|
-
- `docs`: a [Next.js](https://nextjs.org/) app
|
|
20
|
-
- `web`: another [Next.js](https://nextjs.org/) app
|
|
21
|
-
- `@repo/ui`: a stub React component library shared by both `web` and `docs` applications
|
|
22
|
-
- `@repo/eslint-config`: `eslint` configurations (includes `eslint-config-next` and `eslint-config-prettier`)
|
|
23
|
-
- `@repo/typescript-config`: `tsconfig.json`s used throughout the monorepo
|
|
24
|
-
|
|
25
|
-
Each package/app is 100% [TypeScript](https://www.typescriptlang.org/).
|
|
14
|
+
This package is 100% [TypeScript](https://www.typescriptlang.org/).
|
|
26
15
|
|
|
27
16
|
### Utilities
|
|
28
17
|
|
|
@@ -32,24 +21,6 @@ This Turborepo has some additional tools already setup for you:
|
|
|
32
21
|
- [ESLint](https://eslint.org/) for code linting
|
|
33
22
|
- [Prettier](https://prettier.io) for code formatting
|
|
34
23
|
|
|
35
|
-
### Build
|
|
36
|
-
|
|
37
|
-
To build all apps and packages, run the following command:
|
|
38
|
-
|
|
39
|
-
```
|
|
40
|
-
cd my-turborepo
|
|
41
|
-
pnpm build
|
|
42
|
-
```
|
|
43
|
-
|
|
44
|
-
### Develop
|
|
45
|
-
|
|
46
|
-
To develop all apps and packages, run the following command:
|
|
47
|
-
|
|
48
|
-
```
|
|
49
|
-
cd my-turborepo
|
|
50
|
-
pnpm dev
|
|
51
|
-
```
|
|
52
|
-
|
|
53
24
|
### Remote Caching
|
|
54
25
|
|
|
55
26
|
Turborepo can use a technique known as [Remote Caching](https://turbo.build/repo/docs/core-concepts/remote-caching) to share cache artifacts across machines, enabling you to share build caches with your team and CI/CD pipelines.
|
|
@@ -79,3 +50,41 @@ Learn more about the power of Turborepo:
|
|
|
79
50
|
- [Filtering](https://turbo.build/repo/docs/core-concepts/monorepos/filtering)
|
|
80
51
|
- [Configuration Options](https://turbo.build/repo/docs/reference/configuration)
|
|
81
52
|
- [CLI Usage](https://turbo.build/repo/docs/reference/command-line-reference)
|
|
53
|
+
|
|
54
|
+
|
|
55
|
+
|
|
56
|
+
|
|
57
|
+
## Installation
|
|
58
|
+
|
|
59
|
+
Install the package using pnpm:
|
|
60
|
+
|
|
61
|
+
```sh
|
|
62
|
+
pnpm install @codezee/sixtify-brahama
|
|
63
|
+
```
|
|
64
|
+
|
|
65
|
+
## Usage
|
|
66
|
+
|
|
67
|
+
Import the package in your React component:
|
|
68
|
+
|
|
69
|
+
```jsx
|
|
70
|
+
import { TextField } from '@codezee/sixtify-brahama';
|
|
71
|
+
import { useForm } from 'react-hook-form';
|
|
72
|
+
|
|
73
|
+
function MyComponent() {
|
|
74
|
+
const { control } = useForm({
|
|
75
|
+
defaultValues: {
|
|
76
|
+
name: 'John Doe',
|
|
77
|
+
},
|
|
78
|
+
});
|
|
79
|
+
|
|
80
|
+
return (
|
|
81
|
+
<TextField name="name" label="Name" control={control} />
|
|
82
|
+
);
|
|
83
|
+
}
|
|
84
|
+
```
|
|
85
|
+
|
|
86
|
+
|
|
87
|
+
## Documentation
|
|
88
|
+
|
|
89
|
+
For detailed usage and examples, check out the full documentation:
|
|
90
|
+
[See Documentation](https://hardikranpariya.github.io/sixtify-brahma/)
|