Options
All
  • Public
  • Public/Protected
  • All
Menu

Class DocExplorer

DocExplorer

Shows documentations for GraphQL definitions from the schema.

Props:

  • schema: A required GraphQLSchema instance that provides GraphQL document definitions.

Children:

  • Any provided children will be positioned in the right-hand-side of the top bar. Typically this will be a "close" button for temporary explorer.

Hierarchy

  • any
    • DocExplorer

Index

Constructors

constructor

  • new DocExplorer(props: DocExplorerProps): DocExplorer
  • Parameters

    • props: DocExplorerProps

    Returns DocExplorer

Methods

handleClickField

  • Parameters

    Returns void

handleClickType

  • handleClickType(type: GraphQLNamedType): void
  • Parameters

    • type: GraphQLNamedType

    Returns void

handleNavBackClick

  • handleNavBackClick(): void
  • Returns void

handleSearch

  • handleSearch(value: string): void
  • Parameters

    • value: string

    Returns void

render

  • render(): Element
  • Returns Element

reset

  • reset(): void
  • Returns void

shouldComponentUpdate

  • shouldComponentUpdate(nextProps: DocExplorerProps, nextState: DocExplorerState): boolean
  • Parameters

    • nextProps: DocExplorerProps
    • nextState: DocExplorerState

    Returns boolean

showDoc

  • showDoc(typeOrField: GraphQLNamedType | FieldType): void
  • Parameters

    Returns void

showDocForReference

  • showDocForReference(reference: any): void
  • Parameters

    • reference: any

    Returns void

showSearch

  • showSearch(search: string): void
  • Parameters

    • search: string

    Returns void

Generated using TypeDoc