portabletext / types

Shared TypeScript definitions for core Portable Text concepts

@portabletext/types

TypeScript types for Portable Text

Installation

npm install --save @portabletext/types

Documentation

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

Usage

import type {
  PortableTextBlock,
  PortableTextSpan,
  PortableTextLink
} from '@portabletext/types'

const headingSpan: PortableTextSpan = {
  _type: 'span',
  _key: '5p4n',
  text: 'A simple Portable Text heading block',
  marks: [],
}

const myBlocks: PortableTextBlock[] = [
  {
    _type: 'block',
    _key: 'abc123',
    style: 'h1',
    children: [headingSpan],
    markDefs: [],
  },
  {
    _type: 'block',
    _key: 'xyz987',
    style: 'normal',
    children: [
      {_type: 'span', _key: 'c7', text: 'Check out the ', marks: []}
      {_type: 'span', _key: 'x2', text: 'TypeScript definitions', marks: ['m4hl1nk']},
      {_type: 'span', _key: 'u5', text: ' if you are using TS!', marks: []}
    ],
    markDefs: [
      {
        _key: 'm4hl1nk',
        _type: 'link',
        href: 'https://github.com/portabletext/types'
      }
    ],
  },
]

/**
 * Very specific Portable Text block, where:
 * - Only link and author references (custom) are allowed as marks
 * - Only Portable Text spans and `localCurrency` objects can be inline children
 * - Blocks can only be of style `normal` or `call-to-action` (custom)
 * - List items can only be of type `bullet`
 */
type MyCustomBlock = PortableTextListItemBlock<
  PortableTextLink | AuthorReference, // `M`: Marks
  PortableTextSpan | LocalCurrency,   // `C`: Children
  'normal' | 'call-to-action',        // `S`: Styles
  'bullet'                            // `L`: List item types
>

License

MIT © Sanity.io

types's Issues

Dependency Dashboard

This issue lists Renovate updates and detected dependencies. Read the Dependency Dashboard docs to learn more.

---

Using a curated preset maintained by

Sanity: The Composable Content Cloud

---

Pending Approval

These branches will be created by Renovate only once you click their checkbox below.

• chore(deps): update dependency npm-run-all2 to v6
• chore(deps): update peaceiris/actions-gh-pages action to v4
• chore(deps): lock file maintenance
• 🔐 Create all pending approval PRs at once 🔐

Ignored or Blocked

These are blocked by an existing closed PR and will not be recreated unless you click a checkbox below.

• chore(deps): update google-github-actions/release-please-action action to v4

Detected dependencies

github-actions

.github/workflows/format-if-needed.yml

• actions/checkout v4
• actions/setup-node v4
• actions/create-github-app-token v1
• peter-evans/create-pull-request v6@6d6857d36972b65feb161a90e484f2984215f83e

.github/workflows/main.yml

• actions/checkout v4
• actions/setup-node v4
• actions/checkout v4
• actions/setup-node v4

.github/workflows/release-please.yml

• actions/create-github-app-token v1
• google-github-actions/release-please-action v3
• actions/checkout v4
• pnpm/action-setup v2
• actions/setup-node v4
• peaceiris/actions-gh-pages v3@373f7f263a76c20808c831209c920827a82a2847

npm

package.json

• @commitlint/cli ^19.3.0
• @commitlint/config-conventional ^19.2.2
• @sanity/pkg-utils 6.8.13
• @types/babel__core ^7.20.5
• @typescript-eslint/eslint-plugin ^7.8.0
• @typescript-eslint/parser ^7.8.0
• commitizen ^4.3.0
• cz-conventional-changelog ^3.3.0
• eslint ^8.57.0
• eslint-config-prettier ^9.1.0
• eslint-config-sanity ^7.1.2
• npm-run-all2 ^5.0.2
• prettier ^3.2.5
• prettier-plugin-packagejson ^2.5.0
• typedoc ^0.25.13
• typescript 5.4.5
• node ^14.13.1 || >=16.0.0 || >=18.0.0
• pnpm 9.1.0

---

• Check this box to trigger a request for Renovate to run again on this repository