switchboard-json-schema-builder
v1.0.4
Published
Customized package from viczaca/react-json-schema-builder that allows to build a json schema interactively.
Downloads
4
Readme
react-json-schema-builder
Allows to build a json schema interactively.
Install
npm install --save react-json-schema-builder
or
yarn add react-json-schema-builder
Usage
import React from 'react'
import JSONSchemaBuilder, {Schema} from 'react-json-schema-builder'
import 'react-json-schema-builder/dist/index.css'
const Example = () => {
const [schema, setSchema] = React.useState<Schema>(jsonSchema)
return (
<JSONSchemaBuilder
locale={"es"}
schema={schema}
onChange={setSchema}
/>)
}
Contributing
The package is made up of 2 main folders:
- /src contains all the source files and components
- /example is a create-react-app based demo website
To setup and run a local copy:
- Clone this repo with
git clone https://github.com/viczaca/react-json-schema-builder
- Run
yarn install
in the root folder - Run
yarn install
in the example folder - In separate terminal windows, run
yarn start
in the root and example folders.
You should now be up and running with live browser reloading of the example website while you work on source files and components in the /src folder.
When you're done working on your changes, submit a PR with the details and include a screenshot if you've changed anything visually.
In order to add new languages:
- Create a json in src/locales/new_lang.json with the new translations
- Import in src\utils\i18n.ts the new json and append it to resources
License
MIT © viczaca