Ask or search…
K
Links

Edit Single Row Mode

This feature is available on Beefree SDK Core plan and above. If you're on the Essentials plan, upgrade a development application for free to try this and other Core-level features.

How it works

Our builders offer ready-to-go rows to your end-users, which provide both structure and content to create contents faster. With Edit Single Row mode you can offer an easier way for your users to modify a single row with a tailored UI built to edit the row structure, content, and style settings without worrying about messing up with the overall design of the email campaign, landing page, or pop-up.
Edit Single Row mode complements the Saved Rows as it allows a complete control over the content of individual rows (e.g. the footer that requires to be updated) without the need to intervene into a full template, this will help you in implementing a more effective way to manage libraries of Saved Rows with a streamlined design process.

Initializing the editor in Edit Single Row Mode

type ClientConfig = {
workspace?: {
editSingleRow?: boolean
// ....
}
// ....
}
const beeConfig: ClientConfig = {
workspace:{
editSingleRow: true
// ....
}
// ....
}
// Create the instance
function BeePlugin.create(token, beeConfig, (beePluginInstance) => {
//....
beePluginInstance.start(template, { shared: false })
}
When a builder application is initialized with this mode enabled the UI will show to the user only properties that pertain to editing a single row, therefore:
  • the options to insert custom rows, saved rows, or new default rows are disabled,
  • the Settings tab is unavailable, as those properties are specific to the entire document,
  • when a row is selected on the editing stage, the action to Delete, Duplicate, Comment, Save are not available.

Implementing the Save action

The following describes the recommended workflow to implement the Save action in your host SaaS application when the Single Edit Row mode is enabled.
In case your application uses the default Toolbar, you can leverage the save button to trigger the sequence of action to correctly save the row, the workflow is the same as the one documented in saving-rows-workflow-for-developers, in short :
  1. 1.
    The user clicks on the save button
  2. 2.
    A contentDialog of type saveRow will be triggered.
In case your application doesn’t use the default Toolbar you will need to handle the row saving in a different way, following a couple of examples:
  • Calling the save method. It will trigger the on onSave event with two arguments, one of them is the full message JSON that can be saved as a Saved Row (it’s the same JSON returned by the onSaveRow event).

Example:

myCustomToolbarButton.onClick(() => beePluginInstance.save())
...
onSave: function (json, html) {
myCustomApi.saveRow(json)
},
  • Listening to the onChange event. It will receive the updated full message JSON which again can be saved as a Saved Row.

Example:

onChange: function (json, response) {
myCustomApi.saveRow(json)
},

Merging saved rows in existing messages

An effective way to update saved rows across multiple templates is by implementing the save action in combination with the CSAPI, to handle a row update across multiple existing templates.