https://github.com/romeovs/sanity-plugin-graphiql
A Sanity plugin to add GraphiQL to your your Studio
https://github.com/romeovs/sanity-plugin-graphiql
graphiql graphql sanity sanity-io sanity-studio
Last synced: 3 months ago
JSON representation
A Sanity plugin to add GraphiQL to your your Studio
- Host: GitHub
- URL: https://github.com/romeovs/sanity-plugin-graphiql
- Owner: romeovs
- License: mit
- Created: 2023-08-30T17:38:40.000Z (about 2 years ago)
- Default Branch: main
- Last Pushed: 2024-11-24T13:05:50.000Z (11 months ago)
- Last Synced: 2025-02-28T23:47:26.246Z (7 months ago)
- Topics: graphiql, graphql, sanity, sanity-io, sanity-studio
- Language: TypeScript
- Homepage:
- Size: 1.42 MB
- Stars: 1
- Watchers: 2
- Forks: 0
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# sanity-plugin-graphiql
[](https://www.npmjs.com/package/sanity-plugin-graphiql)
[](https://www.npmjs.com/package/sanity-plugin-graphiql)
[](https://github.com/romeovs/sanity-plugin-graphiql/actions/workflows/main.yml)
> This is a **Sanity Studio v3** plugin.
Add GraphiQL to your Sanity Studio.
## Installation
```sh
npm install sanity-plugin-graphiql
```
```sh
pnpm install sanity-plugin-graphiql
```
```sh
yarn add sanity-plugin-graphiql
```
## Usage
Add it as a plugin in `sanity.config.ts` (or .js):
```ts
import {defineConfig} from 'sanity'
import {graphiQLTool} from 'sanity-plugin-graphiql'
export default defineConfig({
//...
plugins: [
graphiQLTool({
apiVersion: '2021-10-21',
// if you want to use a GraphQL api that is
// not a Sanity GraphQL API, you can hardcode the url.
url: 'https://www.example.com/api/my/graphql',
// override the default tool name
name: 'graphiql',
// override the default tool title
title: 'GraphiQL',
// override the default tool icon
icon: BlockElementIcon,
}),
],
})
```
### Options
The following options are required to set up the tool:
- `apiVersion` **required**: the version of the sanity API used for fetching GraphQL metadata
- `url`: set a custom GraphQL api. This removes the ability to select the url from the tool.
- `name`: set a custom name for the tool. (default: `graphiql`)
- `title`: set a custom name for the tool. (default: `GraphiQL`)
- `icon`: set a custom name for the tool. (default: `"@sanity/icons".BlockElementIcon`)
## License
[MIT](LICENSE) © Romeo Van Snick
## Develop & test
This plugin uses [@sanity/plugin-kit](https://github.com/sanity-io/plugin-kit)
with default configuration for build & watch scripts.
See [Testing a plugin in Sanity Studio](https://github.com/sanity-io/plugin-kit#testing-a-plugin-in-sanity-studio)
on how to run this plugin with hotreload in the studio.
### Release new version
Run ["CI & Release" workflow](https://github.com/romeovs/sanity-plugin-graphiql/actions/workflows/main.yml).
Make sure to select the main branch and check "Release new version".
Semantic release will only release on configured branches, so it is safe to run release on any branch.
## Screenshots
#### Dark mode
#### Light mode
