next-sanity
Version:
Sanity.io toolkit for Next.js
78 lines (75 loc) • 2.09 kB
TypeScript
/**
* In Next 13 appDir mode (`/app/studio/[[...index]]/head.tsx`):
* ```tsx
* // If you don't want to change any defaults you can just re-export the head component directly:
* export {NextStudioHead as default} from 'next-sanity/studio/head'
*
* // To customize it, use it as a children component:
* import {NextStudioHead} from 'next-sanity/studio/head'
*
* export default function CustomStudioHead() {
* return (
* <>
* <NextStudioHead favicons={false} />
* <link
* rel="icon"
* type="image/png"
* sizes="32x32"
* href="https://www.sanity.io/static/images/favicons/favicon-32x32.png"
* />
* </>
* )
* }
* ```
* If you're using Next 12 or the `pages` folder (`/pages/studio/[[...index]].tsx`):
* ```tsx
* import Head from 'next/head'
* import {NextStudio} from 'next-sanity/studio'
* import {NextStudioHead} from 'next-sanity/studio/head'
*
* export default function StudioPage() {
* return (
* <>
* <Head>
* <NextStudioHead />
* </Head>
* <NextStudio config={config} />
* </>
* )
* }
* ```
* @public
*/
export declare function NextStudioHead(props: NextStudioHeadProps): JSX.Element
/** @public */
export declare interface NextStudioHeadProps {
/**
* @defaultValue 'utf-8'
*/
charSet?: false | string
/**
* Sets the viewport to `viewport-fit=cover` to integrate with iOS devices with display cutouts (The Notch, Dynamic Island).
* Also sets `width=device-width, initial-scale=1` to make the studio page responsive.
* @defaultValue true
*/
viewport?: boolean
/**
* It's common practice to hide the address to your Sanity Studio from search engines by setting `robots` to `noindex`
* @defaultValue 'noindex'
*/
robots?: false | string
/**
* @defaultValue 'same-origin'
*/
referrer?: false | string
/**
* Adds the same favicons as the `npx sanity dev` pipeline.
* @defaultValue true
*/
favicons?: boolean
/**
* @defaultValue 'Sanity'
*/
title?: false | string
}
export {}