Skip to content
Sanity
Get started
Overview
Sanity Studio
Flexible editing environment
Content Lake
Real-time database
Developer experience
Tooling you love
Features
Structured content
The philosophy behind Sanity
Review changes
View edits & rollback instantly
Image pipeline
On-demand transformations
Sanity Enterprise
Transformative global brand experiencesExplore the enterprise solution
Solutions
E-commerce
Better shopping experiences
Marketing sites
Control your story
Products & services
Innovate and automate
Mobile apps
Content backend for every OS
View all
Case studies
Cornerstone
Jamstack transformation
Cloudflare
Flexible modeling for a global CDN
Eurostar
Tailored content for EU travellers
Prima
Shopify meets headlesss content
View all
Frameworks and integrations
React
Gatsby
Next
Nuxt
Eleventy
Netlify
Vercel
Algolia
All frameworksTechnology partners
Learn
DocumentationReferenceGuides
Get started
Build and share
Tools & pluginsProject showcaseSchemas & snippetsTechnology partnersGet supportShare your work
Exchange
Latest news
Content is Data: recapping a memorable day for Sanity
Read the blog
PricingContact salesLog inGet started
Documentation
  • Introduction

    • What you need to know

  • Getting started

    • Starter projects

    • Start with CLI

  • Sanity Studio

    • Configuration

      • Project Structure
      • sanity.json
      • Environment variables
    • Content modelling

      • Best practices
      • Naming things
      • Content types
    • Customization

      • NEWEarly Access: Sanity UI
      • Styling
      • Preview / List View
      • Icons for data types
      • Sort orders
      • The parts system
      • Plugins
      • Custom Input Components
      • Custom asset sources
    • Block content

      • The rich text editor
      • Configuration
      • Customization
      • Previewing
      • Presenting Portable Text
    • Validation

    • Document history

      • NEWCustom Diff Components
    • Dashboard

      • Introduction
      • Installing widgets
      • Create widgets
    • Structure Builder

      • Introduction to Structure Builder
      • Set up Structure Builder to override the default list view
      • Create a link to a single edit page in your main document type list
      • Manually group items in a pane
      • Dynamically group list items with a GROQ filter
      • Create custom document views with Structure Builder
    • Initial Value Templates

    • Custom workflows

      • Document actions
      • Document badges
    • NEWPresence API

    • Studio hosting

    • Preview in frontend

    • Localization

    • Drafts

    • Experimental Features

    • Spaces

    • Action UI affordances

    • Studio search config

  • Content Lake

    • NEWAPI Versioning

    • Query language (GROQ)

      • How Queries Work
      • Query Cheat Sheet
      • GROQ Playground
    • GraphQL

    • Images & assets

      • Assets
      • Asset CDN
      • Presenting Images
    • API CDN

    • Real-time

      • Webhooks
      • Real-time Updates
    • Datasets

      • NEWHot Swap
      • NEWCloud Clone
    • Updating content

      • Transactions
      • Migrating Data
    • IDs and paths

    • Importing data

    • Security

      • Browser security & CORS
      • Access Your Data (CORS)
      • Access Control
      • Third-Party Login (SSO)
      • Keeping your data safe
    • Technical limits

  • Build with Sanity

    • Convince your team

    • Convince your clients

    • Pro Bono Plans

    • Open-source projects

    • Non-profit organizations

  • Reference docs

    • HTTP API

      • URL format
      • Authentication
      • Patches
      • Using JSONMatch
      • Endpoints
      • Assets
      • Doc
      • Export
      • History
      • Listen
      • Mutate
      • Projects
      • NEWJobs
      • Query
    • Query language (GROQ)

      • Syntax
      • Data Types
      • Operators
      • Functions
      • Pipeline Components
      • Joins
    • Schema types

      • Array
      • Block
      • Boolean
      • Date
      • Datetime
      • Document
      • File
      • Geopoint
      • Image
      • Number
      • Object
      • Reference
      • Slug
      • String
      • Span
      • Text
      • URL
    • Command line interface

      • Build
      • CORS
      • Dataset
      • Debug
      • Deploy
      • Docs
      • Documents
      • Exec
      • GraphQL
      • Help
      • Hook
      • Init
      • Install
      • Login
      • Logout
      • Manage
      • Projects
      • Start
      • Versions
      • Undeploy
      • Upgrade
    • Client libraries

      • JavaScript
      • PHP
      • .NET
    • Structure builder

    • Initial Value Templates API

    • Image transformations

      • NEWIIIF API reference
    • Studio React hooks

    • Document Actions API

    • Document Badges API

    • Project Management

    • Projects, organizations, and billing

    • Plans and Payments

Page contents

  • Installing
  • Usage
  • PropTypes
  • Examples
  • Rendering custom marks
  • Specifying image options
  • Customizing the default serializer for
  • Usage with React Native
  • License

Platform

Structured ContentDeveloper experienceContent LakeSanity StudioSecurity & Compliance

Resources

Documentation
React BlogGatsby BlogNext.js Landing PagesProgressive Web ApplicationSingle Page ApplicationSvelte & Typescript AppVue & Tailwind BlogDeveloper Portfolio Templates
React StartersNext.js StartersNext.js Landing PagesNext.js E-commerceGatsby StartersGatsby PluginsDeveloper Portfolio Templates
Case Studies
Headless CMSDigital Experience PlatformStatic Site GeneratorLocalizationGraphQL vs REST
React CMSGatsby CMSNode CMSE-commerce CMSVue CMSAngular CMSGraphQL CMS

Company

Contact SalesEnterpriseCareersTerms of Service

Stay connected

  • Github
  • Slack
  • Twitter
  • YouTube
  • Stack Overflow
  • Blog RSS

Subscribe to our newsletter

©Sanity 2021