@asyncapi/react-component 1.0.0-next.8 β 1.0.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +121 -36
- package/browser/index.js +32 -14
- package/browser/index.js.LICENSE.txt +88 -0
- package/browser/standalone/index.js +32 -43
- package/browser/standalone/index.js.LICENSE.txt +112 -0
- package/browser/standalone/without-parser.js +14 -41
- package/browser/standalone/without-parser.js.LICENSE.txt +110 -0
- package/browser/without-parser.js +14 -12
- package/browser/without-parser.js.LICENSE.txt +86 -0
- package/lib/cjs/components/Bindings.js +14 -5
- package/lib/cjs/components/Bindings.js.map +1 -1
- package/lib/cjs/components/CollapseButton.js +11 -7
- package/lib/cjs/components/CollapseButton.js.map +1 -1
- package/lib/cjs/components/Extensions.js +4 -3
- package/lib/cjs/components/Extensions.js.map +1 -1
- package/lib/cjs/components/Href.js +2 -1
- package/lib/cjs/components/Href.js.map +1 -1
- package/lib/cjs/components/JSONSnippet.js +2 -1
- package/lib/cjs/components/JSONSnippet.js.map +1 -1
- package/lib/cjs/components/Markdown.js +3 -2
- package/lib/cjs/components/Markdown.js.map +1 -1
- package/lib/cjs/components/Schema.js +77 -60
- package/lib/cjs/components/Schema.js.map +1 -1
- package/lib/cjs/components/Tag.js +3 -2
- package/lib/cjs/components/Tag.js.map +1 -1
- package/lib/cjs/components/Tags.js +3 -2
- package/lib/cjs/components/Tags.js.map +1 -1
- package/lib/cjs/components/index.js +5 -1
- package/lib/cjs/components/index.js.map +1 -1
- package/lib/cjs/config/config.js.map +1 -1
- package/lib/cjs/config/default.js +9 -1
- package/lib/cjs/config/default.js.map +1 -1
- package/lib/cjs/config/index.js +5 -1
- package/lib/cjs/config/index.js.map +1 -1
- package/lib/cjs/constants.js +12 -48
- package/lib/cjs/constants.js.map +1 -1
- package/lib/cjs/containers/AsyncApi/AsyncApi.js +28 -12
- package/lib/cjs/containers/AsyncApi/AsyncApi.js.map +1 -1
- package/lib/cjs/containers/AsyncApi/Layout.js +33 -21
- package/lib/cjs/containers/AsyncApi/Layout.js.map +1 -1
- package/lib/cjs/containers/AsyncApi/Standalone.js +8 -2
- package/lib/cjs/containers/AsyncApi/Standalone.js.map +1 -1
- package/lib/cjs/containers/Error/Error.js +4 -3
- package/lib/cjs/containers/Error/Error.js.map +1 -1
- package/lib/cjs/containers/Info/Info.js +11 -10
- package/lib/cjs/containers/Info/Info.js.map +1 -1
- package/lib/cjs/containers/Messages/Message.js +23 -10
- package/lib/cjs/containers/Messages/Message.js.map +1 -1
- package/lib/cjs/containers/Messages/MessageExample.js +25 -13
- package/lib/cjs/containers/Messages/MessageExample.js.map +1 -1
- package/lib/cjs/containers/Messages/Messages.js +14 -9
- package/lib/cjs/containers/Messages/Messages.js.map +1 -1
- package/lib/cjs/containers/Operations/Operation.js +88 -38
- package/lib/cjs/containers/Operations/Operation.js.map +1 -1
- package/lib/cjs/containers/Operations/Operations.js +20 -13
- package/lib/cjs/containers/Operations/Operations.js.map +1 -1
- package/lib/cjs/containers/Schemas/Schema.js +21 -0
- package/lib/cjs/containers/Schemas/Schema.js.map +1 -0
- package/lib/cjs/containers/Schemas/Schemas.js +29 -0
- package/lib/cjs/containers/Schemas/Schemas.js.map +1 -0
- package/lib/cjs/containers/Servers/Security.js +150 -0
- package/lib/cjs/containers/Servers/Security.js.map +1 -0
- package/lib/cjs/containers/Servers/Server.js +15 -8
- package/lib/cjs/containers/Servers/Server.js.map +1 -1
- package/lib/cjs/containers/Servers/Servers.js +12 -7
- package/lib/cjs/containers/Servers/Servers.js.map +1 -1
- package/lib/cjs/containers/Sidebar/Sidebar.js +201 -141
- package/lib/cjs/containers/Sidebar/Sidebar.js.map +1 -1
- package/lib/cjs/contexts/index.js +6 -1
- package/lib/cjs/contexts/index.js.map +1 -1
- package/lib/cjs/contexts/useConfig.js +10 -0
- package/lib/cjs/contexts/useConfig.js.map +1 -0
- package/lib/cjs/contexts/useSpec.js +7 -3
- package/lib/cjs/contexts/useSpec.js.map +1 -1
- package/lib/cjs/helpers/bindingsHelpers.js +24 -0
- package/lib/cjs/helpers/bindingsHelpers.js.map +1 -0
- package/lib/cjs/helpers/common.js +17 -0
- package/lib/cjs/helpers/common.js.map +1 -0
- package/lib/cjs/helpers/index.js +6 -3
- package/lib/cjs/helpers/index.js.map +1 -1
- package/lib/cjs/helpers/marked.js +2 -2
- package/lib/cjs/helpers/marked.js.map +1 -1
- package/lib/cjs/helpers/message.js +39 -9
- package/lib/cjs/helpers/message.js.map +1 -1
- package/lib/cjs/helpers/parser.js +16 -15
- package/lib/cjs/helpers/parser.js.map +1 -1
- package/lib/cjs/helpers/schema.js +186 -149
- package/lib/cjs/helpers/schema.js.map +1 -1
- package/lib/cjs/helpers/server.js +49 -0
- package/lib/cjs/helpers/server.js.map +1 -1
- package/lib/cjs/helpers/specification.js +36 -21
- package/lib/cjs/helpers/specification.js.map +1 -1
- package/lib/cjs/index.js.map +1 -1
- package/lib/cjs/types.js +4 -51
- package/lib/cjs/types.js.map +1 -1
- package/lib/cjs/without-parser.js.map +1 -1
- package/lib/esm/components/Bindings.js +12 -4
- package/lib/esm/components/Bindings.js.map +1 -1
- package/lib/esm/components/CollapseButton.js +9 -6
- package/lib/esm/components/CollapseButton.js.map +1 -1
- package/lib/esm/components/Extensions.js +2 -2
- package/lib/esm/components/Extensions.js.map +1 -1
- package/lib/esm/components/Href.js.map +1 -1
- package/lib/esm/components/JSONSnippet.js.map +1 -1
- package/lib/esm/components/Markdown.js +1 -1
- package/lib/esm/components/Markdown.js.map +1 -1
- package/lib/esm/components/Schema.js +71 -59
- package/lib/esm/components/Schema.js.map +1 -1
- package/lib/esm/components/Tag.js +1 -1
- package/lib/esm/components/Tag.js.map +1 -1
- package/lib/esm/components/Tags.js +1 -1
- package/lib/esm/components/Tags.js.map +1 -1
- package/lib/esm/components/index.js.map +1 -1
- package/lib/esm/config/config.js.map +1 -1
- package/lib/esm/config/default.js +9 -1
- package/lib/esm/config/default.js.map +1 -1
- package/lib/esm/config/index.js.map +1 -1
- package/lib/esm/constants.js +10 -47
- package/lib/esm/constants.js.map +1 -1
- package/lib/esm/containers/AsyncApi/AsyncApi.js +22 -10
- package/lib/esm/containers/AsyncApi/AsyncApi.js.map +1 -1
- package/lib/esm/containers/AsyncApi/Layout.js +28 -20
- package/lib/esm/containers/AsyncApi/Layout.js.map +1 -1
- package/lib/esm/containers/AsyncApi/Standalone.js +3 -1
- package/lib/esm/containers/AsyncApi/Standalone.js.map +1 -1
- package/lib/esm/containers/Error/Error.js +2 -2
- package/lib/esm/containers/Error/Error.js.map +1 -1
- package/lib/esm/containers/Info/Info.js +8 -8
- package/lib/esm/containers/Info/Info.js.map +1 -1
- package/lib/esm/containers/Messages/Message.js +21 -9
- package/lib/esm/containers/Messages/Message.js.map +1 -1
- package/lib/esm/containers/Messages/MessageExample.js +17 -11
- package/lib/esm/containers/Messages/MessageExample.js.map +1 -1
- package/lib/esm/containers/Messages/Messages.js +13 -9
- package/lib/esm/containers/Messages/Messages.js.map +1 -1
- package/lib/esm/containers/Operations/Operation.js +87 -39
- package/lib/esm/containers/Operations/Operation.js.map +1 -1
- package/lib/esm/containers/Operations/Operations.js +19 -13
- package/lib/esm/containers/Operations/Operations.js.map +1 -1
- package/lib/esm/containers/Schemas/Schema.js +14 -0
- package/lib/esm/containers/Schemas/Schema.js.map +1 -0
- package/lib/esm/containers/Schemas/Schemas.js +22 -0
- package/lib/esm/containers/Schemas/Schemas.js.map +1 -0
- package/lib/esm/containers/Servers/Security.js +143 -0
- package/lib/esm/containers/Servers/Security.js.map +1 -0
- package/lib/esm/containers/Servers/Server.js +15 -9
- package/lib/esm/containers/Servers/Server.js.map +1 -1
- package/lib/esm/containers/Servers/Servers.js +11 -7
- package/lib/esm/containers/Servers/Servers.js.map +1 -1
- package/lib/esm/containers/Sidebar/Sidebar.js +191 -136
- package/lib/esm/containers/Sidebar/Sidebar.js.map +1 -1
- package/lib/esm/contexts/index.js +1 -0
- package/lib/esm/contexts/index.js.map +1 -1
- package/lib/esm/contexts/useConfig.js +6 -0
- package/lib/esm/contexts/useConfig.js.map +1 -0
- package/lib/esm/contexts/useSpec.js +2 -2
- package/lib/esm/contexts/useSpec.js.map +1 -1
- package/lib/esm/helpers/bindingsHelpers.js +21 -0
- package/lib/esm/helpers/bindingsHelpers.js.map +1 -0
- package/lib/esm/helpers/common.js +14 -0
- package/lib/esm/helpers/common.js.map +1 -0
- package/lib/esm/helpers/index.js +1 -2
- package/lib/esm/helpers/index.js.map +1 -1
- package/lib/esm/helpers/marked.js +1 -1
- package/lib/esm/helpers/marked.js.map +1 -1
- package/lib/esm/helpers/message.js +38 -8
- package/lib/esm/helpers/message.js.map +1 -1
- package/lib/esm/helpers/parser.js +17 -13
- package/lib/esm/helpers/parser.js.map +1 -1
- package/lib/esm/helpers/schema.js +182 -142
- package/lib/esm/helpers/schema.js.map +1 -1
- package/lib/esm/helpers/server.js +49 -0
- package/lib/esm/helpers/server.js.map +1 -1
- package/lib/esm/helpers/specification.js +36 -18
- package/lib/esm/helpers/specification.js.map +1 -1
- package/lib/esm/index.js.map +1 -1
- package/lib/esm/types.js +2 -46
- package/lib/esm/types.js.map +1 -1
- package/lib/esm/without-parser.js.map +1 -1
- package/lib/types/components/Bindings.d.ts +2 -1
- package/lib/types/components/Bindings.d.ts.map +1 -1
- package/lib/types/components/CollapseButton.d.ts +1 -0
- package/lib/types/components/CollapseButton.d.ts.map +1 -1
- package/lib/types/components/Extensions.d.ts.map +1 -1
- package/lib/types/components/Schema.d.ts +5 -4
- package/lib/types/components/Schema.d.ts.map +1 -1
- package/lib/types/components/Tag.d.ts +2 -2
- package/lib/types/components/Tag.d.ts.map +1 -1
- package/lib/types/components/Tags.d.ts +2 -2
- package/lib/types/components/Tags.d.ts.map +1 -1
- package/lib/types/config/config.d.ts +8 -0
- package/lib/types/config/config.d.ts.map +1 -1
- package/lib/types/config/default.d.ts.map +1 -1
- package/lib/types/constants.d.ts +10 -26
- package/lib/types/constants.d.ts.map +1 -1
- package/lib/types/containers/AsyncApi/AsyncApi.d.ts +2 -2
- package/lib/types/containers/AsyncApi/AsyncApi.d.ts.map +1 -1
- package/lib/types/containers/AsyncApi/Layout.d.ts +2 -2
- package/lib/types/containers/AsyncApi/Layout.d.ts.map +1 -1
- package/lib/types/containers/AsyncApi/Standalone.d.ts +2 -2
- package/lib/types/containers/AsyncApi/Standalone.d.ts.map +1 -1
- package/lib/types/containers/Info/Info.d.ts.map +1 -1
- package/lib/types/containers/Messages/Message.d.ts +3 -2
- package/lib/types/containers/Messages/Message.d.ts.map +1 -1
- package/lib/types/containers/Messages/MessageExample.d.ts +5 -4
- package/lib/types/containers/Messages/MessageExample.d.ts.map +1 -1
- package/lib/types/containers/Messages/Messages.d.ts.map +1 -1
- package/lib/types/containers/Operations/Operation.d.ts +4 -3
- package/lib/types/containers/Operations/Operation.d.ts.map +1 -1
- package/lib/types/containers/Operations/Operations.d.ts.map +1 -1
- package/lib/types/containers/Schemas/Schema.d.ts +9 -0
- package/lib/types/containers/Schemas/Schema.d.ts.map +1 -0
- package/lib/types/containers/Schemas/Schemas.d.ts +3 -0
- package/lib/types/containers/Schemas/Schemas.d.ts.map +1 -0
- package/lib/types/containers/Servers/Security.d.ts +10 -0
- package/lib/types/containers/Servers/Security.d.ts.map +1 -0
- package/lib/types/containers/Servers/Server.d.ts +2 -2
- package/lib/types/containers/Servers/Server.d.ts.map +1 -1
- package/lib/types/containers/Servers/Servers.d.ts.map +1 -1
- package/lib/types/containers/Sidebar/Sidebar.d.ts +1 -9
- package/lib/types/containers/Sidebar/Sidebar.d.ts.map +1 -1
- package/lib/types/contexts/index.d.ts +1 -0
- package/lib/types/contexts/index.d.ts.map +1 -1
- package/lib/types/contexts/useConfig.d.ts +5 -0
- package/lib/types/contexts/useConfig.d.ts.map +1 -0
- package/lib/types/contexts/useSpec.d.ts +3 -5
- package/lib/types/contexts/useSpec.d.ts.map +1 -1
- package/lib/types/helpers/bindingsHelpers.d.ts +8 -0
- package/lib/types/helpers/bindingsHelpers.d.ts.map +1 -0
- package/lib/types/helpers/common.d.ts +5 -0
- package/lib/types/helpers/common.d.ts.map +1 -0
- package/lib/types/helpers/index.d.ts +1 -2
- package/lib/types/helpers/index.d.ts.map +1 -1
- package/lib/types/helpers/message.d.ts +4 -3
- package/lib/types/helpers/message.d.ts.map +1 -1
- package/lib/types/helpers/parser.d.ts.map +1 -1
- package/lib/types/helpers/schema.d.ts +16 -12
- package/lib/types/helpers/schema.d.ts.map +1 -1
- package/lib/types/helpers/server.d.ts +6 -1
- package/lib/types/helpers/server.d.ts.map +1 -1
- package/lib/types/helpers/specification.d.ts +7 -4
- package/lib/types/helpers/specification.d.ts.map +1 -1
- package/lib/types/types.d.ts +12 -305
- package/lib/types/types.d.ts.map +1 -1
- package/package.json +30 -17
- package/styles/default.css +752 -658
- package/styles/default.min.css +3 -3
- package/lib/cjs/containers/Servers/ServerSecurity.js +0 -101
- package/lib/cjs/containers/Servers/ServerSecurity.js.map +0 -1
- package/lib/cjs/helpers/bemClasses.js +0 -49
- package/lib/cjs/helpers/bemClasses.js.map +0 -1
- package/lib/cjs/helpers/toKebabCase.js +0 -15
- package/lib/cjs/helpers/toKebabCase.js.map +0 -1
- package/lib/esm/containers/Servers/ServerSecurity.js +0 -95
- package/lib/esm/containers/Servers/ServerSecurity.js.map +0 -1
- package/lib/esm/helpers/bemClasses.js +0 -46
- package/lib/esm/helpers/bemClasses.js.map +0 -1
- package/lib/esm/helpers/toKebabCase.js +0 -11
- package/lib/esm/helpers/toKebabCase.js.map +0 -1
- package/lib/types/containers/Servers/ServerSecurity.d.ts +0 -8
- package/lib/types/containers/Servers/ServerSecurity.d.ts.map +0 -1
- package/lib/types/helpers/bemClasses.d.ts +0 -14
- package/lib/types/helpers/bemClasses.d.ts.map +0 -1
- package/lib/types/helpers/toKebabCase.d.ts +0 -2
- package/lib/types/helpers/toKebabCase.d.ts.map +0 -1
package/README.md
CHANGED
|
@@ -1,19 +1,12 @@
|
|
|
1
|
-
|
|
2
|
-
<img src="./.github/assets/logo.png" alt="AsyncAPI logo" width="200">
|
|
3
|
-
<br>
|
|
4
|
-
React Component
|
|
5
|
-
</h5>
|
|
6
|
-
<h4 align="center">React component for AsyncAPI 2.0 specification. Available also as a Web Component.</h4>
|
|
1
|
+
[](https://www.asyncapi.com)
|
|
7
2
|
|
|
8
|
-
|
|
3
|
+
React component for AsyncAPI specification. Available also as a Web Component, but not only.
|
|
9
4
|
|
|
10
|
-
|
|
5
|
+
 [](https://gitpod.io/#https://github.com/asyncapi/asyncapi-react/tree/next)
|
|
11
6
|
|
|
12
7
|
## Overview
|
|
13
8
|
|
|
14
|
-
|
|
15
|
-
|
|
16
|
-
> **CAUTION**: This package only supports AsyncAPI 2.0 specification. If you use 1.x, we recommend that you upgrade to the latest AsyncAPI version using the [Node.js](https://github.com/asyncapi/converter) or [Go](https://github.com/asyncapi/converter-go) converters.
|
|
9
|
+
The official [React](https://reactjs.org/) 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.
|
|
17
10
|
|
|
18
11
|
<!-- toc is generated with GitHub Actions do not remove toc markers -->
|
|
19
12
|
|
|
@@ -26,6 +19,9 @@ A official [React](https://reactjs.org/) component for AsyncAPI 2.0 specificatio
|
|
|
26
19
|
- [Props](#props)
|
|
27
20
|
- [Features](#features)
|
|
28
21
|
- [Styles](#styles)
|
|
22
|
+
* [Default styles](#default-styles)
|
|
23
|
+
* [Custom styles](#custom-styles)
|
|
24
|
+
* [Custom logo](#custom-logo)
|
|
29
25
|
- [Playground](#playground)
|
|
30
26
|
- [Modules](#modules)
|
|
31
27
|
- [Development](#development)
|
|
@@ -47,7 +43,7 @@ Run this command to install the component in your project:
|
|
|
47
43
|
npm install --save @asyncapi/react-component
|
|
48
44
|
```
|
|
49
45
|
|
|
50
|
-
Check out this
|
|
46
|
+
Check out this sandbox application that uses the React component:
|
|
51
47
|
|
|
52
48
|
[](https://codesandbox.io/s/asyncapi-react-component-in-action-wvdy2)
|
|
53
49
|
|
|
@@ -101,6 +97,7 @@ To check how to use web-component or use a component in other technologies see:
|
|
|
101
97
|
- [Using in Angular](./docs/usage/angular.md)
|
|
102
98
|
- [Using in Vue](./docs/usage/vue.md)
|
|
103
99
|
- [Using in NextJS](./docs/usage/nextjs.md)
|
|
100
|
+
- [Standalone bundle usage](./docs/usage/standalone-bundle.md)
|
|
104
101
|
- [Web Component usage](./docs/usage/web-component.md)
|
|
105
102
|
|
|
106
103
|
## Props
|
|
@@ -124,6 +121,7 @@ For a list and description of features offered by the AsyncAPI React component,
|
|
|
124
121
|
|
|
125
122
|
## Styles
|
|
126
123
|
|
|
124
|
+
### Default styles
|
|
127
125
|
To use default styles import them as follows:
|
|
128
126
|
|
|
129
127
|
``` js
|
|
@@ -132,6 +130,70 @@ import "@asyncapi/react-component/styles/default.css";
|
|
|
132
130
|
import "@asyncapi/react-component/styles/default.min.css";
|
|
133
131
|
```
|
|
134
132
|
|
|
133
|
+
### Custom styles
|
|
134
|
+
The AsyncAPI React component does not set any global fonts. This component allows the usage of your custom `font-family` and other styling.
|
|
135
|
+
|
|
136
|
+
This can be done by defining the styles in a file or inline using a `<style>` tag in the `<head>` section of the page where you are using AsyncAPI React component.
|
|
137
|
+
|
|
138
|
+
Example custom styles (defined in the `styles/custom.css` file):
|
|
139
|
+
```css
|
|
140
|
+
html {
|
|
141
|
+
-moz-tab-size: 4;
|
|
142
|
+
-o-tab-size: 4;
|
|
143
|
+
tab-size: 4;
|
|
144
|
+
line-height: 1.15;
|
|
145
|
+
-webkit-text-size-adjust: 100%;
|
|
146
|
+
}
|
|
147
|
+
|
|
148
|
+
body {
|
|
149
|
+
margin: 0;
|
|
150
|
+
font-family: system-ui, -apple-system, Segoe UI, Roboto, Helvetica, Arial, sans-serif, Apple Color Emoji, Segoe UI Emoji;
|
|
151
|
+
}
|
|
152
|
+
```
|
|
153
|
+
|
|
154
|
+
If you are using the component in a project that uses a bundler like Webpack, don't forget to import the custom styles.
|
|
155
|
+
|
|
156
|
+
``` js
|
|
157
|
+
import "styles/custom.css";
|
|
158
|
+
import "@asyncapi/react-component/styles/default.min.css";
|
|
159
|
+
```
|
|
160
|
+
|
|
161
|
+
If you are using the [standalone bundle](./docs/usage/standalone-bundle.md), you can put the custom styles as a style sheet link or as an inline style in the `<head>` section of the HTML code:
|
|
162
|
+
|
|
163
|
+
```html
|
|
164
|
+
<head>
|
|
165
|
+
<!-- Custom style sheet -->
|
|
166
|
+
<link rel="stylesheet" href="./styles/custom.css">
|
|
167
|
+
|
|
168
|
+
<!-- OR as inline style -->
|
|
169
|
+
<style>
|
|
170
|
+
html{-moz-tab-size:4;-o-tab-size:4;tab-size:4;line-height:1.15;-webkit-text-size-adjust:100%};
|
|
171
|
+
body{margin:0;font-family:system-ui,-apple-system,Segoe UI,Roboto,Helvetica,Arial,sans-serif,Apple Color Emoji,Segoe UI Emoji};
|
|
172
|
+
</style>
|
|
173
|
+
|
|
174
|
+
<link rel="stylesheet" href="https://unpkg.com/@asyncapi/react-component@latest/styles/default.min.css">
|
|
175
|
+
|
|
176
|
+
...
|
|
177
|
+
</head>
|
|
178
|
+
```
|
|
179
|
+
|
|
180
|
+
### Custom logo
|
|
181
|
+
|
|
182
|
+
The AsyncAPI component supports the option to use a custom logo. By using the `x-logo` custom extension in the [InfoObject](https://github.com/asyncapi/spec/blob/master/spec/asyncapi.md#infoObject), a logo will be shown in the top left corner.
|
|
183
|
+
|
|
184
|
+
> **NOTE**: The logo will only appear if the [sidebar option](./docs/configuration/config-modification.md#definition) is enabled.
|
|
185
|
+
|
|
186
|
+
```yaml
|
|
187
|
+
asyncapi: 2.2.0
|
|
188
|
+
info:
|
|
189
|
+
title: Account Service
|
|
190
|
+
version: 1.0.0
|
|
191
|
+
description: This service is in charge of processing user signups.
|
|
192
|
+
x-logo: 'https://raw.githubusercontent.com/asyncapi/spec/master/assets/logo.png'
|
|
193
|
+
channels:
|
|
194
|
+
...
|
|
195
|
+
```
|
|
196
|
+
|
|
135
197
|
## Playground
|
|
136
198
|
|
|
137
199
|
This repository comes in with a [Playground application](https://asyncapi.github.io/asyncapi-react/). Test it to see the component in action and play with it before you use it in your application.
|
|
@@ -141,7 +203,6 @@ You can also run the Playground application locally by following [this](./docs/d
|
|
|
141
203
|
## Modules
|
|
142
204
|
|
|
143
205
|
The `@asyncapi/react-component` package has 3 crafted JS modules to be used in various environments:
|
|
144
|
-
|
|
145
206
|
- `esm` (ECMAScript Modules) is intended for use in a single-page applications with predefined environments like [`create-react-app`](https://github.com/facebook/create-react-app) that are capable of resolving dependencies (via Webpack, Browserify, etc). It can also be used on the server side (for tasks like Server Side Rendering) when the application is using `esm`.
|
|
146
207
|
- `cjs` (CommonJS Modules) similar uses as for `esm` modules, but using CommonJS modules.
|
|
147
208
|
- `umd` (Universal Module Definition) is a dependency-free module that includes everything you need to serve AsyncAPI documentation (however [React](https://github.com/facebook/react/tree/master/packages/react) and [ReactDOM](https://github.com/facebook/react/tree/master/packages/react-dom) dependencies must be served separately) on a single-page application that can't resolve npm module dependencies or in normal HTML page. We have 2 types of minified `umd` bundles, with and without [AsyncAPI Parser](https://github.com/asyncapi/parser-js) in paths:
|
|
@@ -171,29 +232,53 @@ Thanks goes to these wonderful people ([emoji key](https://github.com/all-contri
|
|
|
171
232
|
<!-- prettier-ignore-start -->
|
|
172
233
|
<!-- markdownlint-disable -->
|
|
173
234
|
<table>
|
|
174
|
-
<
|
|
175
|
-
<
|
|
176
|
-
|
|
177
|
-
|
|
178
|
-
|
|
179
|
-
|
|
180
|
-
|
|
181
|
-
|
|
182
|
-
|
|
183
|
-
|
|
184
|
-
<
|
|
185
|
-
|
|
186
|
-
|
|
187
|
-
|
|
188
|
-
|
|
189
|
-
|
|
190
|
-
|
|
191
|
-
|
|
192
|
-
|
|
193
|
-
<
|
|
194
|
-
|
|
195
|
-
|
|
196
|
-
|
|
235
|
+
<tbody>
|
|
236
|
+
<tr>
|
|
237
|
+
<td align="center" valign="top" width="14.28%"><a href="https://github.com/magicmatatjahu"><img src="https://avatars2.githubusercontent.com/u/20404945?v=4?s=100" width="100px;" alt="Maciej UrbaΕczyk"/><br /><sub><b>Maciej UrbaΕczyk</b></sub></a><br /><a href="https://github.com/asyncapi/asyncapi-react/commits?author=magicmatatjahu" title="Code">π»</a> <a href="https://github.com/asyncapi/asyncapi-react/commits?author=magicmatatjahu" title="Documentation">π</a> <a href="#ideas-magicmatatjahu" title="Ideas, Planning, & Feedback">π€</a> <a href="#maintenance-magicmatatjahu" title="Maintenance">π§</a> <a href="https://github.com/asyncapi/asyncapi-react/pulls?q=is%3Apr+reviewed-by%3Amagicmatatjahu" title="Reviewed Pull Requests">π</a> <a href="https://github.com/asyncapi/asyncapi-react/commits?author=magicmatatjahu" title="Tests">β οΈ</a> <a href="#infra-magicmatatjahu" title="Infrastructure (Hosting, Build-Tools, etc)">π</a> <a href="https://github.com/asyncapi/asyncapi-react/issues?q=author%3Amagicmatatjahu" title="Bug reports">π</a> <a href="#example-magicmatatjahu" title="Examples">π‘</a></td>
|
|
238
|
+
<td align="center" valign="top" width="14.28%"><a href="https://github.com/kazydek"><img src="https://avatars0.githubusercontent.com/u/40655785?v=4?s=100" width="100px;" alt="Karolina Zydek"/><br /><sub><b>Karolina Zydek</b></sub></a><br /><a href="https://github.com/asyncapi/asyncapi-react/commits?author=kazydek" title="Documentation">π</a> <a href="https://github.com/asyncapi/asyncapi-react/pulls?q=is%3Apr+reviewed-by%3Akazydek" title="Reviewed Pull Requests">π</a> <a href="#maintenance-kazydek" title="Maintenance">π§</a></td>
|
|
239
|
+
<td align="center" valign="top" width="14.28%"><a href="https://github.com/akucharska"><img src="https://avatars3.githubusercontent.com/u/20790348?v=4?s=100" width="100px;" alt="Agata"/><br /><sub><b>Agata</b></sub></a><br /><a href="https://github.com/asyncapi/asyncapi-react/commits?author=akucharska" title="Code">π»</a> <a href="#maintenance-akucharska" title="Maintenance">π§</a></td>
|
|
240
|
+
<td align="center" valign="top" width="14.28%"><a href="http://resume.github.io/?derberg"><img src="https://avatars1.githubusercontent.com/u/6995927?v=4?s=100" width="100px;" alt="Lukasz Gornicki"/><br /><sub><b>Lukasz Gornicki</b></sub></a><br /><a href="https://github.com/asyncapi/asyncapi-react/commits?author=derberg" title="Documentation">π</a> <a href="#example-derberg" title="Examples">π‘</a> <a href="#ideas-derberg" title="Ideas, Planning, & Feedback">π€</a> <a href="https://github.com/asyncapi/asyncapi-react/commits?author=derberg" title="Code">π»</a> <a href="#infra-derberg" title="Infrastructure (Hosting, Build-Tools, etc)">π</a> <a href="https://github.com/asyncapi/asyncapi-react/issues?q=author%3Aderberg" title="Bug reports">π</a> <a href="#blog-derberg" title="Blogposts">π</a> <a href="#maintenance-derberg" title="Maintenance">π§</a></td>
|
|
241
|
+
<td align="center" valign="top" width="14.28%"><a href="https://github.com/aerfio"><img src="https://avatars0.githubusercontent.com/u/17271979?v=4?s=100" width="100px;" alt="Mateusz PuczyΕski"/><br /><sub><b>Mateusz PuczyΕski</b></sub></a><br /><a href="https://github.com/asyncapi/asyncapi-react/commits?author=aerfio" title="Code">π»</a> <a href="https://github.com/asyncapi/asyncapi-react/commits?author=aerfio" title="Documentation">π</a> <a href="#ideas-aerfio" title="Ideas, Planning, & Feedback">π€</a> <a href="#maintenance-aerfio" title="Maintenance">π§</a> <a href="https://github.com/asyncapi/asyncapi-react/pulls?q=is%3Apr+reviewed-by%3Aaerfio" title="Reviewed Pull Requests">π</a> <a href="https://github.com/asyncapi/asyncapi-react/commits?author=aerfio" title="Tests">β οΈ</a></td>
|
|
242
|
+
<td align="center" valign="top" width="14.28%"><a href="https://www.hash-tech.ch"><img src="https://avatars1.githubusercontent.com/u/35898?v=4?s=100" width="100px;" alt="Hesyar Uzuner"/><br /><sub><b>Hesyar Uzuner</b></sub></a><br /><a href="https://github.com/asyncapi/asyncapi-react/issues?q=author%3Ahesyar" title="Bug reports">π</a> <a href="https://github.com/asyncapi/asyncapi-react/commits?author=hesyar" title="Code">π»</a></td>
|
|
243
|
+
<td align="center" valign="top" width="14.28%"><a href="https://marcusilgner.com"><img src="https://avatars0.githubusercontent.com/u/160025?v=4?s=100" width="100px;" alt="Marcus Ilgner"/><br /><sub><b>Marcus Ilgner</b></sub></a><br /><a href="https://github.com/asyncapi/asyncapi-react/issues?q=author%3Amilgner" title="Bug reports">π</a> <a href="https://github.com/asyncapi/asyncapi-react/commits?author=milgner" title="Code">π»</a></td>
|
|
244
|
+
</tr>
|
|
245
|
+
<tr>
|
|
246
|
+
<td align="center" valign="top" width="14.28%"><a href="https://github.com/dhenneke"><img src="https://avatars0.githubusercontent.com/u/720821?v=4?s=100" width="100px;" alt="Dominik Henneke"/><br /><sub><b>Dominik Henneke</b></sub></a><br /><a href="https://github.com/asyncapi/asyncapi-react/commits?author=dhenneke" title="Code">π»</a></td>
|
|
247
|
+
<td align="center" valign="top" width="14.28%"><a href="https://github.com/Fox32"><img src="https://avatars1.githubusercontent.com/u/648527?v=4?s=100" width="100px;" alt="Oliver Sand"/><br /><sub><b>Oliver Sand</b></sub></a><br /><a href="https://github.com/asyncapi/asyncapi-react/commits?author=Fox32" title="Code">π»</a></td>
|
|
248
|
+
<td align="center" valign="top" width="14.28%"><a href="https://github.com/JakubIwanowski"><img src="https://avatars0.githubusercontent.com/u/25127286?v=4?s=100" width="100px;" alt="Jakub Iwanowski"/><br /><sub><b>Jakub Iwanowski</b></sub></a><br /><a href="https://github.com/asyncapi/asyncapi-react/commits?author=JakubIwanowski" title="Code">π»</a></td>
|
|
249
|
+
<td align="center" valign="top" width="14.28%"><a href="https://github.com/depimomo"><img src="https://avatars3.githubusercontent.com/u/12368942?v=4?s=100" width="100px;" alt="depimomo"/><br /><sub><b>depimomo</b></sub></a><br /><a href="https://github.com/asyncapi/asyncapi-react/commits?author=depimomo" title="Tests">β οΈ</a></td>
|
|
250
|
+
<td align="center" valign="top" width="14.28%"><a href="https://github.com/sanskar-p"><img src="https://avatars0.githubusercontent.com/u/54014518?v=4?s=100" width="100px;" alt="Sanskar Patro"/><br /><sub><b>Sanskar Patro</b></sub></a><br /><a href="https://github.com/asyncapi/asyncapi-react/commits?author=sanskar-p" title="Code">π»</a></td>
|
|
251
|
+
<td align="center" valign="top" width="14.28%"><a href="https://github.com/DanielChuDC"><img src="https://avatars3.githubusercontent.com/u/52316624?v=4?s=100" width="100px;" alt="danielchu"/><br /><sub><b>danielchu</b></sub></a><br /><a href="#infra-DanielChuDC" title="Infrastructure (Hosting, Build-Tools, etc)">π</a></td>
|
|
252
|
+
<td align="center" valign="top" width="14.28%"><a href="http://www.fmvilas.com"><img src="https://avatars3.githubusercontent.com/u/242119?v=4?s=100" width="100px;" alt="Fran MΓ©ndez"/><br /><sub><b>Fran MΓ©ndez</b></sub></a><br /><a href="https://github.com/asyncapi/asyncapi-react/commits?author=fmvilas" title="Code">π»</a> <a href="#maintenance-fmvilas" title="Maintenance">π§</a></td>
|
|
253
|
+
</tr>
|
|
254
|
+
<tr>
|
|
255
|
+
<td align="center" valign="top" width="14.28%"><a href="http://www.codeblock.ch"><img src="https://avatars3.githubusercontent.com/u/416252?v=4?s=100" width="100px;" alt="Claude Gex"/><br /><sub><b>Claude Gex</b></sub></a><br /><a href="https://github.com/asyncapi/asyncapi-react/commits?author=gexclaude" title="Code">π»</a> <a href="#platform-gexclaude" title="Packaging/porting to new platform">π¦</a> <a href="#ideas-gexclaude" title="Ideas, Planning, & Feedback">π€</a></td>
|
|
256
|
+
<td align="center" valign="top" width="14.28%"><a href="https://github.com/c-pius"><img src="https://avatars0.githubusercontent.com/u/22994291?v=4?s=100" width="100px;" alt="c-pius"/><br /><sub><b>c-pius</b></sub></a><br /><a href="https://github.com/asyncapi/asyncapi-react/commits?author=c-pius" title="Code">π»</a> <a href="https://github.com/asyncapi/asyncapi-react/issues?q=author%3Ac-pius" title="Bug reports">π</a></td>
|
|
257
|
+
<td align="center" valign="top" width="14.28%"><a href="https://github.com/aeworxet"><img src="https://avatars.githubusercontent.com/u/16149591?v=4?s=100" width="100px;" alt="Viacheslav Turovskyi"/><br /><sub><b>Viacheslav Turovskyi</b></sub></a><br /><a href="https://github.com/asyncapi/asyncapi-react/commits?author=aeworxet" title="Documentation">π</a> <a href="https://github.com/asyncapi/asyncapi-react/commits?author=aeworxet" title="Code">π»</a></td>
|
|
258
|
+
<td align="center" valign="top" width="14.28%"><a href="https://github.com/195858"><img src="https://avatars.githubusercontent.com/u/3858485?v=4?s=100" width="100px;" alt="195858"/><br /><sub><b>195858</b></sub></a><br /><a href="https://github.com/asyncapi/asyncapi-react/commits?author=195858" title="Code">π»</a></td>
|
|
259
|
+
<td align="center" valign="top" width="14.28%"><a href="https://github.com/aayushmau5"><img src="https://avatars.githubusercontent.com/u/54525741?v=4?s=100" width="100px;" alt="Aayush Kumar Sahu"/><br /><sub><b>Aayush Kumar Sahu</b></sub></a><br /><a href="https://github.com/asyncapi/asyncapi-react/commits?author=aayushmau5" title="Code">π»</a></td>
|
|
260
|
+
<td align="center" valign="top" width="14.28%"><a href="http://dalelane.co.uk/"><img src="https://avatars.githubusercontent.com/u/1444788?v=4?s=100" width="100px;" alt="Dale Lane"/><br /><sub><b>Dale Lane</b></sub></a><br /><a href="https://github.com/asyncapi/asyncapi-react/commits?author=dalelane" title="Code">π»</a> <a href="#ideas-dalelane" title="Ideas, Planning, & Feedback">π€</a></td>
|
|
261
|
+
<td align="center" valign="top" width="14.28%"><a href="https://github.com/m1ner79"><img src="https://avatars.githubusercontent.com/u/55558050?v=4?s=100" width="100px;" alt="Michal Gornicki"/><br /><sub><b>Michal Gornicki</b></sub></a><br /><a href="https://github.com/asyncapi/asyncapi-react/commits?author=m1ner79" title="Documentation">π</a></td>
|
|
262
|
+
</tr>
|
|
263
|
+
<tr>
|
|
264
|
+
<td align="center" valign="top" width="14.28%"><a href="https://github.com/samriddhi"><img src="https://avatars.githubusercontent.com/u/5325345?v=4?s=100" width="100px;" alt="Samriddhi"/><br /><sub><b>Samriddhi</b></sub></a><br /><a href="https://github.com/asyncapi/asyncapi-react/commits?author=samriddhi" title="Code">π»</a></td>
|
|
265
|
+
<td align="center" valign="top" width="14.28%"><a href="https://github.com/W0nderMuffin"><img src="https://avatars.githubusercontent.com/u/9134093?v=4?s=100" width="100px;" alt="W0nderMuffin"/><br /><sub><b>W0nderMuffin</b></sub></a><br /><a href="https://github.com/asyncapi/asyncapi-react/commits?author=W0nderMuffin" title="Code">π»</a></td>
|
|
266
|
+
<td align="center" valign="top" width="14.28%"><a href="https://falzetti.me/"><img src="https://avatars.githubusercontent.com/u/2318450?v=4?s=100" width="100px;" alt="Andrea Falzetti"/><br /><sub><b>Andrea Falzetti</b></sub></a><br /><a href="https://github.com/asyncapi/asyncapi-react/commits?author=andreafalzetti" title="Code">π»</a></td>
|
|
267
|
+
<td align="center" valign="top" width="14.28%"><a href="https://schwank.cc/"><img src="https://avatars.githubusercontent.com/u/8232196?v=4?s=100" width="100px;" alt="Dominik Schwank"/><br /><sub><b>Dominik Schwank</b></sub></a><br /><a href="https://github.com/asyncapi/asyncapi-react/commits?author=dschwank" title="Code">π»</a></td>
|
|
268
|
+
<td align="center" valign="top" width="14.28%"><a href="https://github.com/kaiszybiak"><img src="https://avatars.githubusercontent.com/u/38980361?v=4?s=100" width="100px;" alt="Kai Szybiak"/><br /><sub><b>Kai Szybiak</b></sub></a><br /><a href="https://github.com/asyncapi/asyncapi-react/commits?author=kaiszybiak" title="Code">π»</a></td>
|
|
269
|
+
<td align="center" valign="top" width="14.28%"><a href="http://blog.ineat-conseil.fr/"><img src="https://avatars.githubusercontent.com/u/5501911?v=4?s=100" width="100px;" alt="Ludovic Dussart"/><br /><sub><b>Ludovic Dussart</b></sub></a><br /><a href="https://github.com/asyncapi/asyncapi-react/commits?author=M3lkior" title="Code">π»</a></td>
|
|
270
|
+
<td align="center" valign="top" width="14.28%"><a href="https://github.com/GreenRover"><img src="https://avatars.githubusercontent.com/u/512850?v=4?s=100" width="100px;" alt="Heiko Henning"/><br /><sub><b>Heiko Henning</b></sub></a><br /><a href="https://github.com/asyncapi/asyncapi-react/commits?author=GreenRover" title="Code">π»</a></td>
|
|
271
|
+
</tr>
|
|
272
|
+
<tr>
|
|
273
|
+
<td align="center" valign="top" width="14.28%"><a href="https://github.com/thim81"><img src="https://avatars.githubusercontent.com/u/952446?v=4?s=100" width="100px;" alt="thim81"/><br /><sub><b>thim81</b></sub></a><br /><a href="https://github.com/asyncapi/asyncapi-react/commits?author=thim81" title="Code">π»</a></td>
|
|
274
|
+
<td align="center" valign="top" width="14.28%"><a href="https://github.com/marceloavan"><img src="https://avatars.githubusercontent.com/u/3874978?v=4?s=100" width="100px;" alt="Marcelo Avancini"/><br /><sub><b>Marcelo Avancini</b></sub></a><br /><a href="https://github.com/asyncapi/asyncapi-react/commits?author=marceloavan" title="Code">π»</a></td>
|
|
275
|
+
<td align="center" valign="top" width="14.28%"><a href="https://shishkin.org/"><img src="https://avatars.githubusercontent.com/u/124065?v=4?s=100" width="100px;" alt="Sergey Shishkin"/><br /><sub><b>Sergey Shishkin</b></sub></a><br /><a href="https://github.com/asyncapi/asyncapi-react/commits?author=shishkin" title="Code">π»</a></td>
|
|
276
|
+
<td align="center" valign="top" width="14.28%"><a href="https://github.com/sarisia"><img src="https://avatars.githubusercontent.com/u/33576079?v=4?s=100" width="100px;" alt="Takakazu Fu"/><br /><sub><b>Takakazu Fu</b></sub></a><br /><a href="https://github.com/asyncapi/asyncapi-react/commits?author=sarisia" title="Code">π»</a></td>
|
|
277
|
+
<td align="center" valign="top" width="14.28%"><a href="https://github.com/Laupetin"><img src="https://avatars.githubusercontent.com/u/9197140?v=4?s=100" width="100px;" alt="Jan"/><br /><sub><b>Jan</b></sub></a><br /><a href="https://github.com/asyncapi/asyncapi-react/commits?author=Laupetin" title="Code">π»</a></td>
|
|
278
|
+
<td align="center" valign="top" width="14.28%"><a href="https://github.com/AceTheCreator"><img src="https://avatars.githubusercontent.com/u/40604284?v=4?s=100" width="100px;" alt="Ace "/><br /><sub><b>Ace </b></sub></a><br /><a href="https://github.com/asyncapi/asyncapi-react/commits?author=AceTheCreator" title="Code">π»</a></td>
|
|
279
|
+
<td align="center" valign="top" width="14.28%"><a href="https://github.com/jonaslagoni"><img src="https://avatars.githubusercontent.com/u/13396189?v=4?s=100" width="100px;" alt="Jonas Lagoni"/><br /><sub><b>Jonas Lagoni</b></sub></a><br /><a href="https://github.com/asyncapi/asyncapi-react/commits?author=jonaslagoni" title="Code">π»</a></td>
|
|
280
|
+
</tr>
|
|
281
|
+
</tbody>
|
|
197
282
|
</table>
|
|
198
283
|
|
|
199
284
|
<!-- markdownlint-restore -->
|