kyy/swagger-ui
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

feat(swagger-ui-react): add support for layout prop (#6639)

Browse Source 
layout prop represents the name of a component available
via the plugin system to use as the top-level
layout for Swagger UI.
This commit is contained in:
Vladimir Gorej
2020-11-19 23:12:32 +01:00
committed by GitHub
parent d2ef8f31b9
commit a6673d7c60
2 changed files with 13 additions and 3 deletions
Download Patch File Download Diff File Expand all files Collapse all files

6
flavors/swagger-ui-react/README.md
View File

@@ -43,6 +43,12 @@ Remote URL to an OpenAPI document that Swagger UI will fetch, parse, and display
⚠️ Don't use this in conjunction with `spec` - unpredictable behavior may occur.
#### `layout`: PropTypes.string
The name of a component available via the plugin system to use as the top-level layout for Swagger UI. The default value is `BaseLayout`.
⚠️ This prop is currently only applied once, on mount. Changes to this prop's value will not be propagated to the underlying Swagger UI instance. A future version of this module will remove this limitation, and the change will not be considered a breaking change.
#### `onComplete`: PropTypes.func
> `(system) => void`