sanity

What is sanity?

Sanity is a platform for structured content that comes with an open-source editing environment called Sanity Studio. It allows you to build and manage content with a flexible and customizable interface.

What are sanity's main functionalities?

Content Modeling

Sanity allows you to define your content models using JavaScript objects. This example shows a simple schema for a blog post with a title and body.

const schema = {
  name: 'blogPost',
  type: 'document',
  fields: [
    { name: 'title', type: 'string' },
    { name: 'body', type: 'text' }
  ]
};
export default schema;

Real-time Collaboration

Sanity supports real-time collaboration, allowing multiple users to work on the same document simultaneously. This example demonstrates how to use the `useDocumentOperation` hook to update a document in real-time.

import { useDocumentOperation } from '@sanity/react-hooks';

function MyComponent({ id }) {
  const { patch, commit } = useDocumentOperation(id, 'myDocumentType');

  const handleChange = () => {
    patch.execute([{ set: { title: 'New Title' } }]);
    commit.execute();
  };

  return <button onClick={handleChange}>Change Title</button>;
}

Custom Input Components

Sanity allows you to create custom input components for your content models. This example shows how to create a simple custom input component using React.

import React from 'react';
import { FormField } from '@sanity/base/components';

const MyCustomInput = React.forwardRef((props, ref) => {
  return (
    <FormField label='My Custom Input'>
      <input ref={ref} type='text' {...props} />
    </FormField>
  );
});

export default MyCustomInput;

Other packages similar to sanity

contentful

Contentful is a headless CMS that provides a similar set of features for content modeling and management. It offers a web-based interface for content creators and a robust API for developers. Compared to Sanity, Contentful has a more polished UI but may be less flexible in terms of customization.

strapi

Strapi is an open-source headless CMS that allows you to create and manage content with a customizable API. It offers a more developer-friendly experience with its plugin system and is highly customizable. Strapi is similar to Sanity in terms of flexibility but has a different approach to content modeling and API generation.

prismic-javascript

Prismic is a headless CMS that focuses on providing a user-friendly interface for content creators and a powerful API for developers. It offers features like content versioning and scheduling. Compared to Sanity, Prismic is more focused on ease of use and may have fewer customization options.

README

Sanity is a real-time content infrastructure with a scalable, hosted backend featuring a Graph Oriented Query Language (GROQ), asset pipelines and fast edge caches.

THIS IS NOT THE PACKAGE YOU ARE LOOKING FOR

To get started with Sanity, please head over to our getting started guide

Looking for adamyanalunas/sanity?

Huge thanks to Adam Yanalunas for being so kind to transfer the sanity package to Sanity.io

If you're looking for the latest version of his sanity, you want to make sure to pin the version of sanity to v0.2.2