0.6.0 • Published 10 months ago

@saisonomni/json-schema-viewer v0.6.0

Weekly downloads
-
License
Apache-2.0
Repository
github
Last release
10 months ago

@saisonomni/json-schema-viewer

A JSON Schema viewer React component

Features

  • Full JSON Schema Draft 4 support, including oneOf and anyOf 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

  1. Clone repo.
  2. Create / checkout feature/{name}, chore/{name}, or fix/{name} branch.
  3. Install deps: yarn.
  4. Make your changes.
  5. Run tests: yarn test.prod.
  6. Stage relevant files to git.
  7. 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 regular git commit.
  8. Push: git push.
  9. Open PR targeting the develop branch.
0.6.0

10 months ago

0.5.0

10 months ago

0.4.0

10 months ago

0.3.0

10 months ago

0.2.0

10 months ago

0.1.0

10 months ago

0.0.3

10 months ago

0.0.2

10 months ago

0.0.1

10 months ago