@ graphiql/ 插件收藏
GraphiQL 的一端操作收藏插件 。 将命名的 GraphQL 操作保存到收藏中, 并在稍后再使用它们, 并进行拖放重排, 剪贴板共享, 以及 JSON 导入/ 导出, 用 id 合并而不是复制 .
安装
npm install @graphiql/plugin-collections
确保端点的依赖性也被安装 :
npm install react react-dom graphql @graphiql/react
使用量
收藏插件默认在 GraphiQL 中安装, 所以未修改 <GraphiQL> 已显示收藏栏图标。 使用 COLLECTIONS_PLUGIN 当你通过一个习惯 plugins 阵列并想要保留默认的收藏配置。 使用 collectionsPlugin(options) 以提供自定义存储后端或限制用户可以做什么.
说明: 传递
plugins道具取代了默认的插件集,所以包括您想要的其他插件.
import { GraphiQL } from 'graphiql';
import { createTransport } from '@graphiql/toolkit';
import { COLLECTIONS_PLUGIN } from '@graphiql/plugin-collections';
import 'graphiql/style.css';
import '@graphiql/plugin-collections/style.css';
const transport = createTransport({
url: 'https://swapi-graphql.netlify.app/.netlify/functions/index',
});
function GraphiQLWithCollections() {
return <GraphiQL transport={transport} plugins={[COLLECTIONS_PLUGIN]} />;
}
选项
collectionsPlugin({
storage, // custom persistence backend; see below
readOnly, // default false
allowImportExport, // default true
allowReplace, // default true
});
| 选项 | 默认 | 效果 |
|---|---|---|
storage | 本地调试器 | 习惯 CollectionsStorage (见 自定义存储) (中文(简体) ). |
readOnly | false | 隐藏每个写入负担( 创建、 重命名、 删除、 重排序、 保存、 导入) 。 导出和复制保存可用,这样用户仍然可以共享. |
allowImportExport | true | 何时 false,隐藏导入/导出对话框按钮并关闭粘贴/投放导入. |
allowReplace | true | 何时 false,隐藏破坏性的"取代一切"导入模式,并只保留合并. |
导入和合并行为
收藏品及其内的操作都带有稳定的UUID来活过进出口. 导入时, 插件会用 id 来调节, 而不是重复 :
- 新增行动. 一个你已经拥有的操作 被更新在任何你保存它的地方, 即使你已经移动到不同的收藏。 缺失的父收藏被重新创建 .
- 重新导入一个不变的导出没有任何作用,所以你永远不会得到复制件.
- 当收到的操作与本地副本不同时, 对话框会允许您应用修改, 保存您的版本, 或一次审查每个操作 。 合并从不删除 .
一个操作也可以自己与"Copy操作"共享. 它作为一品收发信封出行,并用其母收发信封印出,因此收发信人可以在进口时重新收发.
自定义存储
持久性可以通过 CollectionsStorage 接口 :
type CollectionsStorage = {
storageKey?: string;
load(): Promise<Collection[]>;
save(collections: Collection[]): Promise<void>;
};
默认写到 localStorage 键下 graphiql:collections。要使用不同的密钥,请通过导出时的适配器 createLocalStorageAdapter 工厂:
import {
collectionsPlugin,
createLocalStorageAdapter,
} from '@graphiql/plugin-collections';
const collections = collectionsPlugin({
storage: createLocalStorageAdapter('my-key'),
});
用自己的服务(REST,一个数据库,一个团队共享的商店)支持收藏,执行接口并传出为 storage数字 :
import { collectionsPlugin } from '@graphiql/plugin-collections';
import type {
Collection,
CollectionsStorage,
} from '@graphiql/plugin-collections';
const apiStorage: CollectionsStorage = {
async load() {
const res = await fetch('/api/collections');
return (await res.json()) as Collection[];
},
async save(collections) {
const response = await fetch('/api/collections', {
method: 'PUT',
headers: { 'content-type': 'application/json' },
body: JSON.stringify(collections),
});
if (!response.ok) {
throw new Error(`Saving collections failed (${response.status})`);
}
},
};
const collections = collectionsPlugin({ storage: apiStorage });
load() 当面板首次挂起时运行一次. save() 在突变后收到完整的收藏列表。 对于工具栏或键盘保存,其承诺必须在写入承诺后解决. 拒绝会使操作变得肮脏并显示GraphiQL中的一个错误. 其他收藏编辑动作仍然会立即更新UI.
团队共享后端和同步
该插件对冲突解决或同步没有意见; 它存在于您的存储适配器中 。 因为每次操作和收集都有一个稳定的ID,你的适配器可以相接地播放 save() 然而,无论这是否是一个简单的后端写作,还是最后写成的政策,还是像Yjs 或 Autommerge 这样的 CRDT , 都需要作出快照和调和。 插件本身在可序列模型上保留 CRUD UI.
该插件不会自行对远程更改作出反应. 当您的后端报告外部变化时, 请打电话 reload() 重读存储并刷新 UI :
import { collectionsStore } from '@graphiql/plugin-collections';
await collectionsStore.getState().actions.reload();
程序访问
该商店及其反应钩被导出用于程序访问:
import {
collectionsStore, // the vanilla zustand store
useCollectionsStore, // React hook: useCollectionsStore(selector)
} from '@graphiql/plugin-collections';
const { actions } = collectionsStore.getState();
// Replace the in-memory collections (e.g. after merging remote state).
// Does NOT write back to storage.
actions.setCollections(nextCollections);
// Re-read from the configured storage and refresh the UI.
await actions.reload();
actions 还暴露了整个 CRUD 表面( 第 1 段)createCollection, (中文(简体) ), addItem, (中文(简体) ), updateItem, (中文(简体) ), deleteItem, (中文(简体) ), moveItem, (中文(简体) ), renameCollection,等等) exportCollections 编号 : exportCollection 编号 : exportItem 和两个阶段 analyzeImport 编号 : applyImport。 。 。 .
出口
COLLECTIONS_PLUGIN——默认插件配置collectionsPlugin(options?)— 自定义配置的插件厂collectionsStore, (中文(简体) ),useCollectionsStore- 商店及其反应钩createLocalStorageAdapter(key), (中文(简体) ),localStorageAdapter内置储存CollectionsSaveDialog— 保存对话框组件- 类型 :
Collection, (中文(简体) ),CollectionItem, (中文(简体) ),CollectionsStorage, (中文(简体) ),CollectionsConfig, (中文(简体) ),ActiveOperation