improvement: expose docExpansion as a prop in swagger-ui-react (via #…

…5242)

* improvement: expose docExpansion setting as a prop in swagger-ui-react

* Update README.md

* Update index.js

* Update README.md

* Update README.md

flavors/swagger-ui-react/README.md

@@ -65,9 +65,16 @@ or a Promise that resolves to a request object.
 A function that accepts a response object, and returns either a response object
 or a Promise that resolves to a response object.
 
+#### `docExpansion`: PropTypes.oneOf(['list', 'full', 'none'])
+
+Controls the default expansion setting for the operations and tags. It can be 'list' (expands only the tags), 'full' (expands the tags and operations) or 'none' (expands nothing). The default value is 'list'.
+
+⚠️ 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.
+
 ## Limitations
 
 * Not all configuration bindings are available.
+* Some props are only applied on mount, and cannot be updated reliably.
 * OAuth redirection handling is not supported.
 * Topbar/Standalone mode is not supported.
 * Custom plugins are not supported.

flavors/swagger-ui-react/index.js

@@ -16,6 +16,7 @@ export default class SwaggerUI extends React.Component {
       requestInterceptor: this.requestInterceptor,
       responseInterceptor: this.responseInterceptor,
       onComplete: this.onComplete,
+      docExpansion: this.props.docExpansion,
     })
 
     this.system = ui
@@ -80,4 +81,5 @@ SwaggerUI.propTypes = {
   requestInterceptor: PropTypes.func,
   responseInterceptor: PropTypes.func,
   onComplete: PropTypes.func,
+  docExpansion: PropTypes.oneOf(['list', 'full', 'none']),
 }