@graphiql/react/dist/stores/plugin.d.ts

[Changelog](https://github.com/graphql/graphiql/blob/main/packages/graphiql-react/CHANGELOG.md) | [API Docs](https://graphiql-test.netlify.app/typedoc/modules/graphiql_react.html) | [NPM](https://www.npmjs.com/package/@graphiql/react)

import { ComponentType } from 'react';
import { StateCreator } from 'zustand';
import { SlicesWithActions } from '../types';
export interface GraphiQLPlugin {
    /**
     * A component that renders content into the plugin pane.
     */
    content: ComponentType;
    /**
     * A component that renders an icon that will be shown inside a button that
     * toggles the plugin visibility.
     */
    icon: ComponentType;
    /**
     * The unique title of the plugin. If two plugins are present with the same
     * title, the provider component will throw an error.
     */
    title: string;
}
export interface PluginSlice {
    /**
     * A list of all current plugins, including the built-in ones (the doc
     * explorer and the history).
     * @default []
     */
    plugins: GraphiQLPlugin[];
    /**
     * The plugin which is currently visible.
     */
    visiblePlugin: GraphiQLPlugin | null;
    /**
     * The plugin which is used to display the reference documentation when selecting a type.
     * Pass `null` to remove plugin.
     */
    referencePlugin?: GraphiQLPlugin | null;
    /**
     * Invoked when the visibility state of any plugin changes.
     * @param visiblePlugin - The plugin object that is now visible. If no plugin
     * is visible, the function will be invoked with `null`.
     */
    onTogglePluginVisibility?(visiblePlugin: GraphiQLPlugin | null): void;
}
export interface PluginActions {
    /**
     * Defines the plugin which is currently visible.
     * @param plugin - The plugin that should become visible. You can either pass
     * the plugin object (has to be referentially equal to the one passed as
     * prop) or the plugin title as string. If `null` is passed, no plugin will
     * be visible.
     */
    setVisiblePlugin(plugin?: GraphiQLPlugin | string | null): void;
    setPlugins(plugins: GraphiQLPlugin[]): void;
}
export interface PluginProps extends Pick<PluginSlice, 'referencePlugin' | 'onTogglePluginVisibility'> {
    /**
     * This prop accepts a list of plugins that will be shown in addition to the
     * built-in ones (the doc explorer and the history).
     * @default []
     */
    plugins?: GraphiQLPlugin[];
    /**
     * This prop can be used to set the visibility state of plugins. Every time
     * this prop changes, the visibility state will be overridden. Note that the
     * visibility state can change in between these updates, for example, by
     * calling the `setVisiblePlugin` function provided by the context.
     */
    visiblePlugin?: GraphiQLPlugin | string;
}
declare type CreatePluginSlice = (initial: Pick<PluginSlice, 'onTogglePluginVisibility' | 'referencePlugin'>) => StateCreator<SlicesWithActions, [
], [
], PluginSlice & {
    actions: PluginActions;
}>;
export declare const createPluginSlice: CreatePluginSlice;
export {};