Skip to content
โญ Star on GitHubโ€‹โ€‹โ€‹โ€‹โ€Œ๏ปฟโ€๏ปฟโ€‹โ€โ€‹โ€โ€Œโ€๏ปฟ๏ปฟโ€Œ๏ปฟโ€‹โ€โ€Œโ€โ€โ€Œโ€Œโ€โ€Œ๏ปฟโ€Œโ€โ€โ€Œโ€Œโ€๏ปฟโ€โ€‹โ€โ€‹โ€โ€‹๏ปฟโ€โ€โ€‹โ€โ€‹โ€โ€Œ๏ปฟโ€‹๏ปฟโ€Œโ€โ€‹โ€Œโ€Œโ€๏ปฟโ€โ€Œโ€โ€โ€Œโ€Œ๏ปฟโ€Œโ€‹โ€Œ๏ปฟโ€โ€Œโ€‹โ€๏ปฟโ€โ€Œโ€โ€โ€Œโ€Œโ€๏ปฟ๏ปฟโ€‹โ€โ€‹โ€โ€‹โ€๏ปฟโ€‹โ€‹โ€โ€‹โ€โ€Œโ€โ€โ€‹โ€Œ๏ปฟโ€‹โ€โ€Œโ€โ€Œโ€Œโ€Œโ€โ€Œโ€โ€‹โ€โ€‹โ€โ€‹๏ปฟโ€โ€โ€‹โ€โ€‹โ€โ€Œโ€โ€โ€‹โ€Œ๏ปฟโ€Œโ€‹โ€Œ๏ปฟโ€Œโ€‹โ€Œ๏ปฟโ€‹โ€‹โ€‹๏ปฟโ€โ€โ€‹โ€๏ปฟ๏ปฟโ€‹โ€๏ปฟ๏ปฟโ€Œโ€๏ปฟโ€‹โ€Œโ€๏ปฟ๏ปฟโ€Œโ€โ€‹๏ปฟโ€Œโ€โ€‹โ€Œโ€Œโ€๏ปฟโ€‹โ€Œโ€โ€โ€‹โ€Œโ€๏ปฟ๏ปฟโ€Œ๏ปฟโ€‹๏ปฟโ€Œ๏ปฟโ€Œโ€‹โ€‹๏ปฟโ€โ€โ€‹๏ปฟโ€‹๏ปฟโ€‹๏ปฟโ€‹๏ปฟโ€‹๏ปฟโ€‹๏ปฟโ€‹๏ปฟโ€‹๏ปฟโ€‹โ€๏ปฟ๏ปฟโ€Œโ€โ€โ€Œโ€Œโ€๏ปฟโ€โ€Œ๏ปฟโ€Œโ€‹โ€Œโ€โ€Œโ€Œโ€Œโ€๏ปฟโ€โ€Œ๏ปฟโ€Œโ€‹โ€‹โ€๏ปฟ๏ปฟโ€Œโ€โ€Œโ€Œโ€Œโ€โ€Œโ€‹โ€Œโ€โ€โ€Œโ€Œ๏ปฟโ€Œโ€‹โ€‹โ€๏ปฟ๏ปฟโ€Œโ€๏ปฟโ€Œโ€Œโ€๏ปฟ๏ปฟโ€Œโ€โ€Œโ€‹โ€Œโ€โ€Œโ€Œโ€‹๏ปฟ๏ปฟโ€Œโ€Œ๏ปฟโ€‹โ€‹โ€Œ๏ปฟโ€‹โ€โ€Œโ€โ€Œโ€Œโ€Œ๏ปฟโ€‹๏ปฟโ€Œโ€โ€Œโ€Œโ€Œโ€๏ปฟโ€โ€Œ๏ปฟโ€Œโ€‹โ€Œโ€โ€‹โ€Œโ€Œ๏ปฟโ€Œโ€‹โ€Œโ€โ€โ€Œโ€Œโ€๏ปฟ๏ปฟโ€Œโ€๏ปฟโ€โ€‹๏ปฟโ€๏ปฟโ€Œโ€โ€โ€Œโ€Œโ€โ€Œโ€‹โ€‹๏ปฟ๏ปฟโ€Œโ€‹๏ปฟโ€‹โ€‹โ€‹๏ปฟโ€Œ๏ปฟโ€‹๏ปฟโ€Œ๏ปฟโ€Œโ€โ€‹๏ปฟโ€Œโ€โ€Œโ€โ€‹๏ปฟโ€‹โ€‹โ€‹๏ปฟโ€Œ๏ปฟโ€‹๏ปฟโ€‹๏ปฟโ€‹โ€๏ปฟโ€Œโ€Œโ€โ€‹โ€Œโ€‹๏ปฟโ€โ€‹โ€‹๏ปฟโ€‹๏ปฟโ€‹๏ปฟโ€‹โ€‹โ€‹โ€๏ปฟโ€Œโ€‹๏ปฟโ€Œโ€‹โ€‹๏ปฟโ€โ€Œโ€Œโ€โ€‹โ€โ€‹๏ปฟโ€Œ๏ปฟโ€‹โ€๏ปฟโ€Œโ€‹๏ปฟโ€โ€‹โ€Œโ€โ€Œโ€Œโ€Œโ€โ€‹โ€โ€Œโ€โ€Œโ€‹โ€‹โ€๏ปฟโ€Œโ€‹๏ปฟโ€‹โ€Œโ€‹๏ปฟโ€‹โ€‹โ€‹๏ปฟโ€โ€‹โ€‹๏ปฟโ€Œโ€Œโ€‹๏ปฟโ€‹โ€Œโ€Œโ€โ€‹๏ปฟโ€‹๏ปฟโ€‹๏ปฟโ€‹๏ปฟโ€Œ๏ปฟโ€‹๏ปฟโ€Œโ€‹โ€‹๏ปฟโ€Œโ€‹โ€Œโ€โ€‹โ€โ€‹๏ปฟโ€‹โ€‹โ€‹๏ปฟโ€๏ปฟโ€Œ๏ปฟโ€Œโ€‹โ€Œ๏ปฟโ€โ€Œโ€Œ๏ปฟโ€‹โ€‹โ€Œโ€โ€Œโ€Œโ€‹๏ปฟ๏ปฟโ€Œโ€Œ๏ปฟโ€‹โ€‹โ€Œโ€โ€‹โ€Œโ€Œโ€โ€Œ๏ปฟโ€Œโ€โ€Œโ€Œโ€‹๏ปฟโ€๏ปฟโ€Œ๏ปฟโ€‹โ€‹โ€Œโ€โ€‹โ€Œโ€Œ๏ปฟโ€Œโ€‹โ€Œโ€โ€โ€‹โ€‹๏ปฟ๏ปฟโ€Œโ€Œโ€๏ปฟโ€Œโ€Œโ€๏ปฟ๏ปฟโ€Œโ€โ€Œโ€‹โ€Œ๏ปฟโ€Œโ€Œโ€Œโ€๏ปฟโ€‹โ€Œโ€โ€Œโ€Œโ€Œ๏ปฟโ€‹๏ปฟโ€‹โ€โ€Œโ€Œโ€‹๏ปฟโ€Œโ€Œโ€Œโ€‹โ€‹โ€โ€Œโ€Œ๏ปฟ๏ปฟโ€Œโ€โ€๏ปฟโ€Œโ€โ€Œโ€Œโ€Œ๏ปฟโ€โ€Œโ€‹โ€โ€Œโ€Œโ€‹๏ปฟโ€‹๏ปฟโ€Œโ€‹โ€Œโ€‹โ€‹โ€โ€Œโ€Œโ€‹๏ปฟโ€‹๏ปฟโ€Œโ€‹โ€Œโ€‹โ€‹โ€โ€Œโ€Œโ€‹๏ปฟโ€‹โ€โ€‹๏ปฟโ€‹โ€โ€Œโ€โ€Œโ€โ€‹๏ปฟโ€‹๏ปฟโ€‹๏ปฟโ€Œโ€โ€‹๏ปฟโ€Œโ€‹โ€‹๏ปฟโ€Œ๏ปฟโ€‹๏ปฟโ€โ€‹โ€‹๏ปฟโ€Œโ€โ€Œโ€โ€‹โ€โ€Œโ€โ€‹โ€โ€‹๏ปฟโ€‹โ€‹โ€‹๏ปฟโ€‹โ€Œโ€‹๏ปฟโ€Œโ€Œโ€‹โ€โ€Œโ€Œโ€‹๏ปฟโ€‹โ€โ€‹๏ปฟโ€‹โ€โ€‹โ€โ€Œโ€Œโ€‹๏ปฟโ€Œโ€Œโ€Œโ€‹โ€Œโ€‹โ€‹โ€๏ปฟโ€โ€Œโ€โ€‹๏ปฟโ€Œ๏ปฟโ€Œโ€‹โ€Œโ€โ€‹โ€Œโ€Œ๏ปฟโ€‹๏ปฟโ€‹โ€โ€Œโ€Œโ€‹๏ปฟโ€Œโ€Œโ€Œโ€‹โ€‹โ€โ€Œโ€Œ๏ปฟ๏ปฟโ€Œโ€โ€๏ปฟโ€Œโ€โ€Œโ€Œโ€Œ๏ปฟโ€โ€Œโ€‹โ€โ€Œโ€Œโ€‹๏ปฟโ€‹๏ปฟโ€Œโ€‹โ€Œโ€‹โ€‹โ€โ€Œโ€Œโ€‹๏ปฟโ€‹๏ปฟโ€Œโ€‹โ€Œโ€‹โ€‹โ€โ€Œโ€Œโ€‹๏ปฟโ€‹โ€โ€‹๏ปฟโ€‹โ€โ€‹๏ปฟโ€Œโ€‹โ€Œโ€โ€Œโ€‹โ€Œโ€โ€‹๏ปฟโ€‹๏ปฟโ€‹๏ปฟโ€Œโ€โ€‹โ€โ€‹๏ปฟโ€Œ๏ปฟโ€‹๏ปฟโ€Œโ€‹โ€‹๏ปฟโ€Œโ€‹โ€‹๏ปฟโ€Œโ€โ€‹๏ปฟโ€‹โ€โ€‹๏ปฟโ€Œโ€Œโ€‹๏ปฟโ€‹๏ปฟโ€‹โ€โ€Œโ€Œโ€‹๏ปฟโ€‹โ€โ€‹๏ปฟโ€‹โ€โ€‹โ€โ€Œโ€Œโ€‹๏ปฟโ€Œโ€Œโ€Œโ€‹โ€Œโ€‹โ€‹โ€๏ปฟโ€โ€Œโ€๏ปฟโ€‹โ€Œโ€โ€โ€Œโ€Œโ€๏ปฟโ€โ€Œโ€โ€๏ปฟโ€‹โ€๏ปฟโ€โ€Œโ€๏ปฟโ€‹โ€Œโ€โ€‹โ€Œโ€Œโ€โ€‹โ€โ€Œโ€โ€Œโ€Œโ€Œโ€๏ปฟโ€‹โ€‹๏ปฟ๏ปฟ๏ปฟโ€Œโ€โ€‹โ€โ€Œโ€โ€‹โ€Œโ€Œ๏ปฟโ€‹๏ปฟโ€Œโ€โ€Œโ€Œโ€Œโ€Œโ€Œโ€Œโ€Œ๏ปฟโ€‹โ€โ€Œโ€๏ปฟโ€‹โ€‹๏ปฟ๏ปฟโ€Œโ€Œโ€โ€โ€‹โ€Œ๏ปฟโ€Œโ€‹โ€Œ๏ปฟโ€Œโ€‹โ€Œ๏ปฟโ€‹โ€‹โ€‹โ€โ€Œโ€Œโ€‹๏ปฟโ€‹๏ปฟโ€Œโ€‹โ€‹โ€Œโ€‹โ€โ€Œโ€Œโ€‹๏ปฟโ€‹โ€โ€Œโ€‹โ€Œโ€โ€‹โ€โ€Œโ€Œโ€‹๏ปฟโ€‹โ€โ€Œโ€‹โ€Œโ€โ€Œโ€๏ปฟโ€‹โ€Œโ€๏ปฟ๏ปฟโ€Œโ€โ€‹๏ปฟโ€Œโ€โ€‹โ€Œโ€Œโ€๏ปฟโ€‹โ€Œโ€โ€โ€‹โ€Œโ€๏ปฟ๏ปฟโ€Œ๏ปฟโ€‹๏ปฟโ€Œ๏ปฟโ€Œโ€‹โ€‹โ€โ€Œโ€Œโ€‹๏ปฟโ€‹๏ปฟโ€Œโ€‹โ€‹โ€Œโ€‹๏ปฟโ€‹๏ปฟโ€‹๏ปฟโ€‹๏ปฟโ€‹๏ปฟโ€‹๏ปฟโ€‹๏ปฟโ€‹๏ปฟโ€‹โ€โ€Œโ€โ€Œโ€โ€โ€Œโ€Œโ€โ€Œโ€‹โ€‹๏ปฟ๏ปฟโ€Œโ€‹๏ปฟโ€‹โ€‹โ€‹๏ปฟโ€Œ๏ปฟโ€‹๏ปฟโ€Œ๏ปฟโ€Œโ€โ€‹๏ปฟโ€Œโ€โ€Œโ€โ€‹๏ปฟโ€‹โ€‹โ€‹๏ปฟโ€Œ๏ปฟโ€‹๏ปฟโ€‹๏ปฟโ€‹โ€๏ปฟโ€Œโ€Œโ€โ€‹โ€Œโ€‹๏ปฟโ€โ€‹โ€‹๏ปฟโ€‹๏ปฟโ€‹๏ปฟโ€‹โ€‹โ€‹โ€๏ปฟโ€Œโ€‹๏ปฟโ€Œโ€‹โ€‹๏ปฟโ€โ€Œโ€Œโ€โ€‹โ€โ€‹๏ปฟโ€Œ๏ปฟโ€‹โ€๏ปฟโ€Œโ€‹๏ปฟโ€โ€‹โ€Œโ€โ€Œโ€Œโ€Œโ€โ€‹โ€โ€Œโ€โ€Œโ€‹โ€‹โ€๏ปฟโ€Œโ€‹๏ปฟโ€‹โ€Œโ€‹๏ปฟโ€‹โ€‹โ€‹๏ปฟโ€โ€‹โ€‹๏ปฟโ€Œโ€Œโ€‹๏ปฟโ€‹โ€Œโ€Œโ€โ€‹๏ปฟโ€‹๏ปฟโ€‹๏ปฟโ€‹๏ปฟโ€Œ๏ปฟโ€‹๏ปฟโ€Œโ€‹โ€‹๏ปฟโ€Œโ€‹โ€Œโ€โ€‹โ€โ€‹๏ปฟโ€‹โ€‹โ€‹โ€โ€Œโ€โ€Œ๏ปฟโ€Œโ€‹โ€Œ๏ปฟโ€โ€Œโ€Œ๏ปฟโ€‹โ€‹โ€Œโ€โ€Œโ€Œโ€‹๏ปฟ๏ปฟโ€Œโ€Œ๏ปฟโ€‹โ€‹โ€Œโ€โ€‹โ€Œโ€Œโ€โ€Œ๏ปฟโ€Œโ€โ€Œโ€Œโ€‹โ€โ€Œโ€โ€Œ๏ปฟโ€‹โ€‹โ€Œโ€โ€‹โ€Œโ€Œ๏ปฟโ€Œโ€‹โ€Œโ€โ€โ€‹โ€‹๏ปฟ๏ปฟโ€Œโ€Œโ€๏ปฟโ€Œโ€Œโ€๏ปฟ๏ปฟโ€Œโ€โ€Œโ€‹โ€Œ๏ปฟโ€Œโ€Œโ€Œโ€๏ปฟโ€‹โ€Œโ€โ€Œโ€Œโ€Œ๏ปฟโ€‹๏ปฟโ€‹โ€โ€Œโ€Œโ€‹๏ปฟโ€Œโ€Œโ€Œโ€‹โ€‹โ€โ€Œโ€Œ๏ปฟ๏ปฟโ€Œโ€โ€๏ปฟโ€Œโ€โ€Œโ€Œโ€Œ๏ปฟโ€โ€Œโ€‹โ€โ€Œโ€Œโ€‹๏ปฟโ€‹๏ปฟโ€Œโ€‹โ€Œโ€‹โ€‹โ€โ€Œโ€Œโ€‹๏ปฟโ€‹๏ปฟโ€Œโ€‹โ€Œโ€‹โ€‹โ€โ€Œโ€Œโ€‹๏ปฟโ€‹โ€โ€‹๏ปฟโ€‹โ€โ€Œโ€โ€Œโ€โ€‹๏ปฟโ€‹๏ปฟโ€‹๏ปฟโ€Œโ€โ€‹๏ปฟโ€Œโ€‹โ€‹๏ปฟโ€Œ๏ปฟโ€‹๏ปฟโ€โ€‹โ€‹๏ปฟโ€Œโ€โ€Œโ€โ€‹โ€โ€Œโ€โ€‹โ€โ€‹๏ปฟโ€‹โ€‹โ€‹๏ปฟโ€‹โ€Œโ€‹๏ปฟโ€Œโ€Œโ€‹โ€โ€Œโ€Œโ€‹๏ปฟโ€‹โ€โ€‹๏ปฟโ€‹โ€โ€‹โ€โ€Œโ€Œโ€‹๏ปฟโ€Œโ€Œโ€Œโ€‹โ€Œโ€‹โ€‹โ€๏ปฟโ€โ€Œโ€โ€‹๏ปฟโ€Œ๏ปฟโ€Œโ€‹โ€Œโ€โ€‹โ€Œโ€Œ๏ปฟโ€‹๏ปฟโ€‹โ€โ€Œโ€Œโ€‹๏ปฟโ€Œโ€Œโ€Œโ€‹โ€‹โ€โ€Œโ€Œ๏ปฟ๏ปฟโ€Œโ€โ€๏ปฟโ€Œโ€โ€Œโ€Œโ€Œ๏ปฟโ€โ€Œโ€‹โ€โ€Œโ€Œโ€‹๏ปฟโ€‹๏ปฟโ€Œโ€‹โ€Œโ€‹โ€‹โ€โ€Œโ€Œโ€‹๏ปฟโ€‹๏ปฟโ€Œโ€‹โ€Œโ€‹โ€‹โ€โ€Œโ€Œโ€‹๏ปฟโ€‹โ€โ€‹๏ปฟโ€‹โ€โ€‹๏ปฟโ€Œโ€‹โ€Œโ€โ€Œโ€‹โ€Œโ€โ€‹๏ปฟโ€‹๏ปฟโ€‹๏ปฟโ€Œโ€โ€‹โ€โ€‹๏ปฟโ€Œ๏ปฟโ€‹๏ปฟโ€Œโ€‹โ€‹๏ปฟโ€Œโ€‹โ€‹๏ปฟโ€Œโ€โ€‹๏ปฟโ€‹โ€โ€‹๏ปฟโ€Œโ€Œโ€‹๏ปฟโ€‹๏ปฟโ€‹โ€โ€Œโ€Œโ€‹๏ปฟโ€‹โ€โ€‹๏ปฟโ€‹โ€โ€‹โ€โ€Œโ€Œโ€‹๏ปฟโ€Œโ€Œโ€Œโ€‹โ€Œโ€‹โ€‹โ€๏ปฟโ€โ€Œโ€๏ปฟโ€‹โ€Œโ€โ€โ€Œโ€Œโ€๏ปฟโ€โ€Œโ€โ€๏ปฟโ€‹โ€๏ปฟโ€โ€Œโ€๏ปฟโ€‹โ€Œโ€โ€‹โ€Œโ€Œโ€โ€‹โ€โ€Œโ€โ€Œโ€Œโ€Œโ€๏ปฟโ€‹โ€‹โ€โ€‹โ€โ€Œ๏ปฟ๏ปฟโ€Œ

