@tinloof/sanity-studio v1.1.3
@tinloof/sanity-studio
A collection of studio plugins, fields, and components to boost your Sanity studio.
Installation
npm install @tinloof/sanity-studio
Table of contents
Pages
Pages is a plugin that wraps Presentation to display your website pages in a sitemap-like navigation and make it possible to create new ones.
Basic usage
1. Configure Pages:
import { pages } from "@tinloof/sanity-studio";
export default defineConfig({
// ... other Sanity Studio config
plugins: [
pages({
// Presentation's configuration
previewUrl: {
previewMode: {
enable: "/api/draft",
},
},
}),
],
});
2. Add a pathname
field to page schemas using the definePage
helper:
import { definePathname } from "@tinloof/sanity-studio";
export default defineType({
type: "document",
name: "modularPage",
fields: [
definePathname({
name: "pathname",
}),
],
});
Documents with a defined pathname
field value are now recognized as pages and are automatically grouped into directories in the pages navigator.
Enabling page creation
Use the creatablePages
option to define which schema types can be used to create pages.
When a page is created, it will automatically have the current folder in its pathname.
import { pages } from "@tinloof/sanity-studio";
export default defineConfig({
// ... other Sanity Studio config
plugins: [
pages({
// Add any documents you want to be creatable from the pages navigator
creatablePages: ["page"],
previewUrl: {
previewMode: {
enable: "/api/draft",
},
},
}),
],
});
Enabling internationalization
The i18n
option can be used to support filtering pages by a locale
field and display internationalized URLs.
When page creation is enabled, the currently selected locale
is also used as an initial value to create new pages.
Pathnames are automatically validated to be unique accros locales.
import { pages } from "@tinloof/sanity-studio";
const i18nConfig = {
locales: [
{ id: "en", title: "English" },
{ id: "fr", title: "French" },
],
defaultLocaleId: "en",
};
export default defineConfig({
// ... other Sanity Studio config
plugins: [
pages({
i18n: i18nConfig,
previewUrl: {
previewMode: {
enable: "/api/draft",
},
},
}),
],
});
/**
* Don't forget to add i18n options and locale field to your document schema
*/
export default defineType({
type: "document",
name: "page",
fields: [
definePathname({
name: "pathname",
options: {
// Add i18n options
i18n: {
enabled: true,
defaultLocaleId: i18nConfig.defaultLocaleId,
},
},
}),
// Add locale field
defineField({
type: "string",
name: "locale",
hidden: true,
}),
],
});
Lock folder renaming
By default, folders can be renamed. Set the folder.canUnlock
option to false
to disable this.
import { definePathname } from "@tinloof/sanity-studio";
export default defineType({
type: "document",
name: "modularPage",
fields: [
definePathname({
name: "pathname",
options: {
folder: {
canUnlock: false,
},
},
}),
],
});
Customizing pages previews
Documents can have their preview customized on the pages navigator using the List Previews API:
export default {
name: "movie",
type: "document",
fields: [
{
title: "Title",
name: "title",
type: "string",
},
{
type: "image",
name: "image",
title: "Image",
},
],
// Preview information
preview: {
select: {
title: "title",
media: "image",
},
prepare({ title, image }) {
return {
title,
media: image,
};
},
},
};
Sections
The defineSection
field lets you easily define a new section schema. Used in combination with the SectionsArrayInput
component, it will render a useful section picker in your Sanity documents.
1. Create a new section schema
// @/sanity/schemas/sections/banner.tsx
export const bannerSection = defineSection({
name: "block.banner",
title: "Banner",
type: "object",
options: {
variants: [
{
/**
* Will be used to display a preview image
* when opening the section picker
*/
assetUrl: "/images/blocks/hero.png",
},
],
},
fields: [
defineField({
name: "bannerSection",
type: "string",
}),
],
});
2. Create a sections list array
// @/sanity/schemas/sections/index.tsx
import { bannerSection } from "@/sanity/schemas/sections/banner";
export const sections = [bannerSection];
3. Add a section picker to your document
Here, the SectionsArrayInput
component is used to render a useful section picker in your Sanity documents.
// @/sanity/schemas/sections/index.tsx
import { sections } = "@/sanity/schemas/sections/index";
import { SectionsArrayInput } from "@tinloof/sanity-studio";
export default defineType({
name: "page",
type: "document",
// ... other fields
fields: [
defineField({
name: 'sectionPicker',
title: 'Section Picker',
type: 'array',
of: sections.map((section) => ({
type: section.name,
})),
components: {
input: SectionsArrayInput,
},
}),
]
})
export const sections = [bannerSection];
4. Add sections to your Sanity schema
// @/sanity/schemas/index.tsx
import { sections } from "@sanity/schemas/index";
import page from "@/sanity/schemas/page";
const schemas = [page, ...sections];
export default schemas;
documentI18n
The documentI18n
plugin is an opinionated thin wrapper around Sanity's Document Internationalization that makes it possible to add internationalization without having to specify schema types.
documentI18n
enables internationalization on any schema with a locale
field.
Check the with-i18n
example for instructions on usage.
Examples
Check the /examples
folder.
License
MIT © Tinloof
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.