Skip to content

docs: Reusable styled form component #583

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
wants to merge 10 commits into from
Closed

docs: Reusable styled form component #583

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
10 commits
Select commit Hold shift + click to select a range
c13e567
feat(reusable-styled-form-component): create base files for new react…
michaelbrusegard Jan 9, 2024
303cabf
chore: update text field component
michaelbrusegard Jan 9, 2024
fce47e8
feat: add checkbox field sub-component and seperated out error component
michaelbrusegard Jan 10, 2024
8215ded
feat: add custom select component
michaelbrusegard Jan 23, 2024
f9f349d
fix: select styling colors, checkbox outline and worked on example
michaelbrusegard Jan 24, 2024
136d733
chore: added Subscribe component and useStore context to update field…
michaelbrusegard Jan 24, 2024
b5e088d
feat: added Button ui component for form submissions
michaelbrusegard Jan 24, 2024
6ff929f
fix: multiple bugs and separate app component
michaelbrusegard Jan 26, 2024
1ef83ad
docs: wrote introduction and about the fundamental Form, Field and Su…
michaelbrusegard Jan 26, 2024
3d7ae2b
docs: Write the rest of documentation
michaelbrusegard Jan 26, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
321 changes: 321 additions & 0 deletions docs/framework/react/guides/reusable-styled-form-component.md
View file
Open in desktop

Large diffs are not rendered by default.

15 changes: 15 additions & 0 deletions examples/react/reusable-styled-form-component/.eslintrc.cjs
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
// @ts-check

/** @type {import('eslint').Linter.Config} */
const config = {
extends: ['plugin:react/recommended', 'plugin:react-hooks/recommended'],
parserOptions: {
tsconfigRootDir: __dirname,
project: './tsconfig.json',
},
rules: {
'react/no-children-prop': 'off',
},
}

module.exports = config
27 changes: 27 additions & 0 deletions examples/react/reusable-styled-form-component/.gitignore
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
# See https://help.github.com/articles/ignoring-files/ for more about ignoring files.

# dependencies
/node_modules
/.pnp
.pnp.js

# testing
/coverage

# production
/build

pnpm-lock.yaml
yarn.lock
package-lock.json

# misc
.DS_Store
.env.local
.env.development.local
.env.test.local
.env.production.local

npm-debug.log*
yarn-debug.log*
yarn-error.log*
6 changes: 6 additions & 0 deletions examples/react/reusable-styled-form-component/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
# Example

To run this example:

- `npm install`
- `npm run dev`
14 changes: 14 additions & 0 deletions examples/react/reusable-styled-form-component/index.html
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
<!doctype html>
<html class="h-full w-full" lang="en">
<head>
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1" />
<title>TanStack Reusable Styled Form Component</title>
<link rel="stylesheet" href="/src/index.css" />
</head>
<body class="h-full w-full bg-white dark:bg-black text-black dark:text-white">
<noscript>You need to enable JavaScript to run this app.</noscript>
<div class="h-full w-full" id="root"></div>
<script type="module" src="/src/index.tsx"></script>
</body>
</html>
29 changes: 29 additions & 0 deletions examples/react/reusable-styled-form-component/package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
{
"name": "@tanstack/reusable-styled-form-component",
"version": "0.0.1",
"main": "src/index.tsx",
"scripts": {
"dev": "vite --port=3001",
"build": "vite build",
"preview": "vite preview"
},
"dependencies": {
"@heroicons/react": "^2.1.1",
"@tanstack/react-form": "<1.0.0",
"@tanstack/zod-form-adapter": "<1.0.0",
"cva": "1.0.0-beta.1",
"react": "^18.0.0",
"react-dom": "^18.0.0",
"react-phone-number-input": "^3.3.8",
"zod": "^3.21.4"
},
"devDependencies": {
"@tailwindcss/forms": "^0.5.7",
"@vitejs/plugin-react": "^4.2.1",
"autoprefixer": "^10.4.16",
"postcss": "8.4.32",
"tailwind-merge": "^2.2.0",
"tailwindcss": "^3.4.1",
"vite": "^5.0.10"
}
}
6 changes: 6 additions & 0 deletions examples/react/reusable-styled-form-component/postcss.config.js
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
module.exports = {
plugins: {
tailwindcss: {},
autoprefixer: {},
},
}
22 changes: 22 additions & 0 deletions examples/react/reusable-styled-form-component/src/Button.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
import * as React from 'react'

import { type buttonVariantProps, buttonVariants } from './variants'

type ButtonProps = React.ButtonHTMLAttributes<HTMLButtonElement> &
buttonVariantProps

const Button = React.forwardRef<HTMLButtonElement, ButtonProps>(
({ className, base = true, variant, size, ...props }, ref) => {
return (
<button
className={buttonVariants({ className, base, variant, size })}
ref={ref}
{...props}
/>
)
},
)

Button.displayName = 'Button'

export { Button, type ButtonProps }
Loading