How to style text
Creating styled text in Adobe XD is easy! In this tutorial, we'll show you how to create a text element with a specific color and font size, and also a text element with multiple inline colors.
Prerequisites
- Basic knowledge of HTML, CSS, and JavaScript
- Quick Start Tutorial
- Debugging Tutorial
Development Steps
Complete code for this plugin can be found on GitHub.
1. Prepare your plugin scaffold
First, edit the manifest file for the plugin you created in our Quick Start Tutorial.
Replace the uiEntryPoints
field of the manifest with the following:
"uiEntryPoints": [
{
"type": "menu",
"label": "Create Styled Text",
"commandId": "createStyledTextCommand"
}
]
If you're curious about what each entry means, see the manifest documentation, where you can also learn about all manifest requirements for a plugin to be published in the XD Plugin Manager.
Then, update your main.js
file, mapping the manifest's commandId
to a handler function.
Replace the content of your main.js
file with the following code:
function createStyledTextHandlerFunction(selection) {
// The body of this function is added later
}
module.exports = {
commands: {
"createStyledTextCommand": createStyledTextHandlerFunction
}
};
The remaining steps in this tutorial describe additional edits to the main.js
file.
2. Require in XD API dependencies
For this tutorial, we just need access to two XD scenegraph classes.
Add the following lines to the top of your main.js
file:
// Add this to the top of your main.js file
const { Text, Color } = require("scenegraph");
Now the Text
and Color
classes are required in and ready to be used.
3. Create the main function
In this step, we'll build out the main function, createStyledTextHandlerFunction
, that we added in the first step. This function will add red text to the user's doucment.
Each of the numbered comments are explained below the code:
function createStyledTextHandlerFunction(selection) {
const node = new Text(); // [1]
node.text = "This is some red text"; // [2]
node.fill = new Color("#FF0000"); // [3]
node.fontSize = 24;
selection.insertionParent.addChild(node); // [4]
node.moveInParentCoordinates(20, 50); // [5]
}
- Create the
Text
object. - Populate
text
with a string. - Set the color to red and the font size to 24 for the entire string.
- Add
text
to the scenegraph as a child of the currrently-selected artboard. - Move
text
to a different position relative to the artboard's coordinate system.
Character styles such as color and font size can also vary within the text. Read more below for details.
4. Test the plugin
If you reload the plugin and run it, you should see the following result:
Not bad for a few lines of code! Let's push it a little further.
5. Update the main function
All red is ok, but we can make our text more colorful than that. Let's change the code to apply different styles to different parts of the text, resulting in rainbow-colored text.
The styleRanges
property lets us apply different styles to different ranges of the node's text:
function createStyledTextHandlerFunction(selection) {
const node = new Text();
const textData = [ // [1]
{text: "This ", color: "red"},
{text: "is ", color: "orange"},
{text: "some ", color: "yellow"},
{text: "ra", color: "green"},
{text: "in", color: "blue"},
{text: "bow ", color: "indigo"},
{text: "text", color: "violet"}
];
node.text = textData.map(item => item.text).join(""); // [2]
node.styleRanges = textData.map(item => ({ // [3]
length: item.text.length,
fill: new Color(item.color)
}));
node.fontSize = 24; // [4]
selection.insertionParent.addChild(node);
node.moveInParentCoordinates(20, 50);
}
Here's what's changed:
- This data structure stores the text to be displayed, as well as the color to use for each fragment of text.
- Just as before, we set
node.text
equal to the text to be displayed. This time, the text string is created by concatenating together all the.text
property values contained in thetextData
array. TheArray#map
gets us an array of strings, which we combine into a single string withArray#join
. - In this step, we build an array of style objects, applying each style to a few characters of the text string. We use
Array#map
again, this time converting each item in thetextData
array into a style object. Thelength
of each style is equal to the length of the text string contained in one element of thetextData
array. Thefill
of each style uses the color value contained in one element of thetextData
array. - We can still apply styles to the entire text node at once, as in the earlier example. Here, the font size will be set to the same value across all the style ranges we just created.
Here are a few things to notice about the styleRanges
property of Text
objects:
styleRanges
is an array of objects; you can have more than one style for a text node.- Each range is given a
length
which determines the number of characters to which the style is applied, starting from the end of the previous style range. - Character styles such as
fill
orfontSize
can be set to different values in each style range, or they can be set on theText
node overall to apply the setting to all existing style ranges.
6. Run the plugin
After saving all of your changes, reload the plugin in XD and run it. You'll now have rainbow-colored text:
Next Steps
Want to expand on what you learned here? Have a look at these references to see options for customizing this sample plugin:
Ready to explore further? Take a look at our other resources: