Within all the renderXXX
hooks — that is, those that have the task of presenting a custom interface part to the user — it is possible to open custom modal dialogs to "get out" of the reduced space that the iframe
provides, and get more room to build more complex interfaces.
Suppose our plugin implements a custom page accessible from the top navigation bar:
import React from 'react' ;
import ReactDOM from 'react-dom' ;
import { connect , IntentCtx , RenderPageCtx } from 'datocms-plugin-sdk' ;
import { Canvas } from 'datocms-react-ui' ;
function render ( component : React . ReactNode ) {
ReactDOM . render (
< React . StrictMode > { component } < / React . StrictMode > ,
document . getElementById ( 'root' ) ,
) ;
}
connect ( {
mainNavigationTabs ( ctx : IntentCtx ) {
return [
{
label : 'Welcome' ,
icon : 'igloo' ,
pointsTo : {
pageId : 'welcome' ,
} ,
} ,
] ;
} ,
renderPage ( pageId , ctx : RenderPageCtx ) {
switch ( pageId ) {
case 'welcome' :
return render ( < WelcomePage ctx = { ctx } / > ) ;
}
} ,
} ) ;
type PropTypes = {
ctx : RenderPageCtx ;
} ;
function WelcomePage ( { ctx } : PropTypes ) {
return < Canvas ctx = { ctx } > Hi ! < / Canvas > ;
}
Within the ctx
argument you can find the function openModal()
, which triggers the opening of a modal:
import { Canvas , Button } from 'datocms-react-ui' ;
function WelcomePage ( { ctx } : PropTypes ) {
const handleOpenModal = async ( ) => {
const result = await ctx . openModal ( {
id : 'customModal' ,
title : 'Custom title!' ,
width : 'l' ,
parameters : { name : 'Mark' } ,
} ) ;
ctx . notice ( result ) ;
} ;
return (
< Canvas ctx = { ctx } >
< Button type = "button" onClick = { handleOpenModal } >
Open modal !
< / Button >
< / Canvas >
) ;
}
The openModal()
function offers various rendering options, for example you can set its size and title. Interestingly, the function returns a promise, which will be resolved when the modal is closed by the user.
You can specify what to render inside the modal by implementing a new hook called renderModal
which, similarly to what we did with custom pages, initializes React with a custom component:
connect ( {
renderModal ( modalId : string , ctx : RenderModalCtx ) {
switch ( modalId ) {
case 'customModal' :
return render ( < CustomModal ctx = { ctx } / > ) ;
}
} ,
} ) ;
You are free to fill the modal with the information you want, and you can access the parameters specified when opening the modal through ctx.parameters
:
import { Canvas } from 'datocms-react-ui' ;
type PropTypes = {
ctx : RenderModalCtx ;
} ;
function CustomModal ( { ctx } : PropTypes ) {
return (
< Canvas ctx = { ctx } >
< div style = { { fontSize : 'var(--font-size-xxxl)' , fontWeight : '500' } } >
Hello { ctx . parameters . name } !
< / div >
< / Canvas >
) ;
}
As with any other hook, is important to wrap the content inside the Canvas
component, so that the iframe will continuously auto-adjust its size based on the content we're rendering, and to give our app the look and feel of the DatoCMS web app.
Closing the modal If the modal will be closed through the close button provided by the interface, the promise openModal()
will be resolved with value null
.
You can also decide not to show a "close" button:
const result = await sdk . openModal ( {
id : 'customModal' ,
closeDisabled : true ,
} ) ;
In this case the user will only be able to close the modal via an interaction of your choice (custom buttons, for example):
import { Canvas , Button } from 'datocms-react-ui' ;
function CustomModal ( { ctx } : PropTypes ) {
const handleClose = ( returnValue : string ) => {
ctx . resolve ( returnValue ) ;
} ;
return (
< Canvas ctx = { ctx } >
Hello { ctx . parameters . name } !
< Button type = "button" onClick = { handleClose . bind ( null , 'a' ) } > Close A < / Button >
< Button type = "button" onClick = { handleClose . bind ( null , 'b' ) } > Close B < / Button >
< / Canvas > ;
}
The ctx.resolve()
function will close the modal, and resolve the original openModal()
promise with the value you passed.
renderModal
This function will be called when the plugin requested to open a modal (see
the openModal
function).
Properties available in context The following information and methods are available:
ctx.account The account that is the project owner.
ctx.currentRole The role for the current DatoCMS user.
ctx.currentUser The current DatoCMS user. It can either be the owner or one of the
collaborators (regular or SSO).
ctx.currentUserAccessToken The access token to perform API calls on behalf of the current user. Only
available if currentUserAccessToken additional permission is granted.
ctx.environment The ID of the current environment.
ctx.fields All the fields currently loaded for the current DatoCMS project, indexed by
ID. It will always contain the current model fields and all the fields of
the blocks it might contain via Modular Content/Structured Text fields. If
some fields you need are not present, use the loadItemTypeFields function
to load them.
ctx.fieldsets All the fieldsets currently loaded for the current DatoCMS project, indexed
by ID. It will always contain the current model fields and all the fields
of the blocks it might contain via Modular Content/Structured Text fields.
If some fields you need are not present, use the loadItemTypeFieldsets
function to load them.
ctx.itemTypes All the models of the current DatoCMS project, indexed by ID.
ctx.modalId The ID of the modal that needs to be rendered.
ctx.owner The account that is the project owner.
ctx.parameters The arbitrary parameters of the modal declared in the openModal
function.
ctx.plugin The current plugin.
ctx.site The current DatoCMS project.
ctx.ssoUsers All the SSO users currently loaded for the current DatoCMS project, indexed
by ID. It will always contain the current user. If some users you need are
not present, use the loadSsoUsers function to load them.
ctx.theme An object containing the theme colors for the current DatoCMS project.
ctx.ui UI preferences of the current user (right now, only the preferred locale is
available).
ctx.users All the regular users currently loaded for the current DatoCMS project,
indexed by ID. It will always contain the current user. If some users you
need are not present, use the loadUsers function to load them.
Methods available in context The following information and methods are available:
ctx.alert() Triggers an "error" toast displaying the selected message.
ctx.createNewItem() Opens a dialog for creating a new record. It returns a promise resolved
with the newly created record or null if the user closes the dialog
without creating anything.
ctx.customToast() Triggers a custom toast displaying the selected message (and optionally a
CTA).
ctx.editItem() Opens a dialog for editing an existing record. It returns a promise
resolved with the edited record, or null if the user closes the dialog
without persisting any change.
ctx.editUpload() Opens a dialog for editing a Media Area asset. It returns a promise
resolved with:
The updated asset, if the user persists some changes to the asset itself
null, if the user closes the dialog without persisting any change
An asset structure with an additional deleted property set to true, if
the user deletes the asset.
ctx.editUploadMetadata() Opens a dialog for editing a "single asset" field structure. It returns a
promise resolved with the updated structure, or null if the user closes
the dialog without persisting any change.
ctx.loadFieldsUsingPlugin() Loads all the fields in the project that are currently using the plugin for
one of its manual field extensions.
ctx.loadItemTypeFields() Loads all the fields for a specific model (or block). Fields will be
returned and will also be available in the the fields property.
ctx.loadItemTypeFieldsets() Loads all the fieldsets for a specific model (or block). Fieldsets will be
returned and will also be available in the the fieldsets property.
ctx.loadSsoUsers() Loads all SSO users. Users will be returned and will also be available in
the the ssoUsers property.
ctx.loadUsers() Loads all regular users. Users will be returned and will also be available
in the the users property.
ctx.navigateTo() Moves the user to another URL internal to the backend.
ctx.notice() Triggers a "success" toast displaying the selected message.
ctx.openConfirm() Opens a UI-consistent confirmation dialog. Returns a promise resolved with
the value of the choice made by the user.
ctx.openModal() Opens a custom modal. Returns a promise resolved with what the modal itself
returns calling the resolve() function.
ctx.resolve() A function to be called by the plugin to close the modal. The openModal
call will be resolved with the passed return value.
ctx.selectItem() Opens a dialog for selecting one (or multiple) record(s) from a list of
existing records of type itemTypeId. It returns a promise resolved with
the selected record(s), or null if the user closes the dialog without
choosing any record.
ctx.selectUpload() Opens a dialog for selecting one (or multiple) existing asset(s). It
returns a promise resolved with the selected asset(s), or null if the
user closes the dialog without selecting any upload.
ctx.startAutoResizer() Listens for DOM changes and automatically calls setHeight when it detects
a change. If you're using datocms-react-ui package, the ``
component already takes care of calling this method for you.
ctx.stopAutoResizer() Stops resizing the iframe automatically.
ctx.updateFieldAppearance() Performs changes in the appearance of a field. You can install/remove a
manual field extension, or tweak their parameters. If multiple changes are
passed, they will be applied sequencially.
Always check ctx.currentRole.meta.finalpermissions.canedit_schema
before calling this, as the user might not have the permission to perform
the operation.
ctx.updateHeight() Triggers a change in the size of the iframe. If you don't explicitely pass
a newHeight it will be automatically calculated using the iframe content
at the moment.
ctx.updatePluginParameters() Updates the plugin parameters.
Always check ctx.currentRole.meta.finalpermissions.canedit_schema
before calling this, as the user might not have the permission to perform
the operation.