3.23.4 • Published 4 months ago

@sanity/block-tools v3.23.4

Weekly downloads
25,385
License
MIT
Repository
github
Last release
4 months ago

Sanity Block Tools

Various tools for processing Sanity block content

Interface

Let's start with a complete example:

import Schema from '@sanity/schema'
import blockTools from '@sanity/block-tools'


// Start with compiling a schema we can work against
const schema = Schema.compile({
  name: 'myBlog',
  types: [
    {
      type: 'object',
      name: 'blogPost',
      fields: [
        {
          title: 'Title',
          type: 'string',
          name: 'title'
        },
        {
          title: 'Body',
          name: 'body',
          type: 'array',
          of: [{type: 'block'}]
        }
      ]
    }
  ]
})

// The compiled schema type for the content type that holds the block array
const blockContentType = defaultSchema.get('blogPost')
  .fields.find(field => field.name === 'body').type


// Convert HTML to blocks
const blocks = blockTools.htmlToBlocks(
  '<html><body><h1>Hello world!</h1><body></html>',
  {blockContentType}
)

// Convert a Slate state to blocks
const blocks = blockTools.slateStateToBlocks(slateJson, blockContentType)

// Convert blocks to a JSON serialized Slate state
const slateState = blockTools.blocksToSlateState(blocks, blockContentType)

// Get the feature-set of a blockContentType
const features = blockTools.getBlockContentFeatures(blockContentType)

Methods

htmlToBlocks(html, options) (html deserializer)

This will deserialize the input html (string) into blocks.

Options

blockContentType

A compiled version of the block content schema type. When you give this option, the deserializer will respect the schema when deserializing to blocks. I.e. if the schema doesn't allow h2-styles, all h2 html-elements will deserialized to normal styled blocks.

parseHtml

The HTML-deserialization is done by default by the browser's native DOMParser. On the server side you can give the function parseHtml that parses the html into a DOMParser compatible model / API.

JSDOM example
const jsdom = require('jsdom')
const {JSDOM} = jsdom

const blocks = blockTools.htmlToBlocks(
  '<html><body><h1>Hello world!</h1><body></html>',
  {
    blockContentType,
    parseHtml: html => new JSDOM(html).window.document
  }
)
rules

You may add your own rules to deal with special HTML cases.

blockTools.htmlToBlocks(
  '<html><body><pre><code>const foo = "bar"</code></pre></body></html>',
  {
    blockContentType: compiledBlockContentType,
    parseHtml: html => new JSDOM(html),
    rules: [

      // Special rule for code blocks (wrapped in pre and code tag)
      {
        deserialize(el, next) {
          if (el.tagName.toLowerCase() != 'pre') {
            return undefined
          }
          const code = el.children[0]
          const childNodes = code && code.tagName.toLowerCase() === 'code'
            ? code.childNodes
            : el.childNodes
          let text = ''
          childNodes.forEach(node => {
            text += node.textContent
          })
          return {
            _type: 'span',
            marks: ['code'],
            text: text
          }
        }
      }

    ]
  }
)

blocksToSlateState(blocks, blockContentTypeSchema)

Convert blocks to a serialized Slate state respecting the input schema.

slateStateToBlocks(slateState, blockContentTypeSchema)

Convert a slate state to blocks respecting the input schema.

getBlockContentFeatures(blockContentType)

Will return an object with the features enabled for the input block content type.

{
  enabledBlockAnnotations: ['link'],
  enabledSpanDecorators: [
    'strong',
    'em',
    'code',
    'underline',
    'strike-through'
  ],
  enabledBlockStyles: [
    'normal',
    'h1',
    'h2',
    'h3',
    'h4',
    'h5',
    'h6',
    'blockquote'
  ]
}
3.23.5-edx-980.36

4 months ago

3.23.5-comments.29

4 months ago

3.23.5-comments.28

4 months ago

3.23.5-edx-980.29

4 months ago

3.23.5-facelift.24

4 months ago

3.23.4-canary.1

4 months ago

3.23.4-canary.0

4 months ago

