Create Sanity Field

Magic sanity field creator.

Usage

Import field for quick usage.

Import field from @studio206/create-sanity-field. This is the barebones field function. Doesn't give you typesafety but does speed things up.

1import { field } from "@studio206/create-sanity-field";
2
3field("title");
4// {
5//   name: 'title',
6//   title: 'Title',
7//   type: 'string'
8// }

If the type does not exist within src/typeDefaults.ts, you will have to pass it.

1import { field } from "@studio206/create-sanity-field";
2
3field("fubar"); // ❌
4// Error: Undefined type for field name: fubar. Please add type or add to dictionary
5
6field("fubar", "boolean"); // ✅
7// {
8//   name: 'fubar',
9//   title: 'Fubar',
10//   type: 'boolean'
11// }

Configure createSanityField and add your own type definitions 🪄 ⭐️

This is where a solid attempt at typesafety comes into play.

Import createSanityField from @studio206/create-sanity-field.

1// createSanityField.config.ts
2import { createSanityField } from "@studio206/create-sanity-field";
3
4export { field } = createSanityField({
5  typeDefinitions: {
6    authorName: "string",
7  },
8});

Import this field function from createSanityField.config.ts

1import { field } from "path-to/createSanityField.config";
2
3field("authorName");
4// {
5//   name: 'authorName',
6//   title: 'Author Name',
7//   type: 'string'
8// }

You will also get an intellisense member list: