|
| 1 | +<!-- |
| 2 | +*** Thanks for checking out this README Template. If you have a suggestion that would |
| 3 | +*** make this better please fork the repo and create a pull request or simple open |
| 4 | +*** an issue with the tag "enhancement". |
| 5 | +*** Thanks again! Now go create something AMAZING! :D |
| 6 | +--> |
| 7 | + |
| 8 | +<!-- PROJECT SHIELDS --> |
| 9 | +<!-- |
| 10 | +*** I'm using markdown "reference style" links for readability. |
| 11 | +*** Reference links are enclosed in brackets [ ] instead of parentheses ( ). |
| 12 | +*** See the bottom of this document for the declaration of the reference variables |
| 13 | +*** for build-url, contributors-url, etc. This is an optional, concise syntax you may use. |
| 14 | +*** https://www.markdownguide.org/basic-syntax/#reference-style-links |
| 15 | +--> |
| 16 | + |
| 17 | +[![Build Status][build-shield]][build-url] |
| 18 | +[![npm][npm-shield]][npm-url] |
| 19 | +[![npm downloads][npm-dl-shield]][npm-dl-url] |
| 20 | +[![Contributors][contributors-shield]][contributors-url] |
| 21 | +[![MIT License][license-shield]][license-url] |
| 22 | + |
| 23 | +<!-- PROJECT LOGO --> |
| 24 | +<br /> |
| 25 | +<p align="center"> |
| 26 | + <a href="https://github.com/cybertec-postgresql/rjsf-material-ui"> |
| 27 | + <img src="https://raw.githubusercontent.com/cybertec-postgresql/rjsf-material-ui/master/rjsf-material-ui-logo.png" alt="Logo" width="140" height="120"> |
| 28 | + </a> |
| 29 | + |
| 30 | + <h3 align="center">rjsf-material-ui</h3> |
| 31 | + |
| 32 | + <p align="center"> |
| 33 | + Material-UI theme, fields and widgets for <a href="https://github.com/mozilla-services/react-jsonschema-form/"><code>react-jsonschema-form</code></a>. |
| 34 | + <br /> |
| 35 | + <a href="https://github.com/cybertec-postgresql/rjsf-material-ui"><strong>Explore the docs »</strong></a> |
| 36 | + <br /> |
| 37 | + <br /> |
| 38 | + <a href="https://cybertec-postgresql.github.io/rjsf-material-ui/">View Playground</a> |
| 39 | + · |
| 40 | + <a href="https://github.com/cybertec-postgresql/rjsf-material-ui/issues">Report Bug</a> |
| 41 | + · |
| 42 | + <a href="https://github.com/cybertec-postgresql/rjsf-material-ui/issues">Request Feature</a> |
| 43 | + </p> |
| 44 | +</p> |
| 45 | + |
| 46 | +<!-- TABLE OF CONTENTS --> |
| 47 | + |
| 48 | +## Table of Contents |
| 49 | + |
| 50 | +- [About the Project](#about-the-project) |
| 51 | + - [Built With](#built-with) |
| 52 | +- [Getting Started](#getting-started) |
| 53 | + - [Prerequisites](#prerequisites) |
| 54 | + - [Installation](#installation) |
| 55 | +- [Usage](#usage) |
| 56 | +- [Roadmap](#roadmap) |
| 57 | +- [Contributing](#contributing) |
| 58 | +- [License](#license) |
| 59 | +- [Contact](#contact) |
| 60 | + |
| 61 | +<!-- ABOUT THE PROJECT --> |
| 62 | + |
| 63 | +## About The Project |
| 64 | + |
| 65 | +[![rjsf-material-ui Screen Shot][product-screenshot]](https://cybertec-postgresql.github.io/rjsf-material-ui) |
| 66 | + |
| 67 | +Exports `material-ui` theme, fields and widgets for `react-jsonschema-form`. |
| 68 | + |
| 69 | +### Built With |
| 70 | + |
| 71 | +- [react-jsonschema-form](https://github.com/mozilla-services/react-jsonschema-form/) |
| 72 | +- [Material-UI](https://material-ui.com/) |
| 73 | +- [Typescript](https://www.typescriptlang.org/) |
| 74 | + |
| 75 | +<!-- GETTING STARTED --> |
| 76 | + |
| 77 | +## Getting Started |
| 78 | + |
| 79 | +### Prerequisites |
| 80 | + |
| 81 | +- `@material-ui/core >= 4.2.0` ([in 4.2.0, the `slider` component was added to the core](https://github.com/mui-org/material-ui/pull/16416)) |
| 82 | +- `@material-ui/icons` |
| 83 | +- `react-jsonschema-form >= 1.6.0` ([in 1.6.0, the `withTheme` HOC was added](https://github.com/mozilla-services/react-jsonschema-form/pull/1226)) |
| 84 | + |
| 85 | +```sh |
| 86 | +yarn add @material-ui/core @material-ui/icons react-jsonschema-form |
| 87 | +``` |
| 88 | + |
| 89 | +### Installation |
| 90 | + |
| 91 | +```sh |
| 92 | +yarn add rjsf-material-ui |
| 93 | +``` |
| 94 | + |
| 95 | +<!-- USAGE EXAMPLES --> |
| 96 | + |
| 97 | +## Usage |
| 98 | + |
| 99 | +```javascript |
| 100 | +import { withTheme } from 'react-jsonschema-form'; |
| 101 | +import { Theme as MuiTheme } from 'rjsf-material-ui'; |
| 102 | + |
| 103 | +const Form = withTheme(MuiTheme); |
| 104 | +``` |
| 105 | + |
| 106 | +or |
| 107 | + |
| 108 | +```javascript |
| 109 | +import MuiForm from 'rjsf-material-ui'; |
| 110 | +``` |
| 111 | + |
| 112 | +<!-- ROADMAP --> |
| 113 | + |
| 114 | +## Roadmap |
| 115 | + |
| 116 | +See the [open issues](https://cybertec-postgresql.github.io/rjsf-material-ui/issues) for a list of proposed features (and known issues). |
| 117 | + |
| 118 | +<!-- CONTRIBUTING --> |
| 119 | + |
| 120 | +## Contributing |
| 121 | + |
| 122 | +Contributions are what make the open source community such an amazing place to be learn, inspire, and create. Any contributions you make are **greatly appreciated**. |
| 123 | + |
| 124 | +1. Fork the Project |
| 125 | +2. Create your Feature Branch (`git checkout -b feature/AmazingFeature`) |
| 126 | +3. Commit your Changes (`git commit -m 'Add some AmazingFeature'`) |
| 127 | +4. Push to the Branch (`git push origin feature/AmazingFeature`) |
| 128 | +5. Open a Pull Request |
| 129 | + |
| 130 | +<!-- CONTACT --> |
| 131 | + |
| 132 | +## Contact |
| 133 | + |
| 134 | +Cybertec TEAM - [@postgressupport](https://twitter.com/postgressupport) - office@cybertec.at - https://www.cybertec-postgresql.com |
| 135 | + |
| 136 | +Project Link: [https://cybertec-postgresql.github.io/rjsf-material-ui](https://cybertec-postgresql.github.io/rjsf-material-ui) |
| 137 | + |
| 138 | +<!-- MARKDOWN LINKS & IMAGES --> |
| 139 | +<!-- https://www.markdownguide.org/basic-syntax/#reference-style-links --> |
| 140 | + |
| 141 | +[build-shield]: https://img.shields.io/circleci/build/github/cybertec-postgresql/rjsf-material-ui.svg?style=flat-square&token=a58b0890f96bff2b53eef0f4d9c9e5d16eec2200 |
| 142 | +[build-url]: https://circleci.com/gh/cybertec-postgresql/rjsf-material-ui |
| 143 | +[contributors-shield]: https://img.shields.io/badge/contributors-1-orange.svg?style=flat-square |
| 144 | +[contributors-url]: https://github.com/cybertec-postgresql/rjsf-material-ui/graphs/contributors |
| 145 | +[license-shield]: https://img.shields.io/badge/license-MIT-blue.svg?style=flat-square |
| 146 | +[license-url]: https://choosealicense.com/licenses/mit |
| 147 | +[npm-shield]: https://img.shields.io/npm/v/rjsf-material-ui/latest.svg?style=flat-square |
| 148 | +[npm-url]: https://www.npmjs.com/package/rjsf-material-ui |
| 149 | +[npm-dl-shield]: https://img.shields.io/npm/dm/rjsf-material-ui.svg?style=flat-square |
| 150 | +[npm-dl-url]: https://www.npmjs.com/package/rjsf-material-ui |
| 151 | +[product-screenshot]: https://raw.githubusercontent.com/cybertec-postgresql/rjsf-material-ui/master/screenshot.png |
0 commit comments