@portabletext/types

TypeScript types for Portable Text

Installation

npm install --save @portabletext/types

Documentation

See https://portabletext.github.io/types/

Usage

1import type {
2  PortableTextBlock,
3  PortableTextSpan,
4  PortableTextLink
5} from '@portabletext/types'
6
7const headingSpan: PortableTextSpan = {
8  _type: 'span',
9  _key: '5p4n',
10  text: 'A simple Portable Text heading block',
11  marks: [],
12}
13
14const myBlocks: PortableTextBlock[] = [
15  {
16    _type: 'block',
17    _key: 'abc123',
18    style: 'h1',
19    children: [headingSpan],
20    markDefs: [],
21  },
22  {
23    _type: 'block',
24    _key: 'xyz987',
25    style: 'normal',
26    children: [
27      {_type: 'span', _key: 'c7', text: 'Check out the ', marks: []}
28      {_type: 'span', _key: 'x2', text: 'TypeScript definitions', marks: ['m4hl1nk']},
29      {_type: 'span', _key: 'u5', text: ' if you are using TS!', marks: []}
30    ],
31    markDefs: [
32      {
33        _key: 'm4hl1nk',
34        _type: 'link',
35        href: 'https://github.com/portabletext/types'
36      }
37    ],
38  },
39]
40
41/**
42 * Very specific Portable Text block, where:
43 * - Only link and author references (custom) are allowed as marks
44 * - Only Portable Text spans and `localCurrency` objects can be inline children
45 * - Blocks can only be of style `normal` or `call-to-action` (custom)
46 * - List items can only be of type `bullet`
47 */
48type MyCustomBlock = PortableTextListItemBlock<
49  PortableTextLink | AuthorReference, // `M`: Marks
50  PortableTextSpan | LocalCurrency,   // `C`: Children
51  'normal' | 'call-to-action',        // `S`: Styles
52  'bullet'                            // `L`: List item types
53>

License

MIT © Sanity.io