3.23.3

4 months ago

3.23.4

4 months ago

3.22.3

4 months ago

3.23.2-canary.8

4 months ago

3.23.2

4 months ago

3.23.2-EDX937.1

4 months ago

3.22.0

4 months ago

3.22.2

4 months ago

3.22.1

4 months ago

3.23.1-canary.1

4 months ago

3.23.1

4 months ago

3.23.0

4 months ago

3.21.4-canary.6

4 months ago

3.21.3

4 months ago

3.21.2

4 months ago

3.21.2-facelift.77

5 months ago

3.21.2-facelift.79

4 months ago

3.21.2-i18n.15

5 months ago

3.21.2-canary.17

4 months ago

3.21.2-facelift.69

5 months ago

3.21.1-pt-input.18

5 months ago

3.21.1-pt-input.19

5 months ago

3.21.1-facelift.52

5 months ago

3.21.1-facelift.56

5 months ago

3.21.1

5 months ago

3.21.1-facelift.43

5 months ago

3.21.1-facelift.42

5 months ago

3.21.0

5 months ago

3.20.3-i18n.262

5 months ago

3.14.5-i18n.46

9 months ago

3.14.5-i18n.47

9 months ago

3.14.5-i18n.45

9 months ago

3.16.8-sdx-736.1

7 months ago

3.18.2-comments.71

6 months ago

3.18.2-comments.73

6 months ago

3.18.2-comments.75

6 months ago

3.18.2-comments.74

6 months ago

3.18.2-comments.69

6 months ago

3.18.2-i18n.179

6 months ago

3.16.8-comments.3

7 months ago

3.18.1

6 months ago

3.18.0

7 months ago

3.16.7

7 months ago

3.16.6

7 months ago

3.16.1

8 months ago

3.16.0

8 months ago

3.16.3

8 months ago

3.16.2

8 months ago

3.16.5

7 months ago

3.16.4

8 months ago

3.20.3-i18n.242

5 months ago

3.20.3-i18n.243

5 months ago

3.20.3-i18n.247

5 months ago

3.14.2-i18n.10

10 months ago

3.15.1-canary.6

9 months ago

3.20.0

5 months ago

3.20.2

5 months ago

3.20.1

5 months ago

3.14.6-pte.52

9 months ago

3.19.4-pt-input.8

5 months ago

3.20.1-i18n.244

5 months ago

3.19.3

5 months ago

3.19.0

6 months ago

3.19.2

6 months ago

3.19.1

6 months ago

3.18.2-next.66

6 months ago

3.17.0

7 months ago

3.20.1-pt-input.30

5 months ago

3.20.1-pt-input.32

5 months ago

3.20.1-pt-input.31

5 months ago

3.20.1-pt-input.26

5 months ago

3.20.1-pt-input.29

5 months ago

3.20.1-pt-input.28

5 months ago

3.15.0

9 months ago

3.15.1

9 months ago

3.20.2-pt-input.20

5 months ago

3.20.2-pt-input.23

5 months ago

3.19.3-sdx-722.2

6 months ago

3.16.2-canary.19

8 months ago

3.14.1

10 months ago

3.14.0

10 months ago

3.14.3

9 months ago

3.14.2

10 months ago

3.14.5

9 months ago

3.14.4

9 months ago

3.15.2-canary.44

8 months ago

3.17.1-comments.59

6 months ago

3.20.2-i18n.241

5 months ago

3.20.2-i18n.239

5 months ago

3.18.2-sdx-722.70

6 months ago

3.17.1-comments.36

7 months ago

3.16.5-comments.27

7 months ago

3.15.2-canary.1

8 months ago

2.36.2

9 months ago

3.19.4-canary.2

5 months ago

3.19.4-canary.6

5 months ago

3.13.0

10 months ago

3.10.1-canary.1

12 months ago

3.9.2-canary.18

12 months ago

3.9.2-canary.26

12 months ago

3.11.3

11 months ago

3.11.5

11 months ago

3.11.0

12 months ago

3.11.2

11 months ago

3.11.1

11 months ago

