@reactjsonforms/vanilla-renderers
v4.0.0-alpha.3
Published
Default Renderer Set for JSON Forms
Downloads
3
Maintainers
Readme
JSON Forms - More Forms. Less Code
Complex forms in the blink of an eye
JSON Forms eliminates the tedious task of writing fully-featured forms by hand by leveraging the capabilities of JSON, JSON Schema and Javascript.
Vanilla Renderers Package
This is the JSONForms Vanilla Renderers Package. This package only contains renderers and must be combined with JSON Forms React.
You can combine JSON Forms React with other renderers too, for example with the Material Renderers.
See the official documentation and the JSON Forms React seed repository for examples on how to integrate JSON Forms with your application.
Check https://www.npmjs.com/search?q=%40jsonforms for all published JSONForms packages.
If you want to customize styling, have a look at our styles guide.
Quick start
Install JSON Forms Core, React and React Vanilla Renderers
npm i --save @reactjsonforms/core @reactjsonforms/react @reactjsonforms/vanilla-renderers
Use the JsonForms
component for each form you want to render and hand over the renderer set.
import React, { useState } from 'react';
import { JsonForms } from '@reactjsonforms/react';
import {
vanillaCells,
vanillaRenderers,
} from '@reactjsonforms/vanilla-renderers';
const schema = {
type: 'object',
properties: {
name: {
type: 'string',
minLength: 1,
},
done: {
type: 'boolean',
},
due_date: {
type: 'string',
format: 'date',
},
recurrence: {
type: 'string',
enum: ['Never', 'Daily', 'Weekly', 'Monthly'],
},
},
required: ['name', 'due_date'],
};
const uischema = {
type: 'VerticalLayout',
elements: [
{
type: 'Control',
label: false,
scope: '#/properties/done',
},
{
type: 'Control',
scope: '#/properties/name',
},
{
type: 'HorizontalLayout',
elements: [
{
type: 'Control',
scope: '#/properties/due_date',
},
{
type: 'Control',
scope: '#/properties/recurrence',
},
],
},
],
};
const initialData = {};
function App() {
const [data, setData] = useState(initialData);
return (
<JsonForms
schema={schema}
uischema={uischema}
data={data}
renderers={vanillaRenderers}
cells={vanillaCells}
onChange={({ data, _errors }) => setData(data)}
/>
);
}
License
The JSON Forms project is licensed under the MIT License. See the LICENSE file for more information.
Roadmap
Our current roadmap is available here.
Feedback, Help and Support
JSON Forms is developed by EclipseSource.
If you encounter any problems feel free to open an issue on the repo. For questions and discussions please use the JSON Forms board. You can also reach us via email. In addition, EclipseSource also offers professional support for JSON Forms.
Migration
See our migration guide when updating JSON Forms.