Redocly/redoc
1
1
Fork 0
mirror of https://github.com/Redocly/redoc.git synced 2025-01-31 18:14:07 +03:00
Code Issues Packages Projects Releases Wiki Activity

chore: add docs

Browse Source
This commit is contained in:
Roman Hotsiy 2019-07-29 17:31:27 +03:00
parent bfd703d2da
commit 1504ade0e2
No known key found for this signature in database
GPG Key ID: 5CB7B3ACABA57CB0
2 changed files with 2 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1
README.md
View File

@ -244,6 +244,7 @@ You can use all of the following options with standalone version on <redoc> tag
* `disableSearch` - disable search indexing and search box * `disableSearch` - disable search indexing and search box
* `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`
* `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)
## Advanced usage of standalone version ## Advanced usage of standalone version

5
src/components/SideMenu/SideMenu.tsx
View File

@ -9,10 +9,7 @@ import { PerfectScrollbarWrap } from '../../common-elements/perfect-scrollbar';
import { RedocAttribution } from './styled.elements'; import { RedocAttribution } from './styled.elements';
@observer @observer
export class SideMenu extends React.Component<{ export class SideMenu extends React.Component<{ menu: MenuStore; className?: string }> {
menu: MenuStore;
className?: string;
}> {
static contextType = OptionsContext; static contextType = OptionsContext;
private _updateScroll?: () => void; private _updateScroll?: () => void;