3.9.2-next.27

12 months ago

3.10.2-alpha.13

12 months ago

3.12.1

11 months ago

3.12.0

11 months ago

3.10.1

12 months ago

3.10.0

12 months ago

3.10.3

12 months ago

3.10.2

12 months ago

3.12.2

10 months ago

3.8.1-canary.5

1 year ago

3.8.1-canary.6

1 year ago

3.5.1

1 year ago

3.9.2-canary.12

12 months ago

3.9.2-canary.16

12 months ago

3.8.0

1 year ago

3.8.2-canary.4

1 year ago

3.8.2-canary.2

1 year ago

3.8.3

1 year ago

3.8.2

1 year ago

3.8.1

1 year ago

3.8.4-next.27

1 year ago

3.5.2-next.19

1 year ago

3.6.0

1 year ago

3.7.2-canary.49

1 year ago

3.9.1

12 months ago

3.9.0

1 year ago

3.7.1

1 year ago

3.7.0

1 year ago

3.9.1-canary.38

12 months ago

3.9.1-canary.39

12 months ago

3.9.1-canary.24

1 year ago

3.5.0

1 year ago

3.3.1

1 year ago

3.3.0

1 year ago

3.2.6

1 year ago

3.4.0

1 year ago

3.5.1-next.11

1 year ago

3.2.2

1 year ago

3.2.1

1 year ago

3.2.0

1 year ago

3.2.5

1 year ago

3.2.4

1 year ago

3.2.3

1 year ago

3.1.3

1 year ago

3.1.2

1 year ago

3.1.1

1 year ago

3.1.0

1 year ago

3.1.4

1 year ago

3.0.0-v3-pte.88

1 year ago

3.0.4

1 year ago

3.0.3

1 year ago

3.0.2

1 year ago

3.0.1

1 year ago

3.0.6

1 year ago

3.0.5

1 year ago

3.0.7-canary.14

1 year ago

3.1.5-next.38

1 year ago

3.1.5-next.39

1 year ago

3.1.5-next.43

1 year ago

3.1.5-next.44

1 year ago

3.1.5-next.42

1 year ago

3.1.5-next.45

1 year ago

3.1.5-next.46

1 year ago

3.1.5-next.40

1 year ago

3.0.7-canary.7

1 year ago

3.1.5-canary.15

1 year ago

3.1.5-canary.14

1 year ago

3.2.4-next.5

1 year ago

3.0.1-canary.23

1 year ago

3.1.5-canary.40

1 year ago

3.2.2-next.0

1 year ago

3.0.0-canary.186

2 years ago

3.0.0-v3-pte.87

2 years ago

3.0.0

1 year ago

3.0.0-v3-pte.30

2 years ago

3.0.0-v3-pte.31

2 years ago

3.0.0-v3-pte.33

2 years ago

2.34.3-cdr-ga.20

2 years ago

2.34.1-canary.0

2 years ago

3.0.0-rc.2

1 year ago

3.0.0-rc.1

1 year ago

3.0.0-rc.0

1 year ago

3.0.0-rc.3

1 year ago

2.35.0

2 years ago

3.0.0-v3-pte.58

2 years ago

3.0.0-v3-pte.55

2 years ago

3.0.0-v3-pte.69

2 years ago

3.0.0-v3-pte.80

2 years ago

3.0.0-v3-pte.79

2 years ago

2.33.2

2 years ago

2.33.4-shopify.8

2 years ago

2.33.3-edge.8

2 years ago

2.31.0

2 years ago

3.0.0-v3-pte.48

2 years ago

3.0.0-v3-pte.49

2 years ago

3.0.0-v3-esm.54

2 years ago

3.0.0-v3-esm.52

2 years ago

3.0.0-v3-esm.53

2 years ago

2.32.1-next.22

2 years ago

2.32.1-next.21

2 years ago

3.0.0-v3-pte.56

2 years ago

2.29.5-edge.1030

2 years ago

3.0.0-v3-pte.57

2 years ago

3.0.0-v3-pte.59

2 years ago

