How to set the background colour of text lines with IText using FabricJS?


In this tutorial, we are going to learn how to set the background colour of text lines of IText using FabricJS. The IText class was introduced in FabricJS version 1.4, extends fabric.Text and is used to create IText instances. An IText instance gives us the freedom to select, cut, paste or add new text without additional configurations. There are also various supported key combinations and mouse/touch combinations which make text interactive which are not provided in Text. Textbox, however, which is based on IText allows us to resize the text rectangle and wraps lines automatically. This is not true for IText as height is not adjusted based on the wrapping of lines. We can manipulate our IText object by using various properties. Similarly, we can also set the background colour of text lines with IText by using the textBackgroundColor property.

Syntax

new fabric.IText(text: String , { textBackgroundColor : String }: Object)

Parameters

  • text − This parameter accepts a String which is the text string that we want to display.

  • options (optional) − This parameter is an Object which provides additional customizations to our object. Using this parameter colour, cursor, border width and a lot of other properties can be changed related to the object of which textBackgroundColor is a property.

Options Keys

  • textBackgroundColor − This property accepts a String value which allows us to set the background colour of text lines.

Example 1

Default appearance of the IText object

Let’s see a code example to see how our IText object looks when the textBackgroundColor property is not used. In this case, our IText object will not contain background colour of text lines.

<!DOCTYPE html> <html> <head> <!-- Adding the Fabric JS Library--> <script src="https://cdnjs.cloudflare.com/ajax/libs/fabric.js/510/fabric.min.js"></script> </head> <body> <h2>Default appearance of the IText object</h2> <p>You can see that the IText object does not contain text background colour</p> <canvas id="canvas"></canvas> <script> // Initiate a canvas instance var canvas = new fabric.Canvas("canvas"); canvas.setWidth(document.body.scrollWidth); canvas.setHeight(250); // Initiate an itext object var itext = new fabric.IText( "Add sample text here.
Lorem ipsum dolor sit amet"
,{ width: 300, left: 210, top: 70, fill: "#d755da", } ); // Add it to the canvas canvas.add(itext); </script> </body> </html>

Example 2

Passing the textBackgroundColor property as key with a value

In this example, we will see how assigning a value to the textBackgroundColor property creates background colour for text lines. Since we have passed the value as “black”, the IText object will now have black colour as text background colour.

<!DOCTYPE html> <html> <head> <!-- Adding the Fabric JS Library--> <script src="https://cdnjs.cloudflare.com/ajax/libs/fabric.js/510/fabric.min.js"></script> </head> <body> <h2>Passing the textBackgroundColor property as key with a value</h2> <p>You can see that the IText object contains text background colour</p> <canvas id="canvas"></canvas> <script> // Initiate a canvas instance var canvas = new fabric.Canvas("canvas"); canvas.setWidth(document.body.scrollWidth); canvas.setHeight(250); // Initiate an itext object var itext = new fabric.IText( "Add sample text here.
Lorem ipsum dolor sit amet"
,{ width: 300, left: 210, top: 70, fill: "#d755da", textBackgroundColor: "black", } ); // Add it to the canvas canvas.add(itext); </script> </body> </html>

Updated on: 13-Sep-2022

438 Views

Kickstart Your Career

Get certified by completing the course

Get Started
Advertisements