Technical Details

The latest technical documentation about the Email Text Component can be found on GitHub.

Further details about developing Core Components can be found in the Core Components developer documentation.

The Email Text Component and the Rich Text Editor

The Email Text Component leverages the AEM Rich Text Editor (RTE). The RTE provides content authors with a wide range of functionality for editing their text content. The RTE is flexible in its configuration and offers a number of options. Further details about how the RTE can be configured can be found in the articles Configure the Rich Text Editor and Configure the Rich Text Editor plug-ins.

The remainder of this document demonstrates the standard configuration of the Email Text Component with the out-of-the-box RTE configuration.

NOTE
Only options enabled by UI configurations of the RTE are available in the Email Text Component.

Edit Dialog

Text Component's edit dialog

Formatting Options

The edit dialog offers the standard rich text formatting tools that a user would expect to compose text.

Bold

Bold icon

Used to apply bold formatting to selected text or boldly format text entered after the cursor.

Ctrl+B can be used as a keyboard shortcut.

Italic

Italic icon

Used to apply italicized formatting to selected text or italicize text entered after the cursor.

Ctrl+I can be used as a keyboard shortcut.

Underline

Underline icon

Used to apply underlined formatting to selected text or underline text entered after the cursor.

Ctrl+U can be used as a keyboard shortcut.

Subscript

Subscript icon

Used to format selected text or text entered after the cursor as subscript.

Superscript

Superscript icon

Used to format selected text or text entered after the cursor as superscript.

Paste as Text

Paste as text icon

Pastes any copied text as plain text without any formatting.

When selecting this option, a window opens where the text can be pasted as plain text with no formatting as a preview before it is inserted into the text. Accept by tapping or clicking the check mark, cancel by tapping or clicking the x.

Paste as text example

Paste from Word

Paste from Word icon

When selecting this option, a window opens where the text can be pasted maintaining its formatting as a preview before it is inserted into the text. Accept by tapping or clicking the check mark, cancel by tapping or clicking the x.

Paste from Word example

Hyperlink icon

Use this option to convert the selected text into a hyperlink or modify an already defined link. This option opens a window with additional options for setting the link.

Hyperlink example

  • Enter the path

    • Use the Open Selection dialog to choose a path in AEM
    • If the link is not within AEM, enter the absolute URL
      • Non-absolute paths are interpreted as relative to AEM
  • Enter alternative descriptive text for the link

  • Select link behavior

    • Target
    • Same Tab
    • New Tab
    • Parent Frame
    • Top Frame

Tap or click the check mark to apply the link or the x to cancel.

Unlink icon

Use this option to remove a link already applied to the selected text. This option is only active when a link is already selected.

Anchor

Anchor icon

Use this option to insert an anchor into the text.

Find

Find icon

Use this option to search the text for occurrence of a specified text string. Selecting this option opens a window for specifying the search options.

Find example

Enter the text for which you want to search and tap or click Find to begin the search. Tap or click the x to cancel.
If you wish to do an exact match according to the case, select the option Match Case before starting the search.
If a match is found, it is highlighted and the search dialog is dimmed. Tap or click the Find button again in the dimmed dialog to search for the next occurrence.

Find example found

If no additional occurrences are found, a message will be displayed and the search will restart from the beginning of the text.

Find example no more occurrences

Replace

Replace icon

Use this option to search the text for occurrences of a specified text string and replace the matches with another string. Selecting this option opens a window for specifying the search and replace options.

Replace example

Enter the text for which you want to search as well as the text with which it should be replaced.

  • Tap or click Find to begin the search. Click or tap the x to cancel.
  • If you wish to do an exact match according to the case, select the option Match Case before starting the search.
  • Select Replace all to replace all occurrences of the text at once.

If a match is found, it is highlighted and the search dialog is dimmed. Click the Find button again in the dimmed dialog to search for the next occurrence or select the Replace button to replace the highlighted, matched text. The Replace button is only active once a match is made.

The find and replace dialog becomes transparent when find is clicked and becomes opaque when replace is clicked. This allows the author to review the text that the author will replace.

NOTE
When using the replace functionality, the string to be replaced should be entered at the same time as the string to be found. However you can still click find to search for the string before replacing it. If the replace string is entered after clicking find, the search is reset to the beginning of the text.