Custom Languages
Last updated
Was this helpful?
Last updated
Was this helpful?
In Beefree SDK, Custom Languages allow you to accomplish two things:
Translate the default text in the builder to your preferred language.
Override the default text in the builder to your preferred text, even if you keep the same language.
Translating the default text in the builder is useful when you have diverse end users and you'd like to provide them with a builder experience that resonates with them.
Overriding the default text in the builder with your preferred text is useful when you want to customize the builder experience and apply your application's unique tone.
This page discusses how you can accomplish both use cases with Custom Languages. Keep in mind that you can utilize Custom Languages for overriding default text in the builder, even if you are not translating any of it to another language.
Before getting started, ensure you access and familiarize yourself with the GitHub repository. This repository includes important JSON files for you to utilize to accomplish the steps outlined on this page.
Important: Familiarize yourself with the prior to continuing into the steps.
This section includes two examples on how to use Custom Languages based on the above scenarios.
Example One: Overriding Default Text
In the , you'll find the following section at the beginning:
This JSON includes the default text in the builder, which you can see in the image of the Top bar below.
By adding the translations
parameter to the beeConfig
with the following configuration, the top bar can easily be customized.
The following image shows how this configuration appears in the builder.
Example Two: Translating Default Text
Translating the content to another language follows the same approach. The following configuration overrides the default text with the Spanish translation.
The following image shows the result of the configuration with the Spanish configuration.
You can override the default Beefree SDK language file by providing a URL to your own translations. This is an advanced feature and will replace all languages used by the editor with the languages defined in the custom file.
Overriding the Help icon label in the default toolbar
Overriding the Rows tab label in the sidebar
Overriding the Preheader
Defining or adding a translation for "email"
The following code defines a translation object where the title for "bee-settings-details" is set to "New Email Details" specifically for the "email" field.
The following image shows the results for the overwritten default text for AI Paragraph Assistant based on the above configuration.
The following image shows the results for the overwritten default text for AI Title Assistant based on the above configuration.
The following image shows the results for the overwritten default text for AI List Assistant based on the above configuration.
The following image shows the results for the overwritten default text for AI Button Assistant based on the above configuration.
The following section lists translations that correspond with Confirmation Dialogs for Rows, Columns, Modules, and the File Manager.
This list details the translations corresponding with the Delete Row Confirmation Dialog.
Title: 🆕 Delete row
confirmation-dialogs.delete-row-confirmation-title
Secondary Button: 🆕 Keep
confirmation-dialogs.keep-button
Primary Button: 🆕 Delete
confirmation-dialogs.delete-button
This list details the translations corresponding with the Delete Column Confirmation Dialog.
Translations Variations
Title: 🆕 Delete column
confirmation-dialogs.delete-column-confirmation-title
Secondary Button: 🆕 Keep
confirmation-dialogs.keep-button
Primary Button: 🆕 Delete
confirmation-dialogs.delete-button
This list details the translations corresponding with the Delete Module Confirmation Dialog.
Translations Variations
Title: 🆕 Delete module
confirmation-dialogs.delete-module-confirmation-title
Secondary Button: 🆕 Keep
confirmation-dialogs.keep-button
Primary Button: 🆕 Delete
confirmation-dialogs.delete-button
This list details the translations corresponding with the Hide Row on Mobile Confirmation Dialog.
Translations Variations
Title: 🆕 Hide row
confirmation-dialogs.hide-row-confirmation-title
Heading: 🆕 Are you sure you want to hide this?
confirmation-dialogs.hide-row-confirmation-heading
This list details the translations corresponding with the Remove Custom Display Condition Confirmation Dialog.
Translations Variations
Title: 🆕 Delete display condition
confirmation-dialogs.delete-display-condition-confirmation-title
This list details the translations corresponding with the Confirm Delete Single File Confirmation Dialog.
Translations Variations
Title: 🆕 Delete {filename}
confirmation-dialogs.delete-file-confirmation-title
Secondary Button: 🆕 Keep
confirmation-dialogs.keep-button
Primary Button: 🆕 Delete
confirmation-dialogs.delete-button
This list details the translations corresponding with the Confirm Delete Multiple Files Confirmation Dialog.
Translations Variations
Title: 🆕 Delete {count} files
confirmation-dialogs.delete-files-confirmation-title
Secondary Button: 🆕 Keep
confirmation-dialogs.keep-button
Primary Button: 🆕 Delete
confirmation-dialogs.delete-button
This list details the translations corresponding with the Confirm Update Existing File Confirmation Dialog.
Text Updates:
Title: 🆕 Replace {filename}
confirmation-dialogs.replace-file-confirmation-title
Secondary Button: 🆕 Keep
confirmation-dialogs.keep-button
This list details the translations corresponding with the Update Existing File Confirmation Dialog.
Translations Variations
Title: 🆕 File {filename} already exists
confirmation-dialogs.file-already-exists-title
Heading: 🆕 Do you want to replace or keep both files?
confirmation-dialogs.replace-file-confirmation-heading
Reference the corresponding classnames: Not applicable.
This list details the translations corresponding with the Move File Replace Confirmation Dialog.
Title: 🆕 File {filename} already exists
confirmation-dialogs.file-already-exists-title
Heading: 🆕 Do you want to replace or keep both files?
confirmation-dialogs.replace-file-confirmation-heading
Reference the corresponding classnames: Not applicable.
The easiest method to override specific text labels is to , which contains the segments of the language file you want to override.
You can override the default text for the . The following configuration sample includes the AI component and the various default text fields you can override.
Reference the for additional customization options and details.
Reference the corresponding .
Reference the corresponding .
Reference the corresponding .
Reference the corresponding classnames for .
Reference the corresponding classnames for .
Reference the corresponding classnames for .
Reference the corresponding .
Note: This section is relevant if both the and ConfirmOverwriteModalEnabled
are activate.
Reference the corresponding .
Check out our Github repository for in all supported languages.