How to change the duration of cursor fadein in IText using FabricJS?

In this tutorial, we are going to learn about how to change the duration of cursor fadein in 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. Likewise, we can change the duration of cursor fadein by using the cursorDuration property.

Syntax

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

Parameters

text − This parameter accepts a String which is the text string that we want to display as our text.
options (optional) − This parameter is an Object which provides additional customizations to our IText object. Using this parameter colour, cursor, stroke width and a lot of other properties can be changed related to the IText object of which cursorDuration is a property.

Options Keys

cursorDuration − This property accepts a Number value which allows us to change the duration of cursor fade in in "ms". The default value is 600ms.

Example 1

Default appearance of IText object

Let’s see a code example to see the default appearance of IText object when the cursorDuration property is not used. As we have not specified anything, the cursor fadein will have the default value of 600ms.


<!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 IText object’s cursor duration</h2>
   <p>You can click on the IText object to see the default cursor fadein</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.", {
         width: 300,
         left: 50,
         top: 70,
         fill: "red",
      });

      // Add it to the canvas
      canvas.add(itext);
   </script>
</body>
</html>

Example 2

Passing the cursorDuration property as key with a custom value

In this example, we have passed the cursorDuration property as key with the value as 200ms. This will ensure that our cursor fadein happens more rapidly.


<!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 cursorDuration property as key with a custom value</h2>
   <p> You can click on the IText object to see the cursor fadein occuring more rapidly </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.", {
         width: 300,
         left: 50,
         top: 70,
         fill: "red",
         cursorDuration: 200,
      });

      // Add it to the canvas
      canvas.add(itext);
   </script>
</body>
</html>