Options
All
  • Public
  • Public/Protected
  • All
Menu

Index

References

Type aliases

Variables

References

Explorer

Renames and re-exports GraphiQLExplorer

Type aliases

GraphiQLExplorerProps

GraphiQLExplorerProps: { arrowClosed?: ReactNode; arrowOpen?: ReactNode; checkboxChecked?: ReactNode; checkboxUnchecked?: ReactNode; colors?: { atom: string; attribute: string; builtin: string; def: string; keyword: string; number: string; property: string; qualifier: string; string: string; string2: string; variable: string } | null; explorerIsOpen?: undefined | false | true; externalFragments?: FragmentDefinitionNode[]; hideActions?: undefined | false | true; query: string; schema?: GraphQLSchema | null; showAttribution: boolean; styles?: { actionButtonStyle?: CSSProperties; buttonStyle?: CSSProperties; explorerActionsStyle?: CSSProperties } | null; title?: undefined | string; width?: undefined | number; getDefaultFieldNames?: any; getDefaultScalarArgValue?: any; makeDefaultArg?: any; onEdit?: any; onRunOperation?: any; onToggleExplorer?: any }

Type declaration

  • Optional arrowClosed?: ReactNode
  • Optional arrowOpen?: ReactNode
  • Optional checkboxChecked?: ReactNode
  • Optional checkboxUnchecked?: ReactNode
  • Optional colors?: { atom: string; attribute: string; builtin: string; def: string; keyword: string; number: string; property: string; qualifier: string; string: string; string2: string; variable: string } | null
  • Optional explorerIsOpen?: undefined | false | true
  • Optional externalFragments?: FragmentDefinitionNode[]
  • Optional hideActions?: undefined | false | true
  • query: string
  • Optional schema?: GraphQLSchema | null
  • showAttribution: boolean
  • Optional styles?: { actionButtonStyle?: CSSProperties; buttonStyle?: CSSProperties; explorerActionsStyle?: CSSProperties } | null
  • Optional title?: undefined | string
  • Optional width?: undefined | number
  • getDefaultFieldNames: function
    • getDefaultFieldNames(type: GraphQLObjectType): string[]
    • Parameters

      • type: GraphQLObjectType

      Returns string[]

  • getDefaultScalarArgValue: function
    • getDefaultScalarArgValue(parentField: GraphQLField<any, any>, arg: GraphQLArgument | GraphQLInputField, underlyingArgType: GraphQLLeafType): ValueNode
    • Parameters

      • parentField: GraphQLField<any, any>
      • arg: GraphQLArgument | GraphQLInputField
      • underlyingArgType: GraphQLLeafType

      Returns ValueNode

  • makeDefaultArg: function
    • makeDefaultArg(parentField: GraphQLField<any, any>, arg: GraphQLArgument | GraphQLInputField): boolean
    • Parameters

      • parentField: GraphQLField<any, any>
      • arg: GraphQLArgument | GraphQLInputField

      Returns boolean

  • onEdit: function
    • onEdit(newQuery: string): void
    • Parameters

      • newQuery: string

      Returns void

  • onRunOperation: function
    • onRunOperation(name: string | null): void
    • Parameters

      • name: string | null

      Returns void

  • onToggleExplorer: function
    • onToggleExplorer(): void
    • Returns void

Variables

Const GraphiQLExplorer

GraphiQLExplorer: ComponentType<GraphiQLExplorerProps> & { defaultValue: (arg: GraphQLLeafType) => ValueNode }

Generated using TypeDoc