Control Hooks

Preview Events

Client APIs

Detailed reference on enabling highlights on HTML elements via annotations.

Annotations

Configuration for custom tasks that can be triggered by content editors.

Actions

Configuration properties that after tasks run by the container in a cloud project.

Container

Options available within a single content model definition in the visual editor.

Model Properties

Attributes for fields belonging to a model in the visual editor configuration.

Field Properties

Introduction to configuring your content models for use with the visual editor.

Content Modeling

Technical reference for working with one or more content sources.

Content Sources

Configuration properties that affect individual document objects.

Documents

Configuration properties that tell the visual editor which framework you're using.

Frameworks

Technical reference for configuring media asset providers.

Media

Properties that control how navigation features are populated.

Navigation

Properties that override the default behavior for component presets.

Presets

Customize the preview experience for your site.

Previews

Specifying initial content to import into your content source when duplicating a repository.

Provisioning Content

Properties that handle how references are handled when creating new documents.

References

Customize sidebar navigation in the visual editor.

Sidebar

Primary visual editor configuration file reference (stackbit.config.js) that enables you to customize the visual editing experience for your site.

Configuration

The init method is responsible for initializing the content source instance.

init

The getVersion method is responsible for returning the versions of both the content source module and the content source interface that it implements.

getVersion

The getContentSourceType method returns the unique type of the content source module.

getContentSourceType

The getProjectId method is responsible for returning a unique identifier for the content source instance among other instances of the same type.

getProjectId

The getProjectManageUrl method is responsible for returning the URL address of the web-based management application of the content source for the current project.

getProjectManageUrl

The getSchema method is responsible for returning models and locales in the visual editor format.

getSchema

The getDocuments method is responsible for returning documents in the visual editor format.

getDocuments

The getAssets method is responsible for returning assets in the expected format.

getAssets

The startWatchingContentUpdates method is responsible for initiating the monitoring of content and schema changes within the content source.

startWatchingContentUpdates

The stopWatchingContentUpdates method is responsible for stopping the content source from monitoring any changes to the content and schema.

stopWatchingContentUpdates

The onWebhook method is responsible for handling content source webhooks and update the visual editing cache.

onWebhook

The onFilesChange method is responsible for handling file changes and update the visual editing cache.

onFilesChange

The hasAccess method is responsible for checking whether the current user has the necessary permissions to update the content in the underlying content source.

hasAccess

The createDocument method is responsible for creating a document in the underlying content source.

createDocument

The updateDocument method is responsible for updating a document in the underlying content source.

updateDocument

The deleteDocument is responsible for deleting a document from the underlying content source.

deleteDocument

The uploadAsset method is responsible for handling the upload of an asset to the underlying content source.

uploadAsset

The validateDocuments method is responsible for validating documents.

validateDocuments

The publishDocuments method is responsible for publishing documents in the underlying content source.

publishDocuments

The reset method is responsible for resetting the internal state of the content source instance.

reset

The destroy method is responsible for destroying the content source instance.

destroy

The getScheduledActions method is responsible for retrieving scheduled publish events from the content source

getScheduledActions

The createScheduledAction method creates a new scheduled event in the content source.

createScheduledAction

The cancelScheduledAction method cancels a previously-scheduled event in the content source.

cancelScheduledAction

The updateScheduledAction method changes the schedule for a previously-scheduled event.

updateScheduledAction

The getDocumentVersions method enables version control and returns a list of document versions.

getDocumentVersions

The getDocumentForVersion method retrieves a document version when version control is enabled and the versions list doesn't provide documents.

getDocumentForVersion

Interface Methods

The visual editor manages cache for documents, assets and schema originally provided by the content source modules.

Cache

CSI generic types for extending the cached data

Generics

The Typescript definition of the visual editor's Document type

Document

The Typescript definition of the visual editor's DocumentVersion type

DocumentVersion

The Typescript definition of the visual editor Asset type

Asset

The Typescript definition of the visual editor's ScheduledAction type

ScheduledAction

Examples

An interface between a content source and the visual editor allows bi-directional content synchronization.

Content Sources Interface

Configuration API reference for page and component presets.

Presets API

Configure and run the visual editor locally.

Visual Editor CLI

Client-side configuration for bringing custom field controls to the visual editor.

Methods for adjusting the preview in response to user actions.

Methods for hooking into the visual editor through front-end JavaScript.