Dataform is a powerful, lightweight, and flexible form builder library for React applications, designed to make it easy to create and manage complex forms with minimal code while maintaining excellent performance and aesthetics.
The main motivation behind Dataform is to simplify form creation and management in React applications. We aim to provide a highly customizable and easy-to-use solution that can handle complex form structures, dynamic rendering, and validation with minimal effort from developers, all while being lightweight and performance-oriented.
- Intuitive form configuration using JSON schema
- Support for various input types and controls
- Conditional rendering based on form data
- Built-in form validation
- Customizable layouts and theming
- Support for array and nested objects
- Extensibility through custom input components and layouts
- Performance: Only updates what has changed, ensuring efficient rendering
- Lightweight design with a focus on aesthetics
To install Dataform, run the following command in your project's root directory:
npm install dataform-react
or
yarn add dataform-react
## Usage
To use Dataform in your React application, simply import the main Dataform component and pass the JSON schema and initial form data as props:
```jsx
import React from 'react';
import Dataform from 'dataform-react';
const schema = {
// Your JSON schema goes here
};
const initialData = {
// Your initial form data goes here
};
const MyForm = () => {
return <Dataform schema={schema} initialData={initialData} />;
};
export default MyForm;
## Roadmap
Our future goals and enhancements for Dataform include:
1. Support for additional layout types (e.g., grid layout, datatable)
2. Integration with popular form libraries (e.g., Formik, react-hook-form)
3. Improved performance and optimization techniques
4. Comprehensive documentation and examples
5. A set of pre-built themes for easy customization
6. Extending support for validation libraries
## Contributing
We welcome contributions from the community! To contribute to Dataform:
1. Fork the repository.
2. Create a new branch for your feature or bug fix.
3. Write your code, making sure to follow the existing code style and conventions.
4. Add or update tests, if necessary.
5. Update documentation if you're introducing new features or making changes to the API.
6. Commit your changes and create a pull request.
For more detailed instructions on how to contribute, please see our [contributing guide](https://github.com/durubata/dataform-react/blob/main/CONTRIBUTING.md).
## License
Dataform is open-source software licensed under the [MIT license](https://github.com/durubata/dataform-react/blob/main/LICENSE).
# TSDX React User Guide
Congrats! You just saved yourself hours of work by bootstrapping this project with TSDX. Let’s get you oriented with what’s here and how to use it.
> This TSDX setup is meant for developing React component libraries (not apps!) that can be published to NPM. If you’re looking to build a React-based app, you should use `create-react-app`, `razzle`, `nextjs`, `gatsby`, or `react-static`.
> If you’re new to TypeScript and React, checkout [this handy cheatsheet](https://github.com/sw-yx/react-typescript-cheatsheet/)
## Commands
TSDX scaffolds your new library inside `/src`, and also sets up a [Parcel-based](https://parceljs.org) playground for it inside `/example`.
The recommended workflow is to run TSDX in one terminal:
```bash
npm start # or yarn start
This builds to /dist
and runs the project in watch mode so any edits you save inside src
causes a rebuild to /dist
.
Then run the example inside another:
cd example
npm i # or yarn to install dependencies
npm start # or yarn start
The default example imports and live reloads whatever is in /dist
, so if you are seeing an out of date component, make sure TSDX is running in watch mode like we recommend above. No symlinking required, we use Parcel's aliasing.
To do a one-off build, use npm run build
or yarn build
.
To run tests, use npm test
or yarn test
.
Code quality is set up for you with prettier
, husky
, and lint-staged
. Adjust the respective fields in package.json
accordingly.
Jest tests are set up to run with npm test
or yarn test
.
Calculates the real cost of your library using size-limit with npm run size
and visulize it with npm run analyze
.
This is the folder structure we set up for you:
/example
index.html
index.tsx # test your component here in a demo app
package.json
tsconfig.json
/src
index.tsx # EDIT THIS
/test
blah.test.tsx # EDIT THIS
.gitignore
package.json
README.md # EDIT THIS
tsconfig.json
We do not set up react-testing-library
for you yet, we welcome contributions and documentation on this.
TSDX uses Rollup as a bundler and generates multiple rollup configs for various module formats and build settings. See Optimizations for details.
tsconfig.json
is set up to interpret dom
and esnext
types, as well as react
for jsx
. Adjust according to your needs.
Two actions are added by default:
main
which installs deps w/ cache, lints, tests, and builds on all pushes against a Node and OS matrixsize
which comments cost comparison of your library on every pull request usingsize-limit
Please see the main tsdx
optimizations docs. In particular, know that you can take advantage of development-only optimizations:
// ./types/index.d.ts
declare var __DEV__: boolean;
// inside your code...
if (__DEV__) {
console.log('foo');
}
You can also choose to install and use invariant and warning functions.
CJS, ESModules, and UMD module formats are supported.
The appropriate paths are configured in package.json
and dist/index.js
accordingly. Please report if any issues are found.
The Playground is just a simple Parcel app, you can deploy it anywhere you would normally deploy that. Here are some guidelines for manually deploying with the Netlify CLI (npm i -g netlify-cli
):
cd example # if not already in the example folder
npm run build # builds to dist
netlify deploy # deploy the dist folder
Alternatively, if you already have a git repo connected, you can set up continuous deployment with Netlify:
netlify init
# build command: yarn build && cd example && yarn && yarn build
# directory to deploy: example/dist
# pick yes for netlify.toml
Per Palmer Group guidelines, always use named exports. Code split inside your React app instead of your React library.
There are many ways to ship styles, including with CSS-in-JS. TSDX has no opinion on this, configure how you like.
For vanilla CSS, you can include it at the root directory and add it to the files
section in your package.json
, so that it can be imported separately by your users and run through their bundler's loader.
We recommend using np.
When creating a new package with TSDX within a project set up with Lerna, you might encounter a Cannot resolve dependency
error when trying to run the example
project. To fix that you will need to make changes to the package.json
file inside the example
directory.
The problem is that due to the nature of how dependencies are installed in Lerna projects, the aliases in the example project's package.json
might not point to the right place, as those dependencies might have been installed in the root of your Lerna project.
Change the alias
to point to where those packages are actually installed. This depends on the directory structure of your Lerna project, so the actual path might be different from the diff below.
"alias": {
- "react": "../node_modules/react",
- "react-dom": "../node_modules/react-dom"
+ "react": "../../../node_modules/react",
+ "react-dom": "../../../node_modules/react-dom"
},
An alternative to fixing this problem would be to remove aliases altogether and define the dependencies referenced as aliases as dev dependencies instead. However, that might cause other problems.