Types

Every type Blok exports, grouped by concern. These are the export type declarations in @useblok/core.

Config


Config
ComponentConfig<Props>
RootConfig<Props>
Category
TabConfig

Fields


Field              // union of all field types below
FieldType          // "text" | "textarea" | ... | "custom"
Fields<Props>      // Record<keyof Props, Field>
BaseField
 
// Each field type
TextField
TextareaField
RichTextField
NumberField
BooleanField
SelectField
RadioField
AssetField
LinkField
ArrayField
ObjectField
SlotField
CustomField<Value>
CustomFieldRenderProps<Value>
Option

Data


Data<RootProps?, BlockProps?>
BlockInstance<Props>
RootData<Props>

Blok component


BlokProps
BlokRenderContext    // passed into ComponentConfig.render as `blok`

Plus the constant ROOT_ZONE.

Store


BlokState
BlokStore
CreateStoreOptions
BlokStoreProviderProps
LeftPanel
RightPanel
EditMode
Viewport            // "desktop" | "tablet" | "mobile" | "fullscreen"

Hooks


KeyboardShortcutHandlers
BlokActions
SeoReadiness

Plugins


BlokPlugin
PluginFieldRenderer<Value>
PluginFieldRenderProps<Value>
PluginLeftPanel
PluginInitContext
PluginIcon
PluginProviderProps
MergedPluginRegistry

Migrations


BlockMigration<OldProps, NewProps>
MigrationReport

Versions


DocumentVersion
DocumentVersionRef
CreateVersionMeta
VersionOrigin
VersionsBinding
VersionChangeEvent
DocumentDiff
BlockDiffDetail
PropChange
VersionsProviderProps
VersionsModalProps

Comments


Comment
CommentAuthor
CommentTarget
CreateCommentInput
UpdateCommentPatch
CommentsBinding
CommentChangeEvent
CommentsProviderProps

Presence


PresencePeer
PresenceFocus
PresenceEvent
PresenceBinding
PresenceIdentity
PresenceProviderProps
PresenceStackProps

Audit


AuditActor
AuditAction
AuditEvent
AuditTarget
AuditBinding
AuditAppendInput
AuditLogListOptions
AuditChangeEvent
AuditLogProviderProps
AuditLogModalProps

Publish gates


PublishGatesReport
PublishGatesConfig
GateIssue
GateResult
GateSeverity
GateContext
GateSpec
GateToggle
PublishGatesProviderProps

Permissions


BlokRole             // "editor" | "reviewer" | "viewer"
BlokAction           // "edit" | "publish" | "comment" | ...
PermissionsProviderProps

Settings


Settings
AiSettings
ModuleSettings
AiProviderMode
AiScope

AI


AiAction
AiFieldAction
AiFieldActionContext
AiBlockAction
AiBlockActionContext
AiCompletionProvider
AiCompletionRequest
AiProviderProps

Import example


import type {
  Blok, Config, Data, ComponentConfig, Fields,
  BlockInstance, BlokPlugin, BlokRole,
} from "@useblok/core";