Q
Version: 0.12.2
Source on Github

Compass Transform

Provides mixins for CSS3 2D and 3D transforms. See W3C: CSS 2D transforms and See W3C: CSS 3D transforms.

Safari is the only browser that currently supports 3D transforms. Because of that it can be important to control whether a given 2D transform uses the full range of experimental browser prefixes, or only the 3D list. To make that easy, all 2D transforms include an browser-targeting toggle ($only3d) to switch between the two support lists. The toggle defaults to 'false' (2D), and also accepts 'true' (3D). Currently the lists are as follows: 2D: Mozilla, Webkit, Opera, Official 3D: Webkit, Official **(Only Safari Supports 3D perspective)**

This file can be imported using: @import "compass/css3/transform"

Imports

  1. Shared Utilities

Configurable Variables help

50%

The default x-origin for transforms

50%

The default y-origin for transforms

50%

The default z-origin for transforms

1.25

The default x-multiplier for scaling

$default-scale-x

The default y-multiplier for scaling

$default-scale-x

The default z-multiplier for scaling

45deg

The default angle for rotations

1

The default x-vector for the axis of 3d rotations

1

The default y-vector for the axis of 3d rotations

1

The default z-vector for the axis of 3d rotations

1em

The default x-length for translations

$default-translate-x

The default y-length for translations

$default-translate-x

The default z-length for translations

5deg

The default x-angle for skewing

5deg

The default y-angle for skewing

Mixins

view source

=apply-origin($origin, $only3d)
  $only3d: $only3d or -compass-list-size(-compass-list($origin)) > 2
  @if $only3d
    +experimental(transform-origin, $origin, -moz, -webkit, -o, -ms, not -khtml, official)
  @else
    +experimental(transform-origin, $origin, -moz, -webkit, -o, -ms, not -khtml, official)
@mixin apply-origin($origin, $only3d) {
  $only3d: $only3d or -compass-list-size(-compass-list($origin)) > 2;
  @if $only3d {
    @include experimental(transform-origin, $origin, -moz, -webkit, -o, -ms, not -khtml, official);
  }
  @else {
    @include experimental(transform-origin, $origin, -moz, -webkit, -o, -ms, not -khtml, official);
  }
}

Transform-origin Transform-origin sent as a complete string

@include apply-origin( origin [, 3D-only ] )

where 'origin' is a space separated list containing 1-3 (x/y/z) coordinates in percentages, absolute (px, cm, in, em etc..) or relative (left, top, right, bottom, center) units

@param only3d Set this to true to only apply this mixin where browsers have 3D support.

view source

=transform-origin($origin-x: $default-origin-x, $origin-y: $default-origin-y, $origin-z: false, $only3d: if($origin-z, true, false))
  $origin: unquote("")
  @if $origin-x or $origin-y or $origin-z
    @if $origin-x
      $origin: $origin-x
    @else
      $origin: 50%
    @if $origin-y
      $origin: $origin $origin-y
    @else
      @if $origin-z
        $origin: $origin 50%
    @if $origin-z
      $origin: $origin $origin-z
    +apply-origin($origin, $only3d)
@mixin transform-origin($origin-x: $default-origin-x, $origin-y: $default-origin-y, $origin-z: false, $only3d: if($origin-z, true, false)) {
  $origin: unquote("");
  @if $origin-x or $origin-y or $origin-z {
    @if $origin-x {
      $origin: $origin-x;
    }
    @else {
      $origin: 50%;
    }
    @if $origin-y {
      $origin: $origin $origin-y;
    }
    @else {
      @if $origin-z {
        $origin: $origin 50%;
      }
    }
    @if $origin-z {
      $origin: $origin $origin-z;
    }
    @include apply-origin($origin, $only3d);
  }
}

Transform-origin sent as individual arguments:

@include transform-origin( [ origin-x, origin-y, origin-z, 3D-only ] )

where the 3 'origin-' arguments represent x/y/z coordinates.

NOTE: setting z coordinates triggers 3D support list, leave false for 2D support

view source

