Indexed by TopGit from live GitHub metadata: jlmakes/rematrix has 436 stars, written primarily in JavaScript. Matrix transformations made easy.
Snapshot summary built from the project's own GitHub metadata — there's no written TopGit review yet. The page will update automatically when a full review is published.
WHY NO REVIEW YET
TopGit writes full reviews for the most-starred, most-requested repositories. This page is a snapshot until then — see the READ ME tab for the original README in full.
Imagine a HTML element that may have a CSS transform applied. If we want to add 45° of Z-rotation, we have no way to handle this safely in CSS—we’d just risk overwriting an existing transform. So we decide to use JavaScript, and check the current transform...
getComputedStyle(element) returns the computed styles, and inspecting the transform property shows:
It’s here we discover that browsers actually use transformation matrices under the hood to describe rotation, translation, scale and shear. This means if we wish to manage CSS transforms with JavaScript (without overwriting existing transformations), we’re stuck working with matrices.
Rematrix is an easy way to create and combine matrix transformations that work seamlessly with CSS.
Installation
Browser
A simple and fast way to get started is to include this script on your page:
If you use this method in production, be sure to specify a fixed version number, and use the minified distribution; e.g: https://unpkg.com/[email protected]/dist/rematrix.min.js. This improves performance, but also prevents library changes from impacting your project.
This will create the global variable Rematrix.
Module
npm install rematrix
CommonJS
const Rematrix = require('rematrix')
ES2015
import * as Rematrix from 'rematrix'
Guide
Creating Transforms
Most API methods look a lot like CSS, so for example, in CSS if we would write transform: rotateZ(45deg), we can create the same transformation in JavaScript using Rematrix like this:
Rematrix.rotateZ(45)
This returns a 45° rotation along the Z-axis, represented as an array of 16 values:
These 16 values represent our transformation matrix in column-major order.
Combining Transforms (Using Multiplication)
Where Rematrix really outshines CSS, is the ability to combine transforms — using matrix multiplication. We’ll recreate the same 45° rotation along the Z-axis, but using separate matrices this time:
let r1 = Rematrix.rotateZ(20)
let r2 = Rematrix.rotateZ(25)
let product = Rematrix.multiply(r1, r2)
Here product describes the same array of 16 values (seen above):
There’s a good chance we’ll need to multiply quite a few matrices together, so its helpful to store them in an array in order to use Array.prototype.reduce to multiply them all in one line:
let r1 = Rematrix.rotateZ(20)
let r2 = Rematrix.rotateZ(65)
let r3 = Rematrix.rotateZ(-40)
let product = [r1, r2, r3].reduce(Rematrix.multiply)
Order is important. For example, rotating 45° along the Z-axis, followed by translating 500 pixels along the Y-axis... is not the same as translating 500 pixels along the Y-axis, followed by rotating 45° along on the Z-axis.
Preserving Transforms
Before applying any of our transforms, we should capture the existing transform of our element using Rematrix.fromString(), e.g:
let element = document.querySelector('#example')
let style = getComputedStyle(element).transform
let transform = Rematrix.fromString(style)
let r1 = Rematrix.rotateZ(20)
let r2 = Rematrix.rotateZ(65)
let r3 = Rematrix.rotateZ(-40)
let product = [transform, r1, r2, r3].reduce(Rematrix.multiply)
By passing the computed transform styles to Rematrix.fromString(), we create a matrix of the existing transform. We can now factor this into our multiplication.
The existing transformation has been deliberately placed at the start of the array to ensure the computed transform is the foundation for the succeeding transformations.
Applying Transforms
We can turn our matrix into valid CSS using Rematrix.toString(), which we can apply to our element’s style, e.g:
And that concludes this introduction to Rematrix. Please explore the finished Live Demo on JSFiddle.
API Reference
format(source)
fromString(source)
identity()
inverse(source)
multiply(matrixA, matrixB)
perspective(distance)
rotate(angle)
rotateX(angle)
rotateY(angle)
rotateZ(angle)
scale(scalar, [scalarY])
scaleX(scalar)
scaleY(scalar)
scaleZ(scalar)
skew(angleX, [angleY])
skewX(angle)
skewY(angle)
toString(source)
translate(distanceX, [distanceY])
translate3d(distanceX, distanceY, distanceZ)
translateX(distance)
translateY(distance)
translateZ(distance)
format(source) ⇒ number[]
Transformation matrices in the browser come in two flavors:
matrix using 6 values (short)
matrix3d using 16 values (long)
This utility follows this conversion guide
to expand short form matrices to their equivalent long form.
Param
Description
source
A number[] with length 6 or 16
fromString(source) ⇒ number[]
Converts a CSS Transform to array.
Param
Description
source
A string containing a matrix or matrix3d property value.
identity() ⇒ number[]
Returns a matrix representing no transformation. The product of any matrix
multiplied by the identity matrix will be the original matrix.
Tip: Similar to how 5 * 1 === 5, where 1 is the identity.
inverse(source) ⇒ number[]
Returns a matrix representing the inverse transformation of the source
matrix. The product of any matrix multiplied by its inverse will be the
identity matrix.
Tip: Similar to how 5 * (1/5) === 1, where 1/5 is the inverse.
Param
Description
source
A number[] with length 6 or 16
multiply(matrixA, matrixB) ⇒ number[]
Returns a matrix representing the combined transformations
of both arguments.
Note: Order is important. For example, rotating 45° along the Z-axis,
followed by translating 500 pixels along the Y-axis...
Is not the same as translating 500 pixels along the Y-axis,
followed by rotating 45° along on the Z-axis.
Param
Description
matrixA
A number[] with length 6 or 16
matrixB
A number[] with length 6 or 16
perspective(distance) ⇒ number[]
Returns a matrix representing perspective.
Param
Description
distance
A number measured in pixels.
rotate(angle) ⇒ number[]
Returns a matrix representing Z-axis rotation.
Tip: This is just an alias for Rematrix.rotateZ for parity with CSS
Param
Description
angle
A number measured in degrees.
rotateX(angle) ⇒ number[]
Returns a matrix representing X-axis rotation.
Param
Description
angle
A number measured in degrees.
rotateY(angle) ⇒ number[]
Returns a matrix representing Y-axis rotation.
Param
Description
angle
A number measured in degrees.
rotateZ(angle) ⇒ number[]
Returns a matrix representing Z-axis rotation.
Param
Description
angle
A number measured in degrees.
scale(scalar, [scalarY]) ⇒ number[]
Returns a matrix representing 2D scaling. The first argument
is used for both X and Y-axis scaling, unless an optional
second argument is provided to explicitly define Y-axis scaling.
Param
Description
scalar
A number decimal multiplier.
[scalarY]
A number decimal multiplier. (Optional)
scaleX(scalar) ⇒ number[]
Returns a matrix representing X-axis scaling.
Param
Description
scalar
A number decimal multiplier.
scaleY(scalar) ⇒ number[]
Returns a matrix representing Y-axis scaling.
Param
Description
scalar
A number decimal multiplier.
scaleZ(scalar) ⇒ number[]
Returns a matrix representing Z-axis scaling.
Param
Description
scalar
A number decimal multiplier.
skew(angleX, [angleY]) ⇒ number[]
Returns a matrix representing shear. The first argument
defines X-axis shearing, and an optional second argument
defines Y-axis shearing.
Param
Description
angleX
A number measured in degrees.
[angleY]
A number measured in degrees. (Optional)
skewX(angle) ⇒ number[]
Returns a matrix representing X-axis shear.
Param
Description
angle
A number measured in degrees.
skewY(angle) ⇒ number[]
Returns a matrix representing Y-axis shear.
Param
Description
angle
A number measured in degrees.
toString(source) ⇒ string
Returns a CSS Transform property value equivalent to the source matrix.
Param
Description
source
A number[] with length 6 or 16
translate(distanceX, [distanceY]) ⇒ number[]
Returns a matrix representing 2D translation. The first
argument defines X-axis translation, and an optional second
argument defines Y-axis translation.
Returns a matrix representing 3D translation. The first
argument defines X-axis translation, the second argument defines Y-axis
translation, and the third argument defines Z-axis translation.
Param
Description
distanceX
A number measured in pixels.
distanceY
A number measured in pixels.
distanceZ
A number measured in pixels.
translateX(distance) ⇒ number[]
Returns a matrix representing X-axis translation.
Param
Description
distance
A number measured in pixels.
translateY(distance) ⇒ number[]
Returns a matrix representing Y-axis translation.
Param
Description
distance
A number measured in pixels.
translateZ(distance) ⇒ number[]
Returns a matrix representing Z-axis translation.
Param
Description
distance
A number measured in pixels.
Copyright 2021 Julian Lloyd.
Open source under the MIT License.
The most recent commit recorded on jlmakes/rematrix was 4.8 years ago, based on the GitHub push timestamp. The repository has 13 forks — one of the better signals of community interest.
How does jlmakes/rematrix compare to other Frontend projects?
jlmakes/rematrix is tracked by TopGit in the Frontend category, with 436 GitHub stars and written in JavaScript. Browse the Frontend topic page on TopGit to compare it against similar projects by stars and activity.
How many stars does jlmakes/rematrix have?
jlmakes/rematrix has 436 GitHub stars — refresh the page for the live number, or check github.com/jlmakes/rematrix. TopGit mirrors GitHub's count but does not claim minute-by-minute accuracy.
What is jlmakes/rematrix?
jlmakes/rematrix (jlmakes/rematrix) is a JavaScript project on GitHub. From the project's own README: Matrix transformations made easy.
What language is jlmakes/rematrix written in?
jlmakes/rematrix is written primarily in JavaScript. GitHub's language field is based on the largest share of bytes in the default branch.
What topics is jlmakes/rematrix associated with?
GitHub's repository topics for jlmakes/rematrix: "css", "javascript", "matrix", "transform". TopGit's editorial category is Frontend.
Why is jlmakes/rematrix categorized under Frontend?
TopGit places jlmakes/rematrix in the Frontend category based on its GitHub topics and description (tagged: "css", "javascript", "matrix"). Categories are assigned from real repository metadata, not editorial guesswork.
Read full README in the tab above.
Want a second opinion on rematrix?
Ask an AI that can read this page — one click and you get its take on rematrix.