{"id":15013025,"url":"https://github.com/optum/jsonschema-editor-react","last_synced_at":"2025-08-19T21:31:50.645Z","repository":{"id":37761148,"uuid":"281172609","full_name":"Optum/jsonschema-editor-react","owner":"Optum","description":"A react module for maintaining json schema. Built with Chakra-UI","archived":false,"fork":false,"pushed_at":"2023-10-04T11:51:28.000Z","size":5696,"stargazers_count":59,"open_issues_count":9,"forks_count":29,"subscribers_count":7,"default_branch":"master","last_synced_at":"2024-12-09T09:06:32.051Z","etag":null,"topics":["chakra-ui","jsonschema","jsonschema-editor","jsonschema-generator","jsonschema-validator","react"],"latest_commit_sha":null,"homepage":"","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/Optum.png","metadata":{"files":{"readme":"readme.md","changelog":null,"contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":"CODE_OF_CONDUCT.md","threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2020-07-20T16:42:34.000Z","updated_at":"2024-10-15T10:11:09.000Z","dependencies_parsed_at":"2024-06-18T21:31:14.951Z","dependency_job_id":"ea84167e-54b0-459c-84ad-337bb5e96bbb","html_url":"https://github.com/Optum/jsonschema-editor-react","commit_stats":{"total_commits":21,"total_committers":4,"mean_commits":5.25,"dds":"0.33333333333333337","last_synced_commit":"cb1dd7c1e247232f14505d2ddf2dcfc5b203fa5e"},"previous_names":[],"tags_count":8,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Optum%2Fjsonschema-editor-react","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Optum%2Fjsonschema-editor-react/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Optum%2Fjsonschema-editor-react/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Optum%2Fjsonschema-editor-react/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/Optum","download_url":"https://codeload.github.com/Optum/jsonschema-editor-react/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":230367928,"owners_count":18215338,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["chakra-ui","jsonschema","jsonschema-editor","jsonschema-generator","jsonschema-validator","react"],"created_at":"2024-09-24T19:43:37.226Z","updated_at":"2024-12-19T03:10:12.681Z","avatar_url":"https://github.com/Optum.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"\u003cp align=\"center\"\u003e\n  json-schema-editor - A React Component\n\u003c/p\u003e\n\n\u003cp align=\"center\"\u003e\n  \u003ca href=\"https://github.com/xojs/xo\"\u003e\u003cimg src=\"https://img.shields.io/badge/code_style-XO-5ed9c7.svg\"\u003e\u003c/a\u003e➕\n  \u003ca href=\"https://github.com/prettier/prettier\"\u003e\u003cimg src=\"https://img.shields.io/badge/code_style-prettier-ff69b4.svg?style=flat-square\"\u003e\u003c/a\u003e➕\n  \u003ca href=\"https://chakra-ui.com/\"\u003e\u003cimg src=\"https://img.shields.io/badge/built%20with-chakra--ui-green\"\u003e\u003c/a\u003e➕\n\u003ca href=\"https://optum.github.io/jsonschema-editor-react/\"\u003e\u003cimg src=\"https://cdn.jsdelivr.net/gh/storybookjs/brand@master/badge/badge-storybook.svg\"\u003e\u003c/a\u003e\n\u003c/p\u003e\n\n## Description\n\n\u003e JSON Schema is hypermedia ready, and ideal for annotating your existing JSON-based HTTP API. JSON Schema documents are identified by URIs, which can be used in HTTP Link headers, and inside JSON Schema documents to allow recursive definitions. - [json-schema.org](https://json-schema.org/)\n\nJsonSchemaEditor is a React component library that allows the easy generation of valid `Draft 07` JsonSchema from a UI,  so that it can be easily persisted in a schema management system.\n\nBenefits include:\n\n- Describes your existing data format(s).\n- Provides clear human- and machine- readable - documentation.\n- Validates data which is useful for:\n  - Automated testing.\n  - Ensuring quality of client submitted data.\n\n## Documentation\n\nControl documentation and demo can be viewed [here](https://optum.github.io/jsonschema-editor-react/)\n\n## Install\n\n```shell\nnpm install @optum/json-schema-editor\n```\n\nor\n\n```shell\nyarn add @optum/json-schema-editor\n```\n\n## Props\n\n| property       | type                               | description                                  | default               |\n| -------------- | ---------------------------------- | -------------------------------------------- | --------------------- |\n| data           | object                             | the initial data for the editor              | {}                    |\n| readOnly       | boolean                            | make editor read only                        | false                 |\n| onSchemaChange | callback (results: string) =\u003e void | callback method to capture changes to schema | required (no default) |\n\n## Usage\n\n```js\nimport JsonSchemaEditor from \"@optum/json-schema-editor\";\n\nexport const printIt = (schema) =\u003e {\n  console.log(schema);\n};\n\nfunction App() {\n  return (\n    \u003cdiv className=\"App\"\u003e\n      \u003cJsonSchemaEditor onSchemaChange={printIt} /\u003e\n    \u003c/div\u003e\n  );\n}\n\nexport default App;\n```\n\n## License\n\njsonchema-editor-react is Copyright © 2021 Optum. It is free software and may be redistributed under the Apache 2.0 license.\n\n## Development\n\n### Commands\n\n\u003e Run storybook\n\n```shell\nnpm run storybook\n```\n\n\u003e Create docs and build for release\n\n```shell\nnpm run build-storybook\n```\n\n\u003e Run tests locally\n\n```shell\nnpm test\n```\n\n\u003e Build dist\n\n```shell\nnpm run build\n```\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Foptum%2Fjsonschema-editor-react","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Foptum%2Fjsonschema-editor-react","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Foptum%2Fjsonschema-editor-react/lists"}