=transform($transform, $only3d: false)
  @if $only3d
    +experimental(transform, $transform, -moz, -webkit, -o, -ms, not -khtml, official)
  @else
    +experimental(transform, $transform, -moz, -webkit, -o, -ms, not -khtml, official)
@mixin transform($transform, $only3d: false) {
  @if $only3d {
    @include experimental(transform, $transform, -moz, -webkit, -o, -ms, not -khtml, official);
  }
  @else {
    @include experimental(transform, $transform, -moz, -webkit, -o, -ms, not -khtml, official);
  }
}

Transform sent as a complete string:

@include transform( transforms [, 3D-only ] )

where 'transforms' is a space separated list of all the transforms to be applied.

view source

=transform2d($trans)
  +transform($trans, false)
@mixin transform2d($trans) {
  @include transform($trans, false);
}

Shortcut to target all browsers with 2D transform support

view source

=transform3d($trans)
  +transform($trans, true)
@mixin transform3d($trans) {
  @include transform($trans, true);
}

Shortcut to target only browsers with 3D transform support

view source

=perspective($p)
  +experimental(perspective, $p, -moz, -webkit, -o, -ms, not -khtml, official)
@mixin perspective($p) {
  @include experimental(perspective, $p, -moz, -webkit, -o, -ms, not -khtml, official);
}

Set the perspective of 3D transforms on the children of an element:

 @include perspective( perspective )

where 'perspective' is a unitless number representing the depth of the z-axis. The higher the perspective, the more exaggerated the foreshortening. values from 500 to 1000 are more-or-less "normal" - a good starting-point.

view source

=perspective-origin($origin: 50%)
  +experimental(perspective-origin, $origin, -moz, -webkit, -o, -ms, not -khtml, official)
@mixin perspective-origin($origin: 50%) {
  @include experimental(perspective-origin, $origin, -moz, -webkit, -o, -ms, not -khtml, official);
}

Set the origin position for the perspective

 @include perspective-origin(origin-x [origin-y])

where the two arguments represent x/y coordinates

view source

=transform-style($style: preserve-3d)
  +experimental(transform-style, $style, -moz, -webkit, -o, -ms, not -khtml, official)
@mixin transform-style($style: preserve-3d) {
  @include experimental(transform-style, $style, -moz, -webkit, -o, -ms, not -khtml, official);
}

Determine whether a 3D objects children also live in the given 3D space

 @include transform-style( [ style ] )

where style can be either flat or preserve-3d. Browsers default to flat, mixin defaults to preserve-3d.

view source

=backface-visibility($visibility: hidden)
  +experimental(backface-visibility, $visibility, -moz, -webkit, -o, -ms, not -khtml, official)
@mixin backface-visibility($visibility: hidden) {
  @include experimental(backface-visibility, $visibility, -moz, -webkit, -o, -ms, not -khtml, official);
}

Determine the visibility of an element when it's back is turned

@include backface-visibility( [ visibility ] )

where visibility can be either visible or hidden. Browsers default to visible, mixin defaults to hidden

view source

=scale($scale-x: $default-scale-x, $scale-y: $scale-x, $perspective: false, $only3d: false)
  $trans: scale($scale-x, $scale-y)
  @if $perspective
    $trans: perspective($perspective) $trans
  +transform($trans, $only3d)
@mixin scale($scale-x: $default-scale-x, $scale-y: $scale-x, $perspective: false, $only3d: false) {
  $trans: scale($scale-x, $scale-y);
  @if $perspective {
    $trans: perspective($perspective) $trans;
  }
  @include transform($trans, $only3d);
}

Scale an object along the x and y axis:

 @include scale( [ scale-x, scale-y, perspective, 3D-only ] )

where the 'scale-' arguments are unitless multipliers of the x and y dimensions and perspective, which works the same as the stand-alone perspective property/mixin but applies to the individual element (multiplied with any parent perspective)

Note This mixin cannot be combined with other transform mixins.

view source

=scaleX($scale: $default-scale-x, $perspective: false, $only3d: false)
  $trans: scaleX($scale)
  @if $perspective
    $trans: perspective($perspective) $trans
  +transform($trans, $only3d)
