{"repo":"asyncapi/asyncapi-react","free":true,"listed":false,"github":"https://github.com/asyncapi/asyncapi-react","clone":"git clone https://github.com/asyncapi/asyncapi-react.git","description":"React component for rendering documentation from your specification in real-time in the browser. It also provides a WebComponent and bundle for Angular and Vue","language":"TypeScript","stars":241,"topics":["asyncapi","asyncapi-specification","react","reactjs","event","hacktoberfest","nodejs","get-global-node-release-workflows"],"license":"Apache-2.0","category":"ui-components","readme_excerpt":"React component for AsyncAPI specification. Available also as a Web Component, but not only. Overview The official React component for AsyncAPI specification. It allows you to render the documentation of your asynchronous API provided in the AsyncAPI specification format and validate this specification. You can fully restyle the component using your own styles. - Prerequisites - Installation - Using in React - Using in other technologies - Props - Features - Styles Default styles Custom styles Custom logo - Playground - Modules - Development - Contribution - Credits - Contributors Prerequisites - react (version 16.8.0 or higher) Installation Run this command to install the component in your project: Check out this sandbox application that uses the React component: Using in React Check a simple example which shows passing the inline AsyncAPI specification with custom configurations: Using in other technologies To check how to use web-component or use a component in other technologies see: - Using in Angular - Using in Vue - Using in NextJS - Standalone bundle usage - Web Component usage Props The list of props for the AsyncAPI React component includes: - schema: string AsyncAPIDocument object FetchingSchemaInterface The schema property is required and contains AsyncAPI specification. Use the string type, the AsyncAPIDocument type, parsed specification as JS object from AsyncAPI Parser or the FetchingSchemaInterface object to fetch the schema from an external resource. For more","default_branch":null,"files":null,"tree":[],"storefront":"/r/asyncapi","claimed":false,"request_supported":{"post":"https://gitbuyer.com/r/asyncapi/asyncapi-react/request-supported","requests":0},"note":"indexed from public GitHub; nothing is for sale on this page. Clone it from GitHub. Paid listings live at /search."}