How to create text path in IText using FabricJS?

In this tutorial, we are going to learn about how to create text path 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 specify a path for our text by using the path property.

Syntax

new fabric.IText( text: String , { path: fabric.Path }: 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 path is a property.

Options Keys

  • path − This property accepts a object which allow fabric.Paths us to specify a path that the text should follow.

Example 1

Default appearance of IText object

Let’s see a code example to see the default appearance of IText object when the path property is not used. In this case, we will only see the default straight text.

<!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</h2>
   <p>You can see the default appearance of IText object</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 path property as key

Let’s see a code example to see how to create a text path using the path property. As we can see in this example, the path created has been highlighted in black. The “M” command stands for move and tells the invisible pen to move to point “0,0”. The “C” command stands for “cubic bezier” which makes the pen draw a Bezier curve starting from current position to “100,-100”, further uses “150, -100“ as control point at the beginning of a line, and “300, 0” as the control point at the end of the line.

<!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 path property as key</h2>
   <p>You can see that the text path has been created</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 a path instance
      var path = new fabric.Path("M 0 0 C 100 -100 150 -100 300 0", {
         strokeWidth: 1,
         fill: "black",
      });
      
      // Initiate an itext object
      var itext = new fabric.IText("Add sample text here.", {
         width: 300,
         left: 50,
         top: 70,
         fill: "red",
         path: path,
         pathSide: "left",
         pathStartOffset: 0,
      });
      // Add it to the canvas
      canvas.add(itext);
   </script>
</body>
</html>

Updated on: 12-Sep-2022

642 Views

Related Articles

Kickstart Your Career

Get certified by completing the course

Get Started
Advertisements