@mixin scaleX($scale: $default-scale-x, $perspective: false, $only3d: false) {
  $trans: scaleX($scale);
  @if $perspective {
    $trans: perspective($perspective) $trans;
  }
  @include transform($trans, $only3d);
}

Scale an object along the x axis @include scaleX( [ scale-x, perspective, 3D-only ] )

Note This mixin cannot be combined with other transform mixins.

view source

=scaleY($scale: $default-scale-y, $perspective: false, $only3d: false)
  $trans: scaleY($scale)
  @if $perspective
    $trans: perspective($perspective) $trans
  +transform($trans, $only3d)
@mixin scaleY($scale: $default-scale-y, $perspective: false, $only3d: false) {
  $trans: scaleY($scale);
  @if $perspective {
    $trans: perspective($perspective) $trans;
  }
  @include transform($trans, $only3d);
}

Scale an object along the y axis @include scaleY( [ scale-y, perspective, 3D-only ] )

Note This mixin cannot be combined with other transform mixins.

view source

=scaleZ($scale: $default-scale-z, $perspective: false)
  $trans: scaleZ($scale)
  @if $perspective
    $trans: perspective($perspective) $trans
  +transform3d($trans)
@mixin scaleZ($scale: $default-scale-z, $perspective: false) {
  $trans: scaleZ($scale);
  @if $perspective {
    $trans: perspective($perspective) $trans;
  }
  @include transform3d($trans);
}

Scale an object along the z axis @include scaleZ( [ scale-z, perspective ] )

Note This mixin cannot be combined with other transform mixins.

view source

=scale3d($scale-x: $default-scale-x, $scale-y: $default-scale-y, $scale-z: $default-scale-z, $perspective: false)
  $trans: scale3d($scale-x, $scale-y, $scale-z)
  @if $perspective
    $trans: perspective($perspective) $trans
  +transform3d($trans)
@mixin scale3d($scale-x: $default-scale-x, $scale-y: $default-scale-y, $scale-z: $default-scale-z, $perspective: false) {
  $trans: scale3d($scale-x, $scale-y, $scale-z);
  @if $perspective {
    $trans: perspective($perspective) $trans;
  }
  @include transform3d($trans);
}

Scale and object along all three axis @include scale3d( [ scale-x, scale-y, scale-z, perspective ] )

Note This mixin cannot be combined with other transform mixins.

view source

=rotate($rotate: $default-rotate, $perspective: false, $only3d: false)
  $trans: rotate($rotate)
  @if $perspective
    $trans: perspective($perspective) $trans
  +transform($trans, $only3d)
@mixin rotate($rotate: $default-rotate, $perspective: false, $only3d: false) {
  $trans: rotate($rotate);
  @if $perspective {
    $trans: perspective($perspective) $trans;
  }
  @include transform($trans, $only3d);
}

Rotate an object around the z axis (2D) @include rotate( [ rotation, perspective, 3D-only ] ) where 'rotation' is an angle set in degrees (deg) or radian (rad) units

Note This mixin cannot be combined with other transform mixins.

view source

=rotateZ($rotate: $default-rotate, $perspective: false, $only3d: false)
  +rotate($rotate, $perspective, $only3d)
@mixin rotateZ($rotate: $default-rotate, $perspective: false, $only3d: false) {
  @include rotate($rotate, $perspective, $only3d);
}

A longcut for 'rotate' in case you forget that 'z' is implied

Note This mixin cannot be combined with other transform mixins.

view source

=rotateX($rotate: $default-rotate, $perspective: false)
  $trans: rotateX($rotate)
  @if $perspective
    $trans: perspective($perspective) $trans
  +transform3d($trans)
@mixin rotateX($rotate: $default-rotate, $perspective: false) {
  $trans: rotateX($rotate);
  @if $perspective {
    $trans: perspective($perspective) $trans;
  }
  @include transform3d($trans);
}

Rotate an object around the x axis (3D) @include rotateX( [ rotation, perspective ] )

