https://github.com/stoplightio/json-schema-viewer

A JSON Schema viewer React component
https://github.com/stoplightio/json-schema-viewer

json-schema json-schema-viewer react stoplightio storybook

Last synced: 24 days ago
JSON representation

A JSON Schema viewer React component

• Host: GitHub
• URL: https://github.com/stoplightio/json-schema-viewer
• Owner: stoplightio
• License: apache-2.0
• Created: 2018-12-26T20:03:18.000Z (almost 6 years ago)
• Default Branch: master
• Last Pushed: 2024-09-26T07:00:41.000Z (about 1 month ago)
• Last Synced: 2024-09-29T09:39:38.782Z (about 1 month ago)
• Topics: json-schema, json-schema-viewer, react, stoplightio, storybook
• Language: TypeScript
• Size: 6.93 MB
• Stars: 170
• Watchers: 18
• Forks: 36
• Open Issues: 31
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# @stoplight/json-schema-viewer

A JSON Schema viewer React component

- Explore the components: [Storybook](https://stoplightio.github.io/json-schema-viewer)

- View the changelog: [Releases](https://github.com/stoplightio/json-schema-viewer/releases)

### 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.

```bash

# latest stable

yarn add @stoplight/json-schema-viewer

```

### Usage

```jsx

// index.jsx

import { JsonSchemaViewer } from "@stoplight/json-schema-viewer";

;

```

More examples can be find in the [Storybook stories](./src/__stories__/JsonSchemaViewer.tsx).

### 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](https://github.com/marionebl/commitlint/tree/master/%40commitlint/config-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.