Live Story Sanity SDK

Installation

npm install livestory-sanity-sdk # yarn add livestory-sanity-sdk

Compatibility

| Version to install | Support | | ----------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------- | | Latest livestory-sanity-sdk | Storefront for modern browsers + Studio for Node 16+ |

How to use it

For full usage example, refer to the Live Sanity Demo Commerce

Hydrogen Storefront module

// 1. Import the LiveStory Storefront
import LiveStorySanity from "livestory-sanity-sdk";

// use it in your React components as the following
<LiveStorySanity.Storefront.LiveStory value={page.liveStory} language={language} store={store} />

// 2. Import single components from Storefront module
import { LiveStoryStoryModule } from "livestory-sanity-sdk/storefront";

import { LiveStory } from "livestory-sanity-sdk/storefront";

Sanity Studio module

Add Live Story document and objects to you Sanity Studio config

// Document type
import { LiveStoryDocument as livestory } from 'livestory-sanity-sdk/studio'

const documents = [..., livestory]

// Object type
import { LiveStoryObject as liveStoryBlock } from 'livestory-sanity-sdk/studio'

import { LiveStoryModuleStudio as moduleLiveStory } from 'livestory-sanity-sdk/studio'

const objects = [
  ...
  liveStoryBlock,
  moduleLiveStory
]