@studiometa/js-toolkit/utils/css/matrix.d.ts

A set of useful little bits of JavaScript to boost your project! 🚀

type MatrixTransform = {
    scaleX?: number;
    scaleY?: number;
    skewX?: number;
    skewY?: number;
    translateX?: number;
    translateY?: number;
};
/**
 * Format a CSS transform matrix with the given values.
 *
 * @param  {Object} transform
 * @param  {number} [transform.scaleX=1]     The scale on the x axis.
 * @param  {number} [transform.scaleY=1]     The scale on the y axis.
 * @param  {number} [transform.skewX=0]      The skew on the x axis.
 * @param  {number} [transform.skewY=0]      The skew on the y axis.
 * @param  {number} [transform.translateX=0] The translate on the x axis.
 * @param  {number} [transform.translateY=0] The translate on the y axis.
 * @return {string}                           A formatted CSS matrix transform.
 * @example
 * ```js
 * matrix({ scaleX: 0.5, scaleY: 0.5 });
 * // matrix(0.5, 0, 0, 0.5, 0, 0)
 * ```
 * @link https://js-toolkit.studiometa.dev/utils/css/matrix.html
*/
export declare function matrix(transform?: MatrixTransform): string;
export {};