Redocly/redoc
1
1
Fork 0
mirror of https://github.com/Redocly/redoc.git synced 2025-08-09 06:34:53 +03:00
Code Issues Packages Projects Releases Wiki Activity

fix: add console to README.md

Browse Source 
add enableConsole option to the README.md
correct the wrong import
This commit is contained in:
Arian Rahimi 2020-02-10 13:06:45 +03:30
parent aa988ba21b
commit 5973a4485d
3 changed files with 2 additions and 34 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1
README.md
View File

@ -246,6 +246,7 @@ You can use all of the following options with standalone version on <redoc> tag
* `onlyRequiredInSamples` - shows only required fields in request samples. * `onlyRequiredInSamples` - shows only required fields in request samples.
* `jsonSampleExpandLevel` - set the default expand level for JSON payload samples (responses and request body). Special value 'all' expands all levels. The default value is `2`. * `jsonSampleExpandLevel` - set the default expand level for JSON payload samples (responses and request body). Special value 'all' expands all levels. The default value is `2`.
* `menuToggle` - if true clicking second time on expanded menu item will collapse it, default `false` * `menuToggle` - if true clicking second time on expanded menu item will collapse it, default `false`
* `enableConsole` - you should set true if you want to use the built-in console, default `false`
* `expandDefaultServerVariables` - enable expanding default server variables, default `false` * `expandDefaultServerVariables` - enable expanding default server variables, default `false`
* `theme` - ReDoc theme. Not documented yet. For details check source code: [theme.ts](https://github.com/Redocly/redoc/blob/master/src/theme.ts) * `theme` - ReDoc theme. Not documented yet. For details check source code: [theme.ts](https://github.com/Redocly/redoc/blob/master/src/theme.ts)

3
src/components/Console/ConsoleViewer.tsx
View File

@ -1,9 +1,8 @@
import { observer } from 'mobx-react'; import { observer } from 'mobx-react';
import * as React from 'react'; import * as React from 'react';
import { SecuritySchemeModel } from '../../../typings/services/models';
import { SubmitButton } from '../../common-elements/buttons'; import { SubmitButton } from '../../common-elements/buttons';
import { FlexLayoutReverse } from '../../common-elements/panels'; import { FlexLayoutReverse } from '../../common-elements/panels';
import { FieldModel, OperationModel, SecuritySchemesModel } from '../../services/models'; import { FieldModel, OperationModel, SecuritySchemeModel, SecuritySchemesModel } from '../../services/models';
import { ConsoleResponse } from '../ConsoleResponse/Response'; import { ConsoleResponse } from '../ConsoleResponse/Response';
import { ConsoleEditor } from './ConsoleEditor'; import { ConsoleEditor } from './ConsoleEditor';

32
typings/styled-patch.d.ts vendored
View File

@ -1,32 +0,0 @@
import * as styledComponents from 'styled-components';
// FIXME
declare module 'styled-components' {
export interface ThemedStyledFunction<
C extends keyof JSX.IntrinsicElements | React.ComponentType<any>,
T extends object,
O extends object = {},
A extends keyof any = never
> extends ThemedStyledFunctionBase<C, T, O, A> {
withConfig(config: any): any;
// tslint:enable:unified-signatures
}
interface ThemedStyledComponentsModule<T> {
keyframes(
strings: TemplateStringsArray | string[],
...interpolations: SimpleInterpolation[]
): Keyframes;
}
export interface BaseThemedCssFunction<T extends object> {
<P extends object>(
first:
| TemplateStringsArray
| CSSObject
| InterpolationFunction<ThemedStyledProps<P, T>>
| string[],
...interpolations: Array<Interpolation<ThemedStyledProps<P, T>>>
): FlattenInterpolation<ThemedStyledProps<P, T>>;
}
}