Note This mixin cannot be combined with other transform mixins.

view source

=rotateY($rotate: $default-rotate, $perspective: false)
  $trans: rotateY($rotate)
  @if $perspective
    $trans: perspective($perspective) $trans
  +transform3d($trans)
@mixin rotateY($rotate: $default-rotate, $perspective: false) {
  $trans: rotateY($rotate);
  @if $perspective {
    $trans: perspective($perspective) $trans;
  }
  @include transform3d($trans);
}

Rotate an object around the y axis (3D) @include rotate( [ rotation, perspective ] )

Note This mixin cannot be combined with other transform mixins.

view source

=rotate3d($vector-x: $default-vector-x, $vector-y: $default-vector-y, $vector-z: $default-vector-z, $rotate: $default-rotate, $perspective: false)
  $trans: rotate3d($vector-x, $vector-y, $vector-z, $rotate)
  @if $perspective
    $trans: perspective($perspective) $trans
  +transform3d($trans)
@mixin rotate3d($vector-x: $default-vector-x, $vector-y: $default-vector-y, $vector-z: $default-vector-z, $rotate: $default-rotate, $perspective: false) {
  $trans: rotate3d($vector-x, $vector-y, $vector-z, $rotate);
  @if $perspective {
    $trans: perspective($perspective) $trans;
  }
  @include transform3d($trans);
}

Rotate an object around an arbitrary axis (3D) @include rotate( [ vector-x, vector-y, vector-z, rotation, perspective ] ) where the 'vector-' arguments accept unitless numbers. These numbers are not important on their own, but in relation to one another creating an axis from your transform-origin, along the axis of Xx = Yy = Zz.

Note This mixin cannot be combined with other transform mixins.

view source

=translate($translate-x: $default-translate-x, $translate-y: $default-translate-y, $perspective: false, $only3d: false)
  $trans: translate($translate-x, $translate-y)
  @if $perspective
    $trans: perspective($perspective) $trans
  +transform($trans, $only3d)
@mixin translate($translate-x: $default-translate-x, $translate-y: $default-translate-y, $perspective: false, $only3d: false) {
  $trans: translate($translate-x, $translate-y);
  @if $perspective {
    $trans: perspective($perspective) $trans;
  }
  @include transform($trans, $only3d);
}

Move an object along the x or y axis (2D) @include translate( [ translate-x, translate-y, perspective, 3D-only ] ) where the 'translate-' arguments accept any distance in percentages or absolute (px, cm, in, em etc..) units.

Note This mixin cannot be combined with other transform mixins.

view source

=translateX($trans-x: $default-translate-x, $perspective: false, $only3d: false)
  $trans: translateX($trans-x)
  @if $perspective
    $trans: perspective($perspective) $trans
  +transform($trans, $only3d)
@mixin translateX($trans-x: $default-translate-x, $perspective: false, $only3d: false) {
  $trans: translateX($trans-x);
  @if $perspective {
    $trans: perspective($perspective) $trans;
  }
  @include transform($trans, $only3d);
}

Move an object along the x axis (2D) @include translate( [ translate-x, perspective, 3D-only ] )

Note This mixin cannot be combined with other transform mixins.

view source

=translateY($trans-y: $default-translate-y, $perspective: false, $only3d: false)
  $trans: translateY($trans-y)
  @if $perspective
    $trans: perspective($perspective) $trans
  +transform($trans, $only3d)
@mixin translateY($trans-y: $default-translate-y, $perspective: false, $only3d: false) {
  $trans: translateY($trans-y);
  @if $perspective {
    $trans: perspective($perspective) $trans;
  }
  @include transform($trans, $only3d);
}

Move an object along the y axis (2D) @include translate( [ translate-y, perspective, 3D-only ] )

Note This mixin cannot be combined with other transform mixins.

view source

=translateZ($trans-z: $default-translate-z, $perspective: false)
  $trans: translateZ($trans-z)
  @if $perspective
    $trans: perspective($perspective) $trans
  +transform3d($trans)
