React Native Web JSONSchema Form
Render customizable forms using JSON schema for responsive websites and Expo apps (both iOS and Android). This library was inpired on react-jsonschema-form but was built with React Native and React Native Web in mind.
- See this library in production at https://www.carelulu.com
- Skeleton project using React Native Web Jsonschema Form at https://www.carelulu.com/react-native-web-example/login and https://github.com/CareLuLu/react-native-web-skeleton
Table of Contents
Documentation
Coming soon!
Setup
React Native Web JSONSchema Form was created to facilitate the development of write once, run anywhere web and mobile apps. In order to accomplish that, this library is heavily based on React Native and React Native Web.
Requirements
First you need to install react ^16.8.3 (this library uses react-hooks).
yarn add reactIf you're using Expo, they use a custom version of react-native and therefore you need to check what is the React Native repository for the Expo version you're using. For Expo v33.x.x you'd run:
yarn add https://github.com/expo/react-native/archive/sdk-33.0.0.tar.gzIf your project is also being used for web, please install React Native Web. Make sure your babel/webpack build replace all react-native imports with react-native-web (details here). If you used React Create App, aliasing is already taken care off for you.
yarn add react-dom react-native-web This library is backed by react-native-web-ui-components. Please make sure you have installed react-native-web-ui-components and its dependencies. All inputs and buttons will follow the theme used on your project. The form must be within <UIProvider> but doesn't need to be a direct child.
yarn add react-native-web-ui-componentsInstallation
Install the library using yarn or npm.
yarn add react-native-web-jsonschema-formExamples
Basic Form
import React from 'react';
import { useHistory } from 'react-router';
import { Alert } from 'react-native';
import { UIProvider } from 'react-native-web-ui-components';
import Form from 'react-native-web-jsonschema-form';
import { Router, Switch } from 'react-router-dom';
// import { Router, Switch } from 'react-router-native';
const theme = {
input: {
focused: StyleSheet.create({
border: {
borderColor: 'yellow',
},
}),
},
};
const schema = {
type: 'object',
properties: {
username: { type: 'string' },
password: { type: 'string' },
},
};
const BasicForm = ({ formData, onChange }) => (
<Form
formData={formData}
schema={schema}
onChange={onChange}
/>
);
const ThemeWrapper = ({ children }) => {
const history = useHistory();
return (
<UIProvider theme={theme} history={history}>
{children}
</UIProvider>
);
};
const App = () => {
const [formData, setFormData] = useState({});
const onChange = (event) => setFormData({
...formData,
[event.params.name]: event.params.value,
});
return (
<Router>
<Switch>
<ThemeWrapper>
<BasicForm
formData={formData}
onChange={onChange}
/>
</ThemeWrapper>
</Switch>
</Router>
);
};Event Handlers
import React from 'React';
import PropTypes from 'prop-types';
import { Loading, Alert } from 'react-native-web-ui-components';
import Form from 'react-native-web-jsonschema-form';
class MyForm extends React.Component {
static propTypes = {
controller: PropTypes.string.isRequired,
action: PropTypes.string.isRequired,
};
constructor(props) {
super(props);
this.state = {
schema: null,
message: null,
posting: null,
};
}
onSubmit = async (event) => {
const { action, controller } = this.props;
const { values } = event.params;
this.setState({ posting: true });
return fetch(`/${controller}/${action}`, {
method: 'POST',
body: JSON.stringify(values),
});
};
onSuccess = async (event) => {
const { response } = event.params;
this.setState({
posting: false,
message: response.message,
});
};
onError = async (event) => {
// These are errors for fields that are not included in the schema
const { exceptions } = event.params;
const warning = Object.keys(exceptions).map(k => exceptions[k].join('\n'));
this.setState({
posting: false,
message: warning.length ? warning.join('\n') : null,
});
};
render() {
const { schema, posting, message } = this.state;
if (!schema) {
const self = this;
fetch(`/get-schema/${controller}/${action}`)
.then((schema) => self.setState({ schema });
return <Loading />;
}
return (
<React.Fragment>
{posting ? <Loading /> : null}
{message ? (
<Alert>
Message
</Alert>
) : null}
<Form
schema={schema}
onSubmit={this.onSubmit}
onSuccess={this.onSuccess}
onError={this.onError}
/>
</React.Fragment>
);
}
}Custom Theme
There are 5 input states: regular, focused, disabled, readonly and error. On which one of them you can define styles for background, border, text, placeholder, opacity, selected and unselected. These properties will be used accordingly by the widgets provided in this library. For example, selected and unselected will be used checkboxes and radioboxes to represent checked and unchecked.
const theme = {
input: {
focused: StyleSheet.create({
border: {
borderColor: 'yellow',
borderWidth: 2,
borderStyle: 'solid',
},
background: {
backgroundColor: 'white',
},
text: {
fontSize: 14,
color: '#545454',
},
placeholder: {
color: '#FAFAFA',
},
opacity: {
opacity: 1,
},
selected: {
color: 'blue',
},
unselected: {
color: '#FAFAFA',
},
}),
regular: {...},
disabled: {...},
readonly: {...},
error: {...},
},
};
const ThemeWrapper = ({ children }) => {
const history = useHistory();
return (
<UIProvider theme={theme} history={history}>
{children}
</UIProvider>
);
};Form Validation
See https://github.com/CareLuLu/react-native-web-jsonschema-form/issues/139#issuecomment-654377982.
Array Fields
See https://github.com/CareLuLu/react-native-web-jsonschema-form/issues/113#issuecomment-621375353.
Props
The Form has the following props:
import React from 'react';
import Form from 'react-native-web-jsonschema-form';
const Example = ({
// Misc
name, // String to be used as id, if empty a hash will be used instead.
onRef, // Function to be called with the form instance. This is NOT a DOM/Native element.
scroller, // If provided, this will be passed to the widgets to allow disabling ScrollView during a gesture.
wigdets, // Object with a list of custom widgets.
// Data
formData, // Initial data to populate the form. If this attribute changes, the form will update the data.
filterEmptyValues, // If true, all empty and non-required fields will be omitted from the submitted values.
// Schema
schema, // JSON schema
uiSchema, // JSON schema modifying UI defaults for schema
errorSchema, // JSON schema with errors
// Events
// * All events can be synchronous or asynchronous functions.
// * All events receive one parameter `event` with `name`, `preventDefault()` and `params`.
onFocus,
onChange,
onSubmit,
onCancel,
onSuccess,
onError,
// Layout
buttonPosition, // left, right, center
submitButton, // If false, it will not be rendered. If it is a string, it will be used as the default button text.
cancelButton, // If false, it will not be rendered. If it is a string, it will be used as the default button text.
SubmitButton, // Component to render the submit button
CancelButton, // Component to render the cancel button
}) => (
<Form {...}/>
)