sanity-plugin-iframe-pane

sanity-plugin-iframe-pane

NOTE

This is the Sanity Studio v3 version of sanity-plugin-iframe-pane.

For the v2 version, please refer to the v2-branch.

Display any URL in a View Pane, along with helpful buttons to Copy the URL or open in a new tab.

Accepts either a string or an async function to resolve a URL based on the current document.

Installation

npm install --save sanity-plugin-iframe-pane@studio-v3

or

yarn add sanity-plugin-iframe-pane@studio-v3

Usage

This is designed to be used as a Component inside of a View.

// ./src/deskStructure.js
import Iframe from 'sanity-plugin-iframe-pane'

// ...all other list items

S.view
  .component(Iframe)
  .options({
    // Required: Accepts an async function
    url: (doc) => resolveProductionUrl(doc),
    // OR a string
    url: `https://sanity.io`,
    // Optional: Set the default size
    defaultSize: `mobile`, // default `desktop`
    // Optional: Add a reload button, or reload on new document revisions
    reload: {
      button: true, // default `undefined`
      revision: true, // default `undefined`
    },
  })
  .title('Preview')

License

MIT-licensed. See LICENSE.

Develop & test

This plugin uses @sanity/plugin-kit with default configuration for build & watch scripts.

See Testing a plugin in Sanity Studio on how to run this plugin with hotreload in the studio.

Release new version

Run "CI & Release" workflow. Make sure to select the studio-v3 branch and check "Release new version".

Semantic release will only release on configured branches, so it is safe to run release on any branch.

Changelog

2.0.1-v3-studio.1 (2022-10-31)

Bug Fixes

• release: studio-v3 tag (4598eec)