Top-Level API

The top-level API is the main entry point to Scrivito.

At the most basic level, you can configure the SDK and provide models for your pages, widgets and resources. You can define React components for page and widget rendering and utilize read and write methods for page navigation.

This enables editors to create and edit landing pages using the “Create page” menu action.

There are no widgets available for the page body yet, but this is just a matter of calling provideWidgetClass, which works exactly like provideObjClass.

canEdit(obj)
Determines whether a CMS object can be altered by the editor in the current working copy.
canWrite()
Determines whether the content in a working copy is editable.
configure(options)
Sets global options for a Scrivito-based web application.
configureContentBrowser(options)
Sets global options for the Content Browser.
configureObjClassForContentType(mapping)
Defines which CMS object class to use if content is uploaded.
configurePreviewSizes(previewSizes)
Defines custom preview sizes for use in Scrivito’s editing interface.
connect(component, options?)
Returns a new React class component that is connected to Scrivito.
createObjClass(definition)
Creates a page or resource type for the CMS without adding it to the registry of CMS object types.
createWidgetClass(definition)
Creates a CMS widget type without adding it to the registry of CMS widget types.
currentEditor()
Returns the current editor.
currentLanguage()
Returns the language that the website is using.
currentPage()
Returns the current page.
currentPageParams()
Returns the query parameters of the current URL.
currentSiteId()
Returns the site ID determined by the Scrivito-based application.
currentUser()
Returns the current user.
currentWorkspace()
Returns the current working copy.
currentWorkspaceId()
Returns the ID of the currently selected working copy.
editorLanguage()
Returns the user interface language of the currently logged-in editor.
ensureUserIsLoggedIn()
Verifies the log-in status of the current user and triggers a login, if the user is not logged in.
extendMenu(menuCallback)
Customizes the top-right Scrivito menu.
extractText(obj, options)
Extracts text from a given Obj and returns it as a string.
finishLoading()
Notifies your application after Scrivito has loaded and displayed the content of the current page.
getClass(name)
Returns the CMS object or widget class of the given name.
getInstanceId()
Returns the currently configured instance ID.
isComparisonActive()
Indicates whether the Scrivito UI is currently displaying a comparison between content versions, e.g. in the “Changes” view mode.
isCurrentPage(page)
Returns whether a page is the current page.
isEditorLoggedIn()
Indicates whether a Scrivito UI is present and an editor is logged in.
isInPlaceEditingActive()
Indicates whether in-place editing is enabled or not.
isOnCurrentPath(page)
Returns whether a page is either the current page or an ancestor of the current page.
isUserLoggedIn()
Indicates whether the current user is logged in as a visitor.
load(functionToLoad)
Loads CMS data asynchronously.
logout(returnTo?)
Causes the user to be logged out of IAM.
navigateTo(target, options)
Sets the current page.
openDialog(name)
Opens a dialog in which the React component with the given name is rendered.
preload(preloadDump)
Preload all content encoded inside the provided preload dump.
provideAuthGroups(authGroups)
Defines authentication groups for visibility categories.
provideComponent(nameOrClass, component, options)
Registers a React component for rendering pages or widgets of the given class name, CMS object or widget class.
provideDataClass(name, params)
Makes external data available to the application.
provideDataItem(name, getCallback | connection | params)
Makes external data globally available to the application.
provideEditingConfig(subject, editingConfig)
Configures user-interface-related aspects of a CMS object, widget class or globally available data.
provideLayoutComponent(objClass, component)
Registers a React component for rendering the layout for pages of the given class.
provideObjClass(name, objClassOrDefinition)
Creates a page or resource type for the CMS, or registers an already existing class.
provideWidgetClass(name, widgetClassOrDefinition)
Creates a widget class or registers an already existing class.
registerComponent(name, component)
Registers the React component with the given name, so it can be used as a Scrivito extension.
renderPage(page, renderFunction)
Executes the render function for a specific page.
resolveHtmlUrls(htmlString)
Transforms internal URLs contained in raw Scrivito HTML markup to fully qualified URLs.
setVisitorIdToken(idToken)
Provides a visitor identity token to Scrivito causing restricted content to become available.
uiContext()
Provides styling information about the environment in which a custom component is rendered.
updateContent()
Updates the preloaded content to the currently published content.
updateMenuExtensions()
Forcedly updates the top-right Scrivito menu.
urlFor(target, options)
Determines the URL of a Scrivito model instance.
urlForDataItem(dataItem, options)
Determines the URL of a data item.
useHistory(history)
Integrates Scrivito’s routing with that of an existing React application.
validationResultsFor(model, attribute)
Determines the validation results for an attribute of an Obj or a Widget.

Do you have a question?

Top-Level API

Top-Level API

Method summary