feat: Add options expandAllFields hideShelfIcon hideHttpVerbs

demo/playground/hmr-playground.tsx

@@ -26,7 +26,15 @@ const specUrl =
   (userUrl && userUrl[1]) || (swagger ? 'swagger.yaml' : big ? 'big-openapi.json' : 'openapi.yaml');
 
 let store;
-const options: RedocRawOptions = { nativeScrollbars: false, maxDisplayedEnumValues: 3 };
+const options: RedocRawOptions = {
+  nativeScrollbars: false,
+  maxDisplayedEnumValues: 3,
+  expandAllSchemaFields: true,
+  hideShelfIcon: true,
+  hideHttpVerbs: true
+};
+
+console.log('options', options)
 
 async function init() {
   const spec = await loadAndBundleSpec(specUrl);

src/components/Fields/Field.tsx

@@ -24,6 +24,7 @@ export interface FieldProps extends SchemaOptions {
 
   field: FieldModel;
   expandByDefault?: boolean;
+  expandAllFields?: boolean;
 
   renderDiscriminatorSwitch?: (opts: FieldProps) => JSX.Element;
 }
@@ -31,7 +32,11 @@ export interface FieldProps extends SchemaOptions {
 @observer
 export class Field extends React.Component<FieldProps> {
   toggle = () => {
-    if (this.props.field.expanded === undefined && this.props.expandByDefault) {
+    if (
+      this.props.field.expanded === undefined &&
+      !this.props.field.expandAll &&
+      this.props.expandByDefault
+    ) {
       this.props.field.expanded = false;
     } else {
       this.props.field.toggle();
@@ -46,11 +51,13 @@ export class Field extends React.Component<FieldProps> {
   };
 
   render() {
-    const { className, field, isLast, expandByDefault } = this.props;
+    const { className, field, isLast, expandByDefault, expandAllFields } = this.props;
     const { name, deprecated, required, kind } = field;
     const withSubSchema = !field.schema.isPrimitive && !field.schema.isCircular;
 
-    const expanded = field.expanded === undefined ? expandByDefault : field.expanded;
+    const expandChildren = field.expandAll === undefined ? expandAllFields : field.expandAll;
+    const expanded =
+      field.expanded === undefined ? expandChildren || expandByDefault : field.expanded;
 
     const paramName = withSubSchema ? (
       <ClickablePropertyNameCell
@@ -90,6 +97,7 @@ export class Field extends React.Component<FieldProps> {
             <PropertyCellWithInner colSpan={2}>
               <InnerPropertiesWrap>
                 <Schema
+                  expandAllFields={expandAllFields}
                   schema={field.schema}
                   skipReadOnly={this.props.skipReadOnly}
                   skipWriteOnly={this.props.skipWriteOnly}

src/components/Schema/ObjectSchema.tsx

@@ -45,6 +45,7 @@ export class ObjectSchema extends React.Component<ObjectSchemaProps> {
       : fields;
 
     const expandByDefault = this.context.expandSingleSchemaField && filteredFields.length === 1;
+    const expandAllFields = this.context.expandAllSchemaFields;
 
     return (
       <PropertiesTable>
@@ -57,6 +58,7 @@ export class ObjectSchema extends React.Component<ObjectSchemaProps> {
                 isLast={isLast}
                 field={field}
                 expandByDefault={expandByDefault}
+                expandAllFields={expandAllFields}
                 renderDiscriminatorSwitch={
                   (discriminator &&
                     discriminator.fieldName === field.name &&

src/components/Schema/Schema.tsx

@@ -13,6 +13,7 @@ import { OneOfSchema } from './OneOfSchema';
 import { l } from '../../services/Labels';
 
 export interface SchemaOptions {
+  expandAllFields?: boolean | string
   showTitle?: boolean;
   skipReadOnly?: boolean;
   skipWriteOnly?: boolean;

src/components/SideMenu/MenuItem.tsx

@@ -8,6 +8,7 @@ import { shortenHTTPVerb } from '../../utils/openapi';
 import { MenuItems } from './MenuItems';
 import { MenuItemLabel, MenuItemLi, MenuItemTitle, OperationBadge } from './styled.elements';
 import { l } from '../../services/Labels';
+import { OptionsContext } from '../OptionsProvider';
 
 export interface MenuItemProps {
   item: IMenuItem;
@@ -17,6 +18,8 @@ export interface MenuItemProps {
 
 @observer
 export class MenuItem extends React.Component<MenuItemProps> {
+  static contextType = OptionsContext;
+
   ref = React.createRef<HTMLLabelElement>();
 
   activate = (evt: React.MouseEvent<HTMLElement>) => {
@@ -40,6 +43,7 @@ export class MenuItem extends React.Component<MenuItemProps> {
 
   render() {
     const { item, withoutChildren } = this.props;
+    const hideShelfIcon = this.context.hideShelfIcon;
     return (
       <MenuItemLi onClick={this.activate} depth={item.depth} data-item-id={item.id}>
         {item.type === 'operation' ? (
@@ -50,7 +54,7 @@ export class MenuItem extends React.Component<MenuItemProps> {
               {item.name}
               {this.props.children}
             </MenuItemTitle>
-            {(item.depth > 0 && item.items.length > 0 && (
+            {(!hideShelfIcon && item.depth > 0 && item.items.length > 0 && (
               <ShelfIcon float={'right'} direction={item.expanded ? 'down' : 'right'} />
             )) ||
               null}
@@ -74,6 +78,8 @@ export interface OperationMenuItemContentProps {
 
 @observer
 export class OperationMenuItemContent extends React.Component<OperationMenuItemContentProps> {
+  static contextType = OptionsContext;
+
   ref = React.createRef<HTMLLabelElement>();
 
   componentDidUpdate() {
@@ -84,6 +90,7 @@ export class OperationMenuItemContent extends React.Component<OperationMenuItemC
 
   render() {
     const { item } = this.props;
+    const hideHttpVerbsMenu = this.context.hideHttpVerbs;
     return (
       <MenuItemLabel
         depth={item.depth}
@@ -94,7 +101,9 @@ export class OperationMenuItemContent extends React.Component<OperationMenuItemC
         {item.isWebhook ? (
           <OperationBadge type="hook">{l('webhook')}</OperationBadge>
         ) : (
-          <OperationBadge type={item.httpVerb}>{shortenHTTPVerb(item.httpVerb)}</OperationBadge>
+          !hideHttpVerbsMenu && (
+            <OperationBadge type={item.httpVerb}>{shortenHTTPVerb(item.httpVerb)}</OperationBadge>
+          )
         )}
         <MenuItemTitle width="calc(100% - 38px)">
           {item.name}

src/services/RedocNormalizedOptions.ts

@@ -1,10 +1,10 @@
 import defaultTheme, { ResolvedThemeInterface, resolveTheme, ThemeInterface } from '../theme';
 import { querySelector } from '../utils/dom';
 import { isNumeric, mergeObjects } from '../utils/helpers';
-
 import { LabelsConfigRaw, setRedocLabels } from './Labels';
 import { MDXComponentMeta } from './MarkdownRenderer';
 
+
 export interface RedocRawOptions {
   theme?: ThemeInterface;
   scrollYOffset?: number | string | (() => number);
@@ -29,6 +29,9 @@ export interface RedocRawOptions {
   simpleOneOfTypeLabel?: boolean | string;
   payloadSampleIdx?: number;
   expandSingleSchemaField?: boolean | string;
+  expandAllSchemaFields?: boolean | string;
+  hideShelfIcon?: boolean | string;
+  hideHttpVerbs?: boolean | string;
 
   unstable_ignoreMimeParameters?: boolean;
 
@@ -184,6 +187,9 @@ export class RedocNormalizedOptions {
   simpleOneOfTypeLabel: boolean;
   payloadSampleIdx: number;
   expandSingleSchemaField: boolean;
+  expandAllSchemaFields: boolean;
+  hideShelfIcon: boolean;
+  hideHttpVerbs: boolean;
 
   /* tslint:disable-next-line */
   unstable_ignoreMimeParameters: boolean;
@@ -240,6 +246,9 @@ export class RedocNormalizedOptions {
     this.simpleOneOfTypeLabel = argValueToBoolean(raw.simpleOneOfTypeLabel);
     this.payloadSampleIdx = RedocNormalizedOptions.normalizePayloadSampleIdx(raw.payloadSampleIdx);
     this.expandSingleSchemaField = argValueToBoolean(raw.expandSingleSchemaField);
+    this.expandAllSchemaFields = argValueToBoolean(raw.expandAllSchemaFields);
+    this.hideShelfIcon = argValueToBoolean(raw.hideShelfIcon);
+    this.hideHttpVerbs = argValueToBoolean(raw.hideHttpVerbs);
 
     this.unstable_ignoreMimeParameters = argValueToBoolean(raw.unstable_ignoreMimeParameters);
 

src/services/models/Field.ts

@@ -1,17 +1,17 @@
 import { action, observable } from 'mobx';
-
 import {
   OpenAPIParameter,
   OpenAPIParameterLocation,
   OpenAPIParameterStyle,
-  Referenced,
+  Referenced
 } from '../../types';
-import { RedocNormalizedOptions } from '../RedocNormalizedOptions';
-
 import { extractExtensions } from '../../utils/openapi';
 import { OpenAPIParser } from '../OpenAPIParser';
+import { RedocNormalizedOptions } from '../RedocNormalizedOptions';
 import { SchemaModel } from './Schema';
 
+
+
 const DEFAULT_SERIALIZATION: Record<
   OpenAPIParameterLocation,
   { explode: boolean; style: OpenAPIParameterStyle }
@@ -51,6 +51,7 @@ export class FieldModel {
   kind: string;
   extensions?: Record<string, any>;
   explode: boolean;
+  expandAll: boolean;
   style?: OpenAPIParameterStyle;
 
   serializationMime?: string;