Interface EditorActions

Hierarchy

EditorActions

Index

Properties

Methods

Properties

copyQuery

copyQuery: () => Promise<void>

Copy a query to clipboard.

Type declaration

- (): Promise<void>
- Returns Promise<void>

mergeQuery

mergeQuery: () => void

Merge fragments definitions into operation definition.

Type declaration

- (): void
- Returns void

prettifyEditors

prettifyEditors: () => Promise<void>

Prettify query, variables and request headers editors.

Type declaration

- (): Promise<void>
- Returns Promise<void>

Methods

addTab

addTab(): void

- Defined in packages/graphiql-react/src/stores/editor.ts:155
Add a new tab.

Returns void

changeTab

changeTab(index: number): void

- Defined in packages/graphiql-react/src/stores/editor.ts:161
Switch to a different tab.

Parameters
- index: number
  
  The index of the tab that should be switched to.
Returns void

closeTab

closeTab(index: number): void

- Defined in packages/graphiql-react/src/stores/editor.ts:175
Close a tab. If the currently active tab is closed, the tab before it will become active. If there is no tab before the closed one, the tab after it will become active.

Parameters
- index: number
  
  The index of the tab that should be closed.
Returns void

moveTab

moveTab(newOrder: TabState[]): void

- Defined in packages/graphiql-react/src/stores/editor.ts:167
Move a tab to a new spot.

Parameters
- newOrder: TabState[]
  
  The new order for the tabs.
Returns void

setEditor

setEditor(state: Pick<EditorSlice, "headerEditor" | "queryEditor" | "responseEditor" | "variableEditor">): void

- Defined in packages/graphiql-react/src/stores/editor.ts:191
Set the Monaco Editor instance used in the specified editor.

Parameters
- state: Pick<EditorSlice, "headerEditor" | "queryEditor" | "responseEditor" | "variableEditor">
Returns void

setOperationFacts

setOperationFacts(facts: { documentAST?: DocumentNode; operationName?: undefined | string; operations?: OperationDefinitionNode[] }): void

- Defined in packages/graphiql-react/src/stores/editor.ts:210
Parameters
- facts: { documentAST?: DocumentNode; operationName?: undefined | string; operations?: OperationDefinitionNode[] }
  - Optional documentAST?: DocumentNode
  - Optional operationName?: undefined | string
  - Optional operations?: OperationDefinitionNode[]
Returns void

setOperationName

setOperationName(operationName: string): void

- Defined in packages/graphiql-react/src/stores/editor.ts:201
Changes the operation name and invokes the onEditOperationName callback.

Parameters
- operationName: string
Returns void

setShouldPersistHeaders

setShouldPersistHeaders(persist: boolean): void

- Defined in packages/graphiql-react/src/stores/editor.ts:206
Changes if headers should be persisted.

Parameters
- persist: boolean
Returns void

storeTabs

storeTabs(tabsState: TabsState): void

- Defined in packages/graphiql-react/src/stores/editor.ts:208
Parameters
- tabsState: TabsState
Returns void

updateActiveTabValues

updateActiveTabValues(partialTab: Partial<Omit<TabState, "id" | "hash" | "title">>): void

- Defined in packages/graphiql-react/src/stores/editor.ts:184
Update the state for the tab that is currently active. This will be reflected in the tabs object and the state will be persisted in storage (if available).

Parameters
- partialTab: Partial<Omit<TabState, "id" | "hash" | "title">>
  
  A partial tab state object that will override the current values. The properties id, hash and title cannot be changed.
Returns void

Generated using TypeDoc