Implementing a simple configuration form To give a very simple example, let's say our plugin wants to provide the end user with a simple boolean flag called debugMode
. If this flag is enabled, then the plugin will display a series of debug messages in the console as it works.
The first step is to implement the renderConfigScreen
hook, which will simply initialize React by rendering a custom component called ConfigScreen
:
import React from 'react' ;
import ReactDOM from 'react-dom' ;
import { connect , RenderConfigScreenCtx } from 'datocms-plugin-sdk' ;
connect ( {
renderConfigScreen ( ctx : RenderConfigScreenCtx ) {
ReactDOM . render (
< React.StrictMode >
< ConfigScreen ctx = { ctx } />
</ React.StrictMode > ,
document . getElementById ( 'root' ) ,
) ;
} ,
} ) ;
The hook, in its ctx
argument, provides a series of information and methods for interacting with the main application, and for now we'll just pass the whole object to the component, in the form of a React prop:
import { Canvas } from 'datocms-react-ui' ;
type PropTypes = {
ctx : RenderConfigScreenCtx ;
} ;
function ConfigScreen ( { ctx } : PropTypes ) {
return (
< Canvas ctx = { ctx } >
Hello from the config screen !
</ Canvas >
) ;
}
It 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.
It is now time to setup our form:
import { Canvas , SwitchField } from 'datocms-react-ui' ;
type FreshInstallationParameters = { } ;
type ValidParameters = { devMode : boolean } ;
type Parameters = FreshInstallationParameters | ValidParameters ;
export default function ConfigScreen ( { ctx } : PropTypes ) {
const parameters = ctx . plugin . attributes . parameters as Parameters ;
return (
< Canvas ctx = { ctx } >
< SwitchField
id = " 01 "
name = " development "
label = " Enable development mode? "
hint = " Log debug information in console "
value = { parameters . devMode }
onChange = { ( newValue ) => {
ctx . updatePluginParameters ( { devMode : newValue } ) ;
ctx . notice ( 'Settings updated successfully!' ) ;
} }
/>
</ Canvas >
) ;
}
The important things to notice are that:
Once saved, settings are always available as ctx.plugin.attributes.parameters
in any of the other hooks, so that your plugin can have different behaviours based on them.
Using a form management library If you have more complex settings, feel free to use one of the many form management libraries available for React to avoid code repetition.
We recommend react-final-form , as it works well and is quite lightweight (~8kb). Here's a more complete example using it:
import { RenderConfigScreenCtx } from 'datocms-plugin-sdk' ;
import {
Button ,
Canvas ,
SwitchField ,
TextField ,
Form ,
FieldGroup ,
} from 'datocms-react-ui' ;
import { Form as FormHandler , Field } from 'react-final-form' ;
type PropTypes = {
ctx : RenderConfigScreenCtx ;
} ;
type FirstInstallationParameters = { } ;
type ValidParameters = { devMode : boolean ; title : string } ;
type Parameters = FirstInstallationParameters | ValidParameters ;
export default function ConfigScreen ( { ctx } : PropTypes ) {
return (
< Canvas ctx = { ctx } >
< FormHandler < Parameters >
initialValues = { ctx . plugin . attributes . parameters }
validate = { ( values ) => {
const errors : Record < string , string > = { } ;
if ( ! values . title ) {
errors . title = 'This field is required!' ;
}
return errors ;
} }
onSubmit = { async ( values ) => {
await ctx . updatePluginParameters ( values ) ;
ctx . notice ( 'Settings updated successfully!' ) ;
} }
>
{ ( { handleSubmit , submitting , dirty } ) => (
< Form onSubmit = { handleSubmit } >
< FieldGroup >
< Field name = " title " >
{ ( { input , meta : { error } } ) => (
< TextField
id = " title "
label = " Title "
hint = " Title to show "
placeholder = " Your title "
required
error = { error }
{ ... input }
/>
) }
</ Field >
< Field name = " devMode " >
{ ( { input , meta : { error } } ) => (
< SwitchField
id = " devMode "
label = " Enable development mode? "
hint = " Log debug information in console "
error = { error }
{ ... input }
/>
) }
</ Field >
</ FieldGroup >
< Button
type = " submit "
fullWidth
buttonSize = " l "
buttonType = " primary "
disabled = { submitting || ! dirty }
>
Save settings
</ Button >
</ Form >
) }
</ FormHandler >
</ Canvas >
) ;
}
This will be the final result:
renderConfigScreen
This function will be called when the plugin needs to render the plugin's
configuration form.
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.owner The account that is the project owner.
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.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.
We use cookies to enhance the user experience. Do you consent their use in accordance with
our cookie policy ?
I consent I decline