4.18.3 • Published 6 months ago
@types/swagger-ui-react v4.18.3
Installation
npm install --save @types/swagger-ui-react
Summary
This package contains type definitions for swagger-ui-react (https://github.com/swagger-api/swagger-ui#readme).
Details
Files were exported from https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/swagger-ui-react.
index.d.ts
// Type definitions for swagger-ui-react 4.11
// Project: https://github.com/swagger-api/swagger-ui#readme
// Definitions by: viki.green <https://github.com/VictoriaGreen93>
// Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped
// TypeScript Version: 2.8
import * as React from 'react';
interface Request {
[k: string]: any;
}
interface Response {
[k: string]: any;
}
type System = any;
type PluginGenerator = (system: System) => object;
type Plugin = object | PluginGenerator;
type Preset = () => unknown;
export interface SwaggerUIProps {
spec?: object | string | undefined;
url?: string | undefined;
layout?: string | undefined;
onComplete?: ((system: System) => void) | undefined;
requestInterceptor?: ((req: Request) => Request | Promise<Request>) | undefined;
responseInterceptor?: ((res: Response) => Response | Promise<Response>) | undefined;
docExpansion?: 'list' | 'full' | 'none' | undefined;
defaultModelExpandDepth?: number | undefined;
defaultModelsExpandDepth?: number | undefined;
defaultModelRendering?: "example" | "model";
queryConfigEnabled?: boolean;
plugins?: Plugin[] | undefined;
supportedSubmitMethods?: string[] | undefined;
deepLinking?: boolean | undefined;
showMutatedRequest?: boolean | undefined;
showExtensions?: boolean | undefined;
presets?: Preset[] | undefined;
filter?: string | boolean | undefined;
requestSnippetsEnabled?: boolean | undefined;
requestSnippets?: object | undefined;
displayOperationId?: boolean | undefined;
tryItOutEnabled?: boolean | undefined;
displayRequestDuration?: boolean;
persistAuthorization?: boolean;
withCredentials?: boolean;
}
declare class SwaggerUI extends React.PureComponent<SwaggerUIProps> {}
export default SwaggerUI;
Additional Details
- Last updated: Tue, 10 May 2022 23:31:38 GMT
- Dependencies: @types/react
- Global values: none
Credits
These definitions were written by viki.green.