GraphiQL API Documentation
    Preparing search index...

    Variable useEditorStoreConst

    useEditorStore: () => {
        addTab: () => void;
        changeTab: (index: number) => void;
        closeTab: (index: number) => void;
        externalFragments: Map<string, FragmentDefinitionNode>;
        headerEditor?: IStandaloneCodeEditor;
        initialHeaders: string;
        initialQuery: string;
        initialVariables: string;
        moveTab: (newOrder: TabState[]) => void;
        queryEditor?: IStandaloneCodeEditor;
        responseEditor?: IStandaloneCodeEditor;
        setHeaderEditor: (headerEditor: IStandaloneCodeEditor) => void;
        setOperationName: (operationName: string) => void;
        setQueryEditor: (queryEditor: IStandaloneCodeEditor) => void;
        setResponseEditor: (responseEditor: IStandaloneCodeEditor) => void;
        setShouldPersistHeaders: (persist: boolean) => void;
        setVariableEditor: (variableEditor: IStandaloneCodeEditor) => void;
        shouldPersistHeaders: boolean;
        updateActiveTabValues: (
            partialTab: Partial<Omit<TabState, "id" | "hash" | "title">>,
        ) => void;
        variableEditor?: IStandaloneCodeEditor;
    } = useEditorContext

    Type Declaration

      • (): {
            addTab: () => void;
            changeTab: (index: number) => void;
            closeTab: (index: number) => void;
            externalFragments: Map<string, FragmentDefinitionNode>;
            headerEditor?: IStandaloneCodeEditor;
            initialHeaders: string;
            initialQuery: string;
            initialVariables: string;
            moveTab: (newOrder: TabState[]) => void;
            queryEditor?: IStandaloneCodeEditor;
            responseEditor?: IStandaloneCodeEditor;
            setHeaderEditor: (headerEditor: IStandaloneCodeEditor) => void;
            setOperationName: (operationName: string) => void;
            setQueryEditor: (queryEditor: IStandaloneCodeEditor) => void;
            setResponseEditor: (responseEditor: IStandaloneCodeEditor) => void;
            setShouldPersistHeaders: (persist: boolean) => void;
            setVariableEditor: (variableEditor: IStandaloneCodeEditor) => void;
            shouldPersistHeaders: boolean;
            updateActiveTabValues: (
                partialTab: Partial<Omit<TabState, "id" | "hash" | "title">>,
            ) => void;
            variableEditor?: IStandaloneCodeEditor;
        }
      • Returns {
            addTab: () => void;
            changeTab: (index: number) => void;
            closeTab: (index: number) => void;
            externalFragments: Map<string, FragmentDefinitionNode>;
            headerEditor?: IStandaloneCodeEditor;
            initialHeaders: string;
            initialQuery: string;
            initialVariables: string;
            moveTab: (newOrder: TabState[]) => void;
            queryEditor?: IStandaloneCodeEditor;
            responseEditor?: IStandaloneCodeEditor;
            setHeaderEditor: (headerEditor: IStandaloneCodeEditor) => void;
            setOperationName: (operationName: string) => void;
            setQueryEditor: (queryEditor: IStandaloneCodeEditor) => void;
            setResponseEditor: (responseEditor: IStandaloneCodeEditor) => void;
            setShouldPersistHeaders: (persist: boolean) => void;
            setVariableEditor: (variableEditor: IStandaloneCodeEditor) => void;
            shouldPersistHeaders: boolean;
            updateActiveTabValues: (
                partialTab: Partial<Omit<TabState, "id" | "hash" | "title">>,
            ) => void;
            variableEditor?: IStandaloneCodeEditor;
        }

        • addTab: () => void
        • changeTab: (index: number) => void
        • closeTab: (index: number) => void
        • externalFragments: Map<string, FragmentDefinitionNode>

          A map of fragment definitions using the fragment name as a key which are made available to include in the query.

        • OptionalheaderEditor?: IStandaloneCodeEditor

          The Monaco Editor instance used in the request headers editor, used to edit HTTP headers.

        • initialHeaders: string

          The contents of the request headers editor when initially rendering the provider component.

        • initialQuery: string

          The contents of the operation editor when initially rendering the provider component.

        • initialVariables: string

          The contents of the variables editor when initially rendering the provider component.

        • moveTab: (newOrder: TabState[]) => void
        • OptionalqueryEditor?: IStandaloneCodeEditor

          The Monaco Editor instance used in the operation editor.

        • OptionalresponseEditor?: IStandaloneCodeEditor

          The Monaco Editor instance used in the response editor.

        • setHeaderEditor: (headerEditor: IStandaloneCodeEditor) => void
        • setOperationName: (operationName: string) => void
        • setQueryEditor: (queryEditor: IStandaloneCodeEditor) => void
        • setResponseEditor: (responseEditor: IStandaloneCodeEditor) => void
        • setShouldPersistHeaders: (persist: boolean) => void
        • setVariableEditor: (variableEditor: IStandaloneCodeEditor) => void
        • shouldPersistHeaders: boolean

          If the contents of the request headers editor are persisted in storage.

        • updateActiveTabValues: (partialTab: Partial<Omit<TabState, "id" | "hash" | "title">>) => void
        • OptionalvariableEditor?: IStandaloneCodeEditor

          The Monaco Editor instance used in the variables editor.

        Use useGraphiQLActions and useGraphiQL hooks instead.

    Use useGraphiQLActions and useGraphiQL hooks instead.