https://github.com/dipsywong98/reforml

Simple yet flexible react form defined by json or yaml
https://github.com/dipsywong98/reforml

form hacktoberfest hacktoberfest2020 json react yaml

Last synced: 2 months ago
JSON representation

Simple yet flexible react form defined by json or yaml

• Host: GitHub
• URL: https://github.com/dipsywong98/reforml
• Owner: dipsywong98
• License: mit
• Created: 2020-04-02T04:36:30.000Z (over 6 years ago)
• Default Branch: master
• Last Pushed: 2023-05-10T04:33:26.000Z (about 3 years ago)
• Last Synced: 2025-10-20T06:51:29.713Z (9 months ago)
• Topics: form, hacktoberfest, hacktoberfest2020, json, react, yaml
• Language: TypeScript
• Homepage: https://dipsywong98.github.io/reforml/
• Size: 8.56 MB
• Stars: 2
• Watchers: 1
• Forks: 0
• Open Issues: 5
• Metadata Files:
  • Readme: readme.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# reforml

> react form defined by yaml

[![NPM](https://img.shields.io/npm/v/reforml.svg)](https://www.npmjs.com/package/reforml) 

[![JavaScript Style Guide](https://img.shields.io/badge/code_style-standard-brightgreen.svg)](https://standardjs.com)

![size](https://img.shields.io/bundlephobia/minzip/reforml)

![gh-action](https://img.shields.io/github/workflow/status/dipsywong98/reforml/test)

[![Codacy Badge](https://app.codacy.com/project/badge/Grade/7ff5651226774b5aa0efa6e76aca29e7)](https://www.codacy.com/manual/dipsywong98/reforml?utm_source=github.com&utm_medium=referral&utm_content=dipsywong98/reforml&utm_campaign=Badge_Grade)

![coverage](https://img.shields.io/codecov/c/github/dipsywong98/reforml)

![dependencies](https://img.shields.io/david/dipsywong98/reforml)

## Install

```bash

npm i reforml

```

## Usage

[https://dipsywong98.github.io/reforml/](https://dipsywong98.github.io/reforml/)

```jsx

import {BaseForm} from 'reforml'

import React, {useState, useMemo} from 'react'

export default () => {

  const [value, setValue] = useState({})

  const fields = useMemo(() => ({

    myField: {

      type: 'text',

      label: 'my field'

    }

  }), [])

  return (

    

  )

}

```

## Development

```shell script

yarn # install dependencies to all packages

yarn start # start the build watcher for reforml

yarn example # start the example

yarn docs # start the development server of documentation

```

## License

MIT © [dipsywong98](https://github.com/dipsywong98)