2.29.5-edge.1044

2 years ago

3.0.0-v3-pte.61

2 years ago

3.0.0-v3-pte.12

2 years ago

3.0.0-v3-pte.13

2 years ago

3.0.0-v3-pte.16

2 years ago

3.0.0-v3-pte.17

2 years ago

2.30.5

2 years ago

2.29.5-edge.1050

2 years ago

2.30.3-shopify.5

2 years ago

2.30.3-shopify.3

2 years ago

2.30.3-shopify.4

2 years ago

2.30.2-shopify.2

2 years ago

2.30.2-shopify.0

2 years ago

2.29.3

2 years ago

2.28.0

2 years ago

2.25.5-next.6

2 years ago

2.24.1-pte.127

2 years ago

2.24.1-pte.113

2 years ago

2.24.1-pte.115

2 years ago

2.23.4-pte.99

2 years ago

2.23.4-pte.96

2 years ago

2.23.4-pte.95

2 years ago

2.23.5-next.19

2 years ago

2.27.0

2 years ago

2.23.4-pte.107

2 years ago

2.23.4-pte.101

2 years ago

2.23.4-pte.102

2 years ago

2.24.0

2 years ago

2.24.3-pte.128

2 years ago

2.22.0

2 years ago

2.22.3

2 years ago

2.23.3-canary.84

2 years ago

2.23.3-next.34

2 years ago

2.23.3-next.35

2 years ago

2.23.3-next.4

2 years ago

2.22.6-next.121

2 years ago

2.23.2-canary.28

2 years ago

2.22.3-next.5

2 years ago

2.22.6-next.104

2 years ago

2.22.6-next.102

2 years ago

2.23.3-canary.59

2 years ago

2.23.2-next.3

2 years ago

2.23.1-next.10

2 years ago

2.23.0

2 years ago

2.21.8-canary.4

2 years ago

2.21.5

3 years ago

2.21.0

3 years ago

2.21.1-canary.2

3 years ago

2.20.0

3 years ago

2.19.1-canary.1

3 years ago

2.18.1-canary.9

3 years ago

2.18.0

3 years ago

2.17.3-canary.0

3 years ago

2.17.2

3 years ago

2.16.0

3 years ago

2.15.1-canary.4

3 years ago

2.15.0

3 years ago

2.14.1-canary.4

3 years ago

2.14.1-canary.36

3 years ago

2.14.0

3 years ago

2.13.2-canary.13

3 years ago

2.13.2-canary.9

3 years ago

2.13.2-canary.7

3 years ago

2.12.3-rc.0

3 years ago

2.13.0

3 years ago

2.12.0

3 years ago

2.11.3-canary.6

3 years ago

2.11.0

3 years ago

2.10.2-next.0

3 years ago

2.10.0

3 years ago

2.9.1-canary.15

3 years ago

2.9.0

3 years ago

2.8.2-canary.40

3 years ago

2.9.1

3 years ago

2.7.5-next.41

3 years ago

2.7.4

3 years ago

2.5.1-canary.79

3 years ago

2.5.0

3 years ago

2.4.4-canary.81

3 years ago

2.4.4-canary.75

3 years ago

2.3.9-canary.32

3 years ago

2.3.7-canary.22

3 years ago

2.3.5-canary.23

3 years ago

2.3.5-canary.22

3 years ago

2.3.5-canary.17

3 years ago

2.3.5-canary.18

3 years ago

2.2.6

3 years ago

2.2.0

3 years ago

2.1.7-next.22

3 years ago

2.1.7-next.21

3 years ago

2.1.5-canary.2

3 years ago

2.1.5-canary.3

3 years ago

2.1.4

3 years ago

2.1.2-ui.11

3 years ago

2.1.1-ui.14

3 years ago

2.1.1-ui.13

3 years ago

2.1.1-ui.18

3 years ago

2.1.0

3 years ago

2.0.10-next.46

3 years ago

2.0.10-next.47

3 years ago

2.0.10-canary.11

3 years ago

2.0.10-canary.0

3 years ago

2.0.9

