0.6.0 • Published 3 months ago
@saisonomni/json-schema-viewer v0.6.0
@saisonomni/json-schema-viewer
A JSON Schema viewer React component
Features
- Full JSON Schema Draft 4 support, including
oneOf
andanyOf
combiner properties - Renders complicated nested objects to any depth
- Renders validation properties and markdown descriptions
- Capable of linking resolved \$refs
- Theme-able
- Collapsible
Installation
Supported in modern browsers and node.
# latest stable
yarn add @saisonomni/json-schema-viewer
Usage
// index.jsx
import { JsonSchemaViewer } from "@saisonomni/json-schema-viewer";
<JsonSchemaViewer
name="Todos Model"
schema={schema}
expanded={true}
hideTopBar={false}
emptyText="No schema defined"
defaultExpandedDepth={0}
/>;
More examples can be find in the Storybook stories.
Contributing
- Clone repo.
- Create / checkout
feature/{name}
,chore/{name}
, orfix/{name}
branch. - Install deps:
yarn
. - Make your changes.
- Run tests:
yarn test.prod
. - Stage relevant files to git.
- Commit:
yarn commit
. NOTE: Commits that don't follow the conventional format will be rejected.yarn commit
creates this format for you, or you can put it together manually and then do a regulargit commit
. - Push:
git push
. - Open PR targeting the
develop
branch.