How to lock the rotation of Textbox using FabricJS?

In this tutorial, we are going to learn how to lock the rotation of a Textbox using FabricJS. Just as we can specify the position, colour, opacity and dimension of a textbox object in the canvas, we can also specify whether we want to allow rotation or not. This can be done by using the lockRotation property.

Syntax

new fabric.Textbox(text: String, { lockRotation : Boolean }: Object)

Parameters

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

Options Keys

lockRotation ? This property accepts a Boolean value. If we assign it a "true" value, then the object rotation will be locked.

Example 1

Default behaviour of a Textbox object in the canvas

Let's see a code example to understand the default behaviour of a textbox object when lockRotation property is not used. By default, we can rotate a textbox object anticlockwise or clockwise.



<!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 behaviour of a Textbox object in the canvas</h2>
	<p>You can try rotating the Textbox using rotation handle to see the default behaviour</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 textbox object
		var textbox = new fabric.Textbox("Don't let yesterday take up too much of today.", {
			width: 400,
			left: 110,
			top: 70,
			fill: "orange",
			strokeWidth: 2,
			stroke: "green",
			textAlign: "center",
		});

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

Example 2

Passing lockRotation as key with ?true' value

In this example, we will see how we can cease the ability of a textbox object to rotate by using the lockRotation property. As we can see, as soon as we try to rotate the textbox object, a not-allowed cursor is shown. This means that the rotation action is no longer allowed.



<!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 lockRotation as key with ?true' value</h2>
	<p>Now we see a not-allowed cursor when we try to rotate the textbox</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 textbox object
		var textbox = new fabric.Textbox("Don't let yesterday take up too much of today.", {
			width: 400,
			left: 110,
			top: 70,
			fill: "orange",
			strokeWidth: 2,
			stroke: "green",
			textAlign: "center",
			lockRotation: true,
		});

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

Rahul Gurung

Updated on: 2022-08-02T12:11:41+05:30

247 Views

Kickstart Your Career

Get certified by completing the course

Get Started