Sanity Helper Functions

  • #Tips & Tricks
Read time: 3 minutes
Bill Murray holding a sign that says "Don't Repeat Yourself", a ground hog sticking his head out of the ground, film still from the movie Ground Hog day

An important rule in programming is: DRY

Don't Repeat Yourself

This starter template comes included with a number of helper functions to use in your Sanity Studio so you don't have to repeat yourself.

Structure Helpers๐Ÿ”—

Customizing and organizing your Sanity Studio structure (where your content lives) is super easy. Here's a handy cheat sheet, too.

Singleton๐Ÿ”—

๐Ÿ“ sanity/src/structure.ts
import { singleton } from './utils'

S.list()
  .title('Content')
  .items([
    // ...
    singleton(S, 'yourDocumentId').icon(...)
  ])

Group๐Ÿ”—

๐Ÿ“ sanity/src/structure.ts
import { group } from './utils'

S.list()
  .title('Content')
  .items([
    // ...
    group(S, 'Group name', [
      S.documentTypeListItem('logo').title('Logos'),
      S.documentTypeListItem('testimonial').title('Testimonials'),
    ]).icon(...),
  ])

Preview Helpers๐Ÿ”—

Customizing previews are also super easy. Here's official documentation on that.

Converting PortableText to a string๐Ÿ”—

import { getBlockText } from '@sanity/src/utils'

preview: {
  select: {
    content: 'content' // this is a block type (a.k.a. PortableText)
  },
  prepare: ({ content }) => ({
    title: getBlockText(content)
  })
}
Preview of portable text when used with the helper function
Line breaks will be rendered as arrows ("โ†ฉ๏ธŽ")

Item count๐Ÿ”—

import { count } from '@sanity/src/utils'

preview: {
  select: {
    items: 'items' // this is an array type
  },
  prepare: ({ items }) => ({
    title: count(items)  // 1 item, 2 items
    title: count(items, 'pikachu')  // 1 pikachu, 2 pikachus
    title: count(items, 'octopus', 'octopi')  // 1 octopus, 2 octopi
  })
}

Source Code๐Ÿ”—

The source code for all helper functions can be found here.

Doc and Marty McFly in shocked expressions, with the title text "Repeat Yourself" in the style of the Back to the Future movie logo