@mixin translateZ($trans-z: $default-translate-z, $perspective: false) {
  $trans: translateZ($trans-z);
  @if $perspective {
    $trans: perspective($perspective) $trans;
  }
  @include transform3d($trans);
}

Move an object along the z axis (3D) @include translate( [ translate-z, perspective ] )

Note This mixin cannot be combined with other transform mixins.

view source

=translate3d($translate-x: $default-translate-x, $translate-y: $default-translate-y, $translate-z: $default-translate-z, $perspective: false)
  $trans: translate3d($translate-x, $translate-y, $translate-z)
  @if $perspective
    $trans: perspective($perspective) $trans
  +transform3d($trans)
@mixin translate3d($translate-x: $default-translate-x, $translate-y: $default-translate-y, $translate-z: $default-translate-z, $perspective: false) {
  $trans: translate3d($translate-x, $translate-y, $translate-z);
  @if $perspective {
    $trans: perspective($perspective) $trans;
  }
  @include transform3d($trans);
}

Move an object along the x, y and z axis (3D) @include translate( [ translate-x, translate-y, translate-z, perspective ] )

Note This mixin cannot be combined with other transform mixins.

view source

=skew($skew-x: $default-skew-x, $skew-y: $default-skew-y, $only3d: false)
  $trans: skew($skew-x, $skew-y)
  +transform($trans, $only3d)
@mixin skew($skew-x: $default-skew-x, $skew-y: $default-skew-y, $only3d: false) {
  $trans: skew($skew-x, $skew-y);
  @include transform($trans, $only3d);
}

Skew an element:

@include skew( [ skew-x, skew-y, 3D-only ] )

where the 'skew-' arguments accept css angles in degrees (deg) or radian (rad) units.

Note This mixin cannot be combined with other transform mixins.

view source

=skewX($skew-x: $default-skew-x, $only3d: false)
  $trans: skewX($skew-x)
  +transform($trans, $only3d)
@mixin skewX($skew-x: $default-skew-x, $only3d: false) {
  $trans: skewX($skew-x);
  @include transform($trans, $only3d);
}

Skew an element along the x axiz

@include skew( [ skew-x, 3D-only ] )

Note This mixin cannot be combined with other transform mixins.

view source

=skewY($skew-y: $default-skew-y, $only3d: false)
  $trans: skewY($skew-y)
  +transform($trans, $only3d)
@mixin skewY($skew-y: $default-skew-y, $only3d: false) {
  $trans: skewY($skew-y);
  @include transform($trans, $only3d);
}

Skew an element along the y axis

@include skew( [ skew-y, 3D-only ] )

Note This mixin cannot be combined with other transform mixins.

view source

=create-transform($perspective: false, $scale-x: false, $scale-y: false, $scale-z: false, $rotate-x: false, $rotate-y: false, $rotate-z: false, $rotate3d: false, $trans-x: false, $trans-y: false, $trans-z: false, $skew-x: false, $skew-y: false, $origin-x: false, $origin-y: false, $origin-z: false, $only3d: false)
  $trans: unquote("")
  // perspective
  @if $perspective
    $trans: perspective($perspective)
  // scale
  @if $scale-x and $scale-y
    @if $scale-z
      $trans: $trans scale3d($scale-x, $scale-y, $scale-z)
    @else
      $trans: $trans scale($scale-x, $scale-y)
  @else
    @if $scale-x
      $trans: $trans scaleX($scale-x)
    @if $scale-y
      $trans: $trans scaleY($scale-y)
    @if $scale-z
      $trans: $trans scaleZ($scale-z)
  // rotate
  @if $rotate-x
    $trans: $trans rotateX($rotate-x)
  @if $rotate-y
    $trans: $trans rotateY($rotate-y)
  @if $rotate-z
    $trans: $trans rotateZ($rotate-z)
  @if $rotate3d
    $trans: $trans rotate3d($rotate3d)
  // translate
  @if $trans-x and $trans-y
    @if $trans-z
      $trans: $trans translate3d($trans-x, $trans-y, $trans-z)
    @else
      $trans: $trans translate($trans-x, $trans-y)
  @else
    @if $trans-x
      $trans: $trans translateX($trans-x)
    @if $trans-y
      $trans: $trans translateY($trans-y)
    @if $trans-z
      $trans: $trans translateZ($trans-z)
  // skew
  @if $skew-x and $skew-y
    $trans: $trans skew($skew-x, $skew-y)
  @else
    @if $skew-x
      $trans: $trans skewX($skew-x)
    @if $skew-y
      $trans: $trans skewY($skew-y)
  // apply it!
  +transform($trans, $only3d)
  +transform-origin($origin-x, $origin-y, $origin-z, $only3d)