3 years ago

2.0.1

4 years ago

2.0.0

4 years ago

1.150.6

4 years ago

1.150.5-canary.6

4 years ago

1.150.3

4 years ago

1.150.2-canary.0

4 years ago

1.150.2-canary.1

4 years ago

1.150.0

4 years ago

1.150.1

4 years ago

1.149.19

4 years ago

1.149.16

4 years ago

1.149.4

4 years ago

1.149.0

4 years ago

1.148.3

4 years ago

1.148.1

4 years ago

1.148.0

4 years ago

0.147.10-next.23

4 years ago

0.147.10-next.22

4 years ago

0.147.6

4 years ago

0.147.0

4 years ago

0.147.0-alpha.1

4 years ago

0.147.0-alpha.2

4 years ago

0.147.0-alpha.0

4 years ago

0.146.0

4 years ago

0.146.0-alpha.2

4 years ago

0.146.0-alpha.1

4 years ago

0.145.0

4 years ago

0.145.0-alpha.32

4 years ago

0.144.0

5 years ago

0.142.9

5 years ago

0.142.8

5 years ago

0.142.6

5 years ago

0.142.0

5 years ago

0.141.7-next.20

5 years ago

0.141.7-next.19

5 years ago

0.141.7-next.18

5 years ago

0.141.5

5 years ago

0.141.4

5 years ago

0.141.3

5 years ago

0.141.1

5 years ago

0.141.0

5 years ago

0.140.30

5 years ago

0.140.17

5 years ago

0.140.12

5 years ago

0.140.9

5 years ago

0.141.0-alpha.12

5 years ago

0.140.3

5 years ago

0.140.0

5 years ago

0.139.6

5 years ago

0.139.4

5 years ago

0.139.3-parrot.0

5 years ago

0.139.3-canary.0

5 years ago

0.139.2

5 years ago

0.139.1

5 years ago

0.140.0-alpha.4

5 years ago

0.140.0-alpha.3

5 years ago

0.140.0-alpha.1

5 years ago

0.139.0

5 years ago

0.139.0-rc.0

5 years ago

0.138.0

5 years ago

0.138.0-alpha.21

5 years ago

0.138.0-alpha.20

5 years ago

0.138.0-alpha.14

5 years ago

0.137.0

5 years ago

0.136.2

5 years ago

0.136.1-canary.5

5 years ago

0.136.0

5 years ago

0.135.3

5 years ago

0.135.3-next.6

6 years ago

0.135.0

6 years ago

0.135.0-next.2

6 years ago

0.135.0-next.1

6 years ago

0.135.0-next.0

6 years ago

0.134.1

6 years ago

0.135.0-beta.0

6 years ago

0.134.0

6 years ago

0.133.2

6 years ago

0.133.1

6 years ago

0.133.0

6 years ago

0.132.12

6 years ago

0.132.10

6 years ago

0.132.8

6 years ago

0.132.6

6 years ago

0.132.5

6 years ago

0.132.4-next.0

6 years ago

0.132.2

6 years ago

0.132.0

6 years ago

0.131.0

6 years ago

0.130.0

6 years ago

0.129.1

6 years ago

0.129.0

6 years ago

0.128.5

6 years ago

0.128.3

6 years ago

0.128.2

6 years ago

0.128.0

6 years ago

0.127.1

6 years ago

0.126.2

6 years ago

0.126.1

6 years ago

0.126.0

6 years ago

0.125.8

6 years ago

0.125.7

6 years ago

0.125.6

6 years ago

0.125.0

6 years ago

0.125.0-rc.4

6 years ago

0.124.12

6 years ago

0.125.0-rc.3

6 years ago

0.125.0-rc.2

6 years ago

0.125.0-rc.1

6 years ago

0.125.0-rc.0

6 years ago

0.124.10

6 years ago

0.124.0

6 years ago

0.123.1

6 years ago

0.123.0

6 years ago

0.122.5

6 years ago

0.122.4

6 years ago

0.122.3

6 years ago

0.120.0

6 years ago

0.119.0

6 years ago