Function useDocExplorerActions

Returns {
    pop(): void;
    push(item: DocExplorerNavStackItem): void;
    rebuildNavStackWithSchema(schema: GraphQLSchema): void;
    reset(): void;
    resolveSchemaReferenceToNavItem(
        schemaReference: SchemaReference | null,
    ): void;
}

• pop: function

  • pop(): void

    Pop the last item from the navigation stack.

    Returns void

• push: function

  • push(item: DocExplorerNavStackItem): void

    Push an item to the navigation stack.

    Parameters

    • item: DocExplorerNavStackItem

      The item that should be pushed to the stack.

    Returns void

• rebuildNavStackWithSchema: function

  • rebuildNavStackWithSchema(schema: GraphQLSchema): void

    Replace the nav stack with an updated version using the new schema.

    Parameters

    • schema: GraphQLSchema

    Returns void

• reset: function

  • reset(): void

    Reset the navigation stack to its initial state, this will remove all but the initial stack item.

    Returns void

• resolveSchemaReferenceToNavItem: function

  • resolveSchemaReferenceToNavItem(schemaReference: SchemaReference | null): void

    Parameters

    • schemaReference: SchemaReference | null

    Returns void