feat(swagger-ui-react): add support of filter prop (#7547)
Co-authored-by: Mahtis Michel <mathis.michel@outlook.de> Co-authored-by: Vladimir Gorej <vladimir.gorej@gmail.com> Closes #7546
This commit is contained in:
@@ -125,6 +125,10 @@ Controls whether the "Try it out" section should start enabled. The default is f
|
|||||||
|
|
||||||
⚠️ 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.
|
⚠️ 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.
|
||||||
|
|
||||||
|
#### `filter`: PropTypes.oneOfType([PropTypes.string, PropTypes.bool])
|
||||||
|
|
||||||
|
If set, enables filtering. The top bar will show an edit box that you can use to filter the tagged operations that are shown. Can be Boolean to enable or disable, or a string, in which case filtering will be enabled using that string as the filter expression. Filtering is case sensitive matching the filter expression anywhere inside the tag. See Swagger UI's [Plug Points](https://github.com/swagger-api/swagger-ui/blob/master/docs/customization/plug-points.md#fnopsfilter) to customize the filtering behavior.
|
||||||
|
|
||||||
#### `requestSnippetsEnabled`: PropTypes.bool,
|
#### `requestSnippetsEnabled`: PropTypes.bool,
|
||||||
|
|
||||||
Enables the request snippet section. When disabled, the legacy curl snippet will be used. The default is false.
|
Enables the request snippet section. When disabled, the legacy curl snippet will be used. The default is false.
|
||||||
|
|||||||
@@ -29,6 +29,7 @@ export default class SwaggerUI extends React.Component {
|
|||||||
showMutatedRequest: typeof this.props.showMutatedRequest === "boolean" ? this.props.showMutatedRequest : true,
|
showMutatedRequest: typeof this.props.showMutatedRequest === "boolean" ? this.props.showMutatedRequest : true,
|
||||||
deepLinking: typeof this.props.deepLinking === "boolean" ? this.props.deepLinking : false,
|
deepLinking: typeof this.props.deepLinking === "boolean" ? this.props.deepLinking : false,
|
||||||
showExtensions: this.props.showExtensions,
|
showExtensions: this.props.showExtensions,
|
||||||
|
filter: ["boolean", "string"].includes(typeof this.props.filter) ? this.props.filter : false,
|
||||||
})
|
})
|
||||||
|
|
||||||
this.system = ui
|
this.system = ui
|
||||||
@@ -97,7 +98,7 @@ SwaggerUI.propTypes = {
|
|||||||
docExpansion: PropTypes.oneOf(["list", "full", "none"]),
|
docExpansion: PropTypes.oneOf(["list", "full", "none"]),
|
||||||
supportedSubmitMethods: PropTypes.arrayOf(
|
supportedSubmitMethods: PropTypes.arrayOf(
|
||||||
PropTypes.oneOf(["get", "put", "post", "delete", "options", "head", "patch", "trace"])
|
PropTypes.oneOf(["get", "put", "post", "delete", "options", "head", "patch", "trace"])
|
||||||
),
|
),
|
||||||
plugins: PropTypes.arrayOf(PropTypes.object),
|
plugins: PropTypes.arrayOf(PropTypes.object),
|
||||||
displayOperationId: PropTypes.bool,
|
displayOperationId: PropTypes.bool,
|
||||||
showMutatedRequest: PropTypes.bool,
|
showMutatedRequest: PropTypes.bool,
|
||||||
@@ -106,6 +107,10 @@ SwaggerUI.propTypes = {
|
|||||||
presets: PropTypes.arrayOf(PropTypes.func),
|
presets: PropTypes.arrayOf(PropTypes.func),
|
||||||
deepLinking: PropTypes.bool,
|
deepLinking: PropTypes.bool,
|
||||||
showExtensions: PropTypes.bool,
|
showExtensions: PropTypes.bool,
|
||||||
|
filter: PropTypes.oneOfType([
|
||||||
|
PropTypes.string,
|
||||||
|
PropTypes.bool,
|
||||||
|
]),
|
||||||
requestSnippetsEnabled: PropTypes.bool,
|
requestSnippetsEnabled: PropTypes.bool,
|
||||||
requestSnippets: PropTypes.object,
|
requestSnippets: PropTypes.object,
|
||||||
tryItOutEnabled: PropTypes.bool,
|
tryItOutEnabled: PropTypes.bool,
|
||||||
@@ -119,6 +124,7 @@ SwaggerUI.defaultProps = {
|
|||||||
presets: [],
|
presets: [],
|
||||||
deepLinking: false,
|
deepLinking: false,
|
||||||
showExtensions: false,
|
showExtensions: false,
|
||||||
|
filter: false,
|
||||||
requestSnippetsEnabled: false,
|
requestSnippetsEnabled: false,
|
||||||
requestSnippets: {
|
requestSnippets: {
|
||||||
generators: {
|
generators: {
|
||||||
|
|||||||
Reference in New Issue
Block a user