Skip to content

Commit cd7fa11

Browse files
nishkohli96nish-kellton
nishkohli96
and
nish-kellton
authored
v1.0.2 - Reorganise imports & update docs (#6)
* update pkg.json & README * npm pkg generation, modules update * reorganise components * organize component imports * fix datePicker imports * wip * fix demo forms * correct forms and docs * update docs wip * RHFColorPicker docs updated * update RHFRichTextEditor docs * mv docs files * lint docs and demo * update readme * def types * rename miscellaneous to misc * correct changes * update pkg build scripts * fix ConfigProvider bug * Fix Initial Installation & build issues * add customizated textfield link * dark theme switch from btn * publish pkg cmd * build scripts * update README --------- Co-authored-by: nishant.kohli <[email protected]>
1 parent 36c4735 commit cd7fa11

File tree

123 files changed

+1508
-1289
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

123 files changed

+1508
-1289
lines changed

‎.github/workflows/build-demo.yml

+3-5
Original file line numberDiff line numberDiff line change
@@ -12,9 +12,7 @@ jobs:
1212
with:
1313
node-version: 20
1414
cache: yarn
15-
- name: Install dependencies
16-
run: yarn install --frozen-lockfile
17-
- name: Build Package
18-
run: yarn lib:build
19-
- name: Build Examples
15+
- name: Setup App
16+
run: sh setup.sh
17+
- name: Build Next App
2018
run: yarn demo:build

‎.github/workflows/build-docs.yml

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
name: Build Docusaurus Site
1+
name: Build Docs Website
22
on: [push]
33
jobs:
44
build-docs:

‎.github/workflows/release-package.yml

-27
This file was deleted.

‎.gitignore

+4-2
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@ coverage
2727
*.log
2828
.pnp.js
2929
*.pem
30-
30+
*.tgz
3131

3232
# IDEs and editors
3333
/.idea
@@ -48,4 +48,6 @@ coverage
4848
# log files
4949
npm-debug.log*
5050
yarn-debug.log*
51-
yarn-error.log*
51+
yarn-error.log*
52+
53+
publish-pkg.sh

‎README.md

+20-1
Original file line numberDiff line numberDiff line change
@@ -8,4 +8,23 @@
88

99
To view the documentation for this package, visit [https://rhf-mui-components.netlify.app/](https://rhf-mui-components.netlify.app/).
1010

11-
To explore and interact with the form components, visit the[https://rhf-mui-components-examples.netlify.app/](https://rhf-mui-components-examples.netlify.app/).
11+
To explore and interact with the form components, visit the [https://rhf-mui-components-examples.netlify.app/](https://rhf-mui-components-examples.netlify.app/).
12+
13+
## Setup
14+
Run the setup script.
15+
16+
```bash
17+
sh setup.sh
18+
```
19+
20+
This will perform the following tasks:
21+
22+
- Install `node_modules` in workspace root
23+
- Build the `@nish1896/rhf-mui-components` package.
24+
- Link this package to `@nish1896/rhf-mui-components-examples` repo to test new and existing components
25+
26+
To apply any changes made to the package, rebuild it by running the command below:
27+
28+
```
29+
yarn lib:build
30+
```

‎apps/rhf-mui-demo/README.md

+5-1
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,7 @@
11
# @nish1896/rhf-mui-components-examples
22

3-
View examples for all the components included in [@nish1896/rhf-mui-components](https://www.npmjs.com/package/@nish1896/rhf-mui-components) on [https://rhf-mui-components-examples.netlify.app/](https://rhf-mui-components-examples.netlify.app/).
3+
**The repo to play around with this package when in development 🛠️.**
4+
5+
View examples for all the components included in [@nish1896/rhf-mui-components](https://www.npmjs.com/package/@nish1896/rhf-mui-components) on [https://rhf-mui-components-examples.netlify.app/](https://rhf-mui-components-examples.netlify.app/).
6+
7+
To browse the documentation, visit [https://rhf-mui-components.netlify.app](https://rhf-mui-components.netlify.app).

‎apps/rhf-mui-demo/package.json

+6-5
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"name": "@nish1896/rhf-mui-components-examples",
3-
"version": "1.0.0",
3+
"version": "1.0.2",
44
"private": true,
55
"author": "Nishant Kohli",
66
"scripts": {
@@ -10,28 +10,29 @@
1010
"lint": "next lint --fix"
1111
},
1212
"dependencies": {
13+
"@ckeditor/ckeditor5-react": "^9.0.0",
1314
"@emotion/cache": "^11.11.0",
1415
"@emotion/react": "^11.11.4",
1516
"@emotion/styled": "^11.11.5",
1617
"@hookform/resolvers": "^3.9.0",
17-
"@nish1896/rhf-mui-components": "*",
1818
"@mui/icons-material": "^5.15.19",
1919
"@mui/material": "^5.15.19",
2020
"@mui/material-nextjs": "^5.15.11",
2121
"@mui/x-date-pickers": "^7.7.0",
22-
"class-validator": "^0.14.1",
22+
"ckeditor5": "^43.0.0",
2323
"class-transformer": "^0.5.1",
24+
"class-validator": "^0.14.1",
2425
"date-fns": "^3.6.0",
25-
"dayjs":"^1.11.11",
26+
"dayjs": "^1.11.11",
2627
"joi": "^17.13.1",
2728
"luxon": "^3.4.4",
2829
"moment": "^2.30.1",
2930
"next": "14.2.3",
3031
"react": "^18",
3132
"react-color-palette": "7.2.2",
3233
"react-dom": "^18",
33-
"react-json-view": "^1.21.3",
3434
"react-hook-form": "^7.53.0",
35+
"react-json-view": "^1.21.3",
3536
"sharp": "^0.33.5",
3637
"superstruct": "^2.0.2",
3738
"yup": "^1.4.0",

‎apps/rhf-mui-demo/src/app/complete-form/page.tsx

+1-1
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ import { DocsLinks, SourceCodeLinks, CodeSandboxLinks, ValidationLibLinks } from
66
const ClientForm = dynamic(() => import('@/forms/complete-form-with-joi'), { ssr: false });
77

88
const title = 'Complete Form with Joi';
9-
const description = 'A complete form showcasing all components from this package';
9+
const description = 'A complete form showcasing all components from this package!';
1010

1111
export const metadata: Metadata = {
1212
title,

‎apps/rhf-mui-demo/src/app/customization/page.tsx

+1
Original file line numberDiff line numberDiff line change
@@ -21,6 +21,7 @@ export default function CustomizationPage() {
2121
];
2222
const codeLinks = [
2323
SourceCodeLinks.customization,
24+
SourceCodeLinks.styledTextField,
2425
CodeSandboxLinks.customization
2526
];
2627
return (

‎apps/rhf-mui-demo/src/app/textfield-and-passwordinput/page.tsx

+2-2
Original file line numberDiff line numberDiff line change
@@ -3,11 +3,11 @@ import dynamic from 'next/dynamic';
33
import { ContentContainer, LinksList, PageHeading, SubHeading } from '@/components';
44
import { DocsLinks, SourceCodeLinks, CodeSandboxLinks } from '@/constants';
55

6-
const ClientForm = dynamic(() => import('@/forms/inputs-with-register-options'), { ssr: false });
7-
86
const title = 'TextField & PasswordInput';
97
const description = 'Form utilizing RHFTextField and RHFPasswordInput with validation managed via react-hook-form\'s register options.';
108

9+
const ClientForm = dynamic(() => import('@/forms/inputs-with-register-options'), { ssr: false });
10+
1111
export const metadata: Metadata = {
1212
title,
1313
description

‎apps/rhf-mui-demo/src/constants/docs-links.ts

+15-15
Original file line numberDiff line numberDiff line change
@@ -4,62 +4,62 @@ import { ENV_VARS } from './env-vars';
44
export const DocsLinks: Record<string, PageInfo> = {
55
rhfTextField: {
66
title: 'RHFTextField',
7-
href: `${ENV_VARS.DOCS_URL}components/inputs/RHFTextField`
7+
href: `${ENV_VARS.DOCS_URL}components/mui/RHFTextField`
88
},
99
rhfPasswordField: {
1010
title: 'RHFPasswordInput',
11-
href: `${ENV_VARS.DOCS_URL}components/inputs/RHFPasswordInput`
11+
href: `${ENV_VARS.DOCS_URL}components/mui/RHFPasswordInput`
1212
},
1313
rhfSelect: {
1414
title: 'RHFSelect',
15-
href: `${ENV_VARS.DOCS_URL}components/select/RHFSelect`
15+
href: `${ENV_VARS.DOCS_URL}components/mui/RHFSelect`
1616
},
1717
rhfNativeSelect: {
1818
title: 'RHFNativeSelect',
19-
href: `${ENV_VARS.DOCS_URL}components/select/RHFNativeSelect`
19+
href: `${ENV_VARS.DOCS_URL}components/mui/RHFNativeSelect`
2020
},
2121
rhfCheckbox: {
2222
title: 'RHFCheckbox',
23-
href: `${ENV_VARS.DOCS_URL}components/checkbox/RHFCheckbox`
23+
href: `${ENV_VARS.DOCS_URL}components/mui/RHFCheckbox`
2424
},
2525
rhfCheckboxGroup: {
2626
title: 'RHFCheckboxGroup',
27-
href: `${ENV_VARS.DOCS_URL}components/checkbox/RHFCheckboxGroup`
27+
href: `${ENV_VARS.DOCS_URL}components/mui/RHFCheckboxGroup`
2828
},
2929
rhfSlider: {
3030
title: 'RHFSlider',
31-
href: `${ENV_VARS.DOCS_URL}components/input-controls/RHFSlider`
31+
href: `${ENV_VARS.DOCS_URL}components/mui/RHFSlider`
3232
},
3333
rhfSwitch: {
3434
title: 'RHFSwitch',
35-
href: `${ENV_VARS.DOCS_URL}components/input-controls/RHFSwitch`
35+
href: `${ENV_VARS.DOCS_URL}components/mui/RHFSwitch`
3636
},
3737
rhfRating: {
3838
title: 'RHFRating',
39-
href: `${ENV_VARS.DOCS_URL}components/input-controls/RHFRating`
39+
href: `${ENV_VARS.DOCS_URL}components/mui/RHFRating`
4040
},
4141
rhfRadioGroup: {
4242
title: 'RHFRadioGroup',
43-
href: `${ENV_VARS.DOCS_URL}components/input-controls/RHFRadioGroup`
43+
href: `${ENV_VARS.DOCS_URL}components/mui/RHFRadioGroup`
4444
},
4545
rhfDatePicker: {
4646
title: 'RHFDatePicker',
47-
href: `${ENV_VARS.DOCS_URL}components/pickers/RHFDatePicker`
47+
href: `${ENV_VARS.DOCS_URL}components/mui-pickers/RHFDatePicker`
4848
},
4949
rhfTimePicker: {
5050
title: 'RHFTimePicker',
51-
href: `${ENV_VARS.DOCS_URL}components/pickers/RHFTimePicker`
51+
href: `${ENV_VARS.DOCS_URL}components/mui-pickers/RHFTimePicker`
5252
},
5353
rhfDateTimePicker: {
5454
title: 'RHFDateTimePicker',
55-
href: `${ENV_VARS.DOCS_URL}components/pickers/RHFDateTimePicker`
55+
href: `${ENV_VARS.DOCS_URL}components/mui-pickers/RHFDateTimePicker`
5656
},
5757
rhfColorPicker: {
5858
title: 'RHFColorPicker',
59-
href: `${ENV_VARS.DOCS_URL}components/miscellaneous/RHFColorPicker`
59+
href: `${ENV_VARS.DOCS_URL}components/misc/RHFColorPicker`
6060
},
6161
rhfRichTextEditor: {
6262
title: 'RHFRichTextEditor',
63-
href: `${ENV_VARS.DOCS_URL}components/miscellaneous/RHFRichTextEditor`
63+
href: `${ENV_VARS.DOCS_URL}components/misc/RHFRichTextEditor`
6464
}
6565
};

‎apps/rhf-mui-demo/src/constants/source-code-links.ts

+5-1
Original file line numberDiff line numberDiff line change
@@ -31,9 +31,13 @@ export const SourceCodeLinks: Record<string, Page> = {
3131
href: `${commonRoute}/miscellaneous-components/index.tsx`
3232
},
3333
customization: {
34-
title: 'Styled Form with reusable component',
34+
title: 'Styled Form with Reusable TextField',
3535
href: `${commonRoute}/styled-form-with-reusable-component/index.tsx`
3636
},
37+
styledTextField: {
38+
title: 'Reusable TextField',
39+
href: `${commonRoute}/styled-form-with-reusable-component/StyledTextField.tsx`
40+
},
3741
completeForm: {
3842
title: 'Complete Form with Joi',
3943
href: `${commonRoute}/complete-form-with-joi/index.tsx`

‎apps/rhf-mui-demo/src/forms/checkbox-and-radiogroup-with-zod/index.tsx

+3-5
Original file line numberDiff line numberDiff line change
@@ -3,11 +3,9 @@
33
import { useForm } from 'react-hook-form';
44
import { zodResolver } from '@hookform/resolvers/zod';
55
import Grid from '@mui/material/Grid';
6-
import {
7-
RHFCheckbox,
8-
RHFCheckboxGroup,
9-
RHFRadioGroup
10-
} from '@nish1896/rhf-mui-components';
6+
import RHFCheckbox from '@nish1896/rhf-mui-components/mui/checkbox';
7+
import RHFCheckboxGroup from '@nish1896/rhf-mui-components/mui/checkbox-group';
8+
import RHFRadioGroup from '@nish1896/rhf-mui-components/mui/radio-group';
119
import {
1210
FormContainer,
1311
RenderFormState,

0 commit comments

Comments
 (0)