Skip to content

Commit

Permalink
Finish renaming
Browse files Browse the repository at this point in the history
  • Loading branch information
soup-in-boots committed Nov 24, 2020
1 parent af4e77b commit 6aae6ec
Show file tree
Hide file tree
Showing 8 changed files with 23 additions and 101 deletions.
33 changes: 17 additions & 16 deletions README.md
@@ -1,6 +1,6 @@
# Table of Contents

1. [rjsf](#org4dec357)
1. [forml](#org4dec357)
1. [Documentation](#documentation)
2. [Examples](#org3b18bac)
3. [Installation](#installation)
Expand All @@ -10,29 +10,29 @@

<a id="org4dec357"></a>

# rjsf
# forml

[![Build Status](https://travis-ci.org/fauxsoup/rjsf.svg?branch=master)](https://travis-ci.org/fauxsoup/rjsf)
![Libraries.io dependency status for latest release](https://img.shields.io/librariesio/release/npm/rjsf)
[![Coverage Status](https://coveralls.io/repos/github/fauxsoup/rjsf/badge.svg?branch=master)](https://coveralls.io/github/fauxsoup/rjsf?branch=master)
![npm](https://img.shields.io/npm/v/rjsf)
![npm](https://img.shields.io/npm/l/rjsf)
[![Build Status](https://travis-ci.org/fauxsoup/forml.svg?branch=master)](https://travis-ci.org/fauxsoup/forml)
![Libraries.io dependency status for latest release](https://img.shields.io/librariesio/release/npm/forml/core)
[![Coverage Status](https://coveralls.io/repos/github/fauxsoup/forml/badge.svg?branch=master)](https://coveralls.io/github/fauxsoup/forml?branch=master)
![npm](https://img.shields.io/npm/v/forml/core)
![npm](https://img.shields.io/npm/l/forml/core)

rjsf - react json schema form
forml - react json schema form

A lightweight, efficient form rendering library for use with your JSON schemas. Automatically generate and customize working forms for use in your application. Great for rapid prototyping and general usage.

<a id="documentation"></a>

## Documentation

View the documentation at [rjsf.io](https://www.rjsf.io)!
View the documentation at [forml.io](https://www.forml.io)!

<a id="org3b18bac"></a>

## Examples

You can view the [running demo](https://fauxsoup.github.io/rjsf).
You can view the [running demo](https://fauxsoup.github.io/forml).

Alternatively, you can run them yourself.

Expand All @@ -45,7 +45,8 @@ Alternatively, you can run them yourself.
## Installation

```bash
npm i rjsf
# Substitute @forml/decorator-mui with your preferred decorator
npm i @forml/core @forml/decorator-mui
```

<a id="org09cd307"></a>
Expand All @@ -55,14 +56,14 @@ npm i rjsf
Basic usage is as follows:

```jsx
import { SchemaForm, decorators } from 'rjsf';
import { SchemaForm } from '@forml/core;
import * as decorator from '@forml/decorator-mui';
import { useState } from 'react';
export function MyForm(props) {
const [model, setModel] = useState('');
const schema = { type: 'string', title: 'Sample Form' };
const form = ['*'];
const decorator = decorators.barebones;
return (
<SchemaForm
Expand Down Expand Up @@ -96,17 +97,17 @@ Appearance/final rendering is handled by the `decorator` components. Currently a
## Localization
`rjsf` supports localization via injection. To inject a localizer:
`forml` supports localization via injection. To inject a localizer:
```jsx
import { SchemaForm, decorators } from 'rjsf';
import { SchemaForm, decorators } from '@forml/core;
import * as decorator from '@forml/decorator-mui';
import { useTranslate } from 'react-i18next';
import { useState } from 'react';

export function MyTranslatedForm(props) {
const [model, setModel] = useState({});
const { t } = useTranslate();
const decorator = decorators.mui;
const schema = {
type: 'object',
properties: {
Expand Down
79 changes: 0 additions & 79 deletions README.org

This file was deleted.

2 changes: 1 addition & 1 deletion src/components/mapper/index.jsx
@@ -1,5 +1,5 @@
/**
* @namespace rjsf.mapper
* @namespace forml.mapper
*/
import t from 'prop-types';

Expand Down
2 changes: 1 addition & 1 deletion src/components/schema-field.jsx
Expand Up @@ -6,7 +6,7 @@ import React from 'react';
import {useMapper, useModel} from '@forml/hooks';
import {FormType} from '../types';

const log = debug('rjsf:schema-field');
const log = debug('forml:schema-field');

export function SchemaField(props) {
const {schema, form} = props;
Expand Down
2 changes: 1 addition & 1 deletion src/components/schema-form.jsx
@@ -1,5 +1,5 @@
/**
* @namespace rjsf.SchemaForm
* @namespace forml.SchemaForm
*/
import ObjectPath from 'objectpath';
import PropTypes from 'prop-types';
Expand Down
2 changes: 1 addition & 1 deletion src/constants.js
@@ -1 +1 @@
export const ARRAY_PLACEHOLDER = Symbol('rjsf:array:placeholder');
export const ARRAY_PLACEHOLDER = Symbol('forml:array:placeholder');
2 changes: 1 addition & 1 deletion src/index.js
@@ -1,5 +1,5 @@
/**
* @namespace rjsf
* @namespace forml
*/

import * as util from './util';
Expand Down
2 changes: 1 addition & 1 deletion src/util.js
Expand Up @@ -4,7 +4,7 @@ import objectPath from 'objectpath';
import {useMemo} from 'react';

/**
* @namespace rjsf.util
* @namespace forml.util
*/

/**
Expand Down

0 comments on commit 6aae6ec

Please sign in to comment.