@mixin create-transform($perspective: false, $scale-x: false, $scale-y: false, $scale-z: false, $rotate-x: false, $rotate-y: false, $rotate-z: false, $rotate3d: false, $trans-x: false, $trans-y: false, $trans-z: false, $skew-x: false, $skew-y: false, $origin-x: false, $origin-y: false, $origin-z: false, $only3d: false) {
  $trans: unquote("");
  // perspective
  @if $perspective {
    $trans: perspective($perspective);
  }
  // scale
  @if $scale-x and $scale-y {
    @if $scale-z {
      $trans: $trans scale3d($scale-x, $scale-y, $scale-z);
    }
    @else {
      $trans: $trans scale($scale-x, $scale-y);
    }
  }
  @else {
    @if $scale-x {
      $trans: $trans scaleX($scale-x);
    }
    @if $scale-y {
      $trans: $trans scaleY($scale-y);
    }
    @if $scale-z {
      $trans: $trans scaleZ($scale-z);
    }
  }
  // rotate
  @if $rotate-x {
    $trans: $trans rotateX($rotate-x);
  }
  @if $rotate-y {
    $trans: $trans rotateY($rotate-y);
  }
  @if $rotate-z {
    $trans: $trans rotateZ($rotate-z);
  }
  @if $rotate3d {
    $trans: $trans rotate3d($rotate3d);
  }
  // translate
  @if $trans-x and $trans-y {
    @if $trans-z {
      $trans: $trans translate3d($trans-x, $trans-y, $trans-z);
    }
    @else {
      $trans: $trans translate($trans-x, $trans-y);
    }
  }
  @else {
    @if $trans-x {
      $trans: $trans translateX($trans-x);
    }
    @if $trans-y {
      $trans: $trans translateY($trans-y);
    }
    @if $trans-z {
      $trans: $trans translateZ($trans-z);
    }
  }
  // skew
  @if $skew-x and $skew-y {
    $trans: $trans skew($skew-x, $skew-y);
  }
  @else {
    @if $skew-x {
      $trans: $trans skewX($skew-x);
    }
    @if $skew-y {
      $trans: $trans skewY($skew-y);
    }
  }
  // apply it!
  @include transform($trans, $only3d);
  @include transform-origin($origin-x, $origin-y, $origin-z, $only3d);
}

Full transform mixins For settings any combination of transforms as arguments These are complex and not highly recommended for daily use. They are mainly here for backward-compatibility purposes.

  • they include origin adjustments
  • scale takes a multiplier (unitless), rotate and skew take degrees (deg)

Note This mixin cannot be combined with other transform mixins.

view source

=simple-transform($scale: false, $rotate: false, $trans-x: false, $trans-y: false, $skew-x: false, $skew-y: false, $origin-x: false, $origin-y: false)
  +create-transform(false, $scale, $scale, false, false, false, $rotate, false, $trans-x, $trans-y, false, $skew-x, $skew-y, $origin-x, $origin-y, false, false)
@mixin simple-transform($scale: false, $rotate: false, $trans-x: false, $trans-y: false, $skew-x: false, $skew-y: false, $origin-x: false, $origin-y: false) {
  @include create-transform(false, $scale, $scale, false, false, false, $rotate, false, $trans-x, $trans-y, false, $skew-x, $skew-y, $origin-x, $origin-y, false, false);
}

A simplified set of options backwards-compatible with the previous version of the 'transform' mixin