Motion Path Module Level 1

W3C Working Draft,

More details about this document
This version:
https://www.w3.org/TR/2024/WD-motion-1-20241105/
Latest published version:
https://www.w3.org/TR/motion-1/
Editor's Draft:
https://drafts.fxtf.org/motion-1/
History:
https://www.w3.org/standards/history/motion-1/
Test Suites:
https://github.com/web-platform-tests/wpt/tree/master/css/motion
https://wpt.fyi/results/css/motion/
Feedback:
GitHub
Inline In Spec
Editors:
(Adobe Inc.)
(Igalia)
Tab Atkins-Bittner (Google)
Former Editors:
(Google)
(then Google)
Issue Tracking:
GitHub Issues
Suggest an Edit for this Spec:
GitHub Editor

Abstract

Motion path allows authors to position any graphical object and animate it along an author specified path.

Status of this document

This section describes the status of this document at the time of its publication. A list of current W3C publications and the latest revision of this technical report can be found in the W3C technical reports index at https://www.w3.org/TR/.

Publication as a Working Draft does not imply endorsement by W3C and its Members. This is a draft document and may be updated, replaced or obsoleted by other documents at any time. It is inappropriate to cite this document as other than work in progress.

GitHub Issues are preferred for discussion of this specification. When filing an issue, please put the text “motion” in the title, preferably like this: “[motion] …summary of comment…”. All issues and comments are archived, and there is also a historical archive.

This document was produced by the CSS Working Group (part of the Style Activity).

This document was produced by a group operating under the W3C Patent Policy. W3C maintains a public list of any patent disclosures made in connection with the deliverables of the group; that page also includes instructions for disclosing a patent. An individual who has actual knowledge of a patent which the individual believes contains Essential Claim(s) must disclose the information in accordance with section 6 of the W3C Patent Policy.

This document is governed by the 03 November 2023 W3C Process Document.

1. Introduction

This section is not normative.

The transform property and its related properties allow a box to be arbitrarily repositioned (and rotated, scaled, etc) relative to its laid out position, without disrupting the layout of any other elements on the page. These positions can be animated or transitioned with CSS, but only in relatively simple ways: moving a box in a straight line from its starting position to its ending position.

This specification introduces the offset shorthand, and its suite of associated longhand properties, which define an offset transform: a transform which aligns a particular point on an element (offset-anchor) to an offset position on a path (offset-path and offset-distance), and optionally rotates it to follow the path direction (offset-rotate).

This allows a number of powerful new transform possibilities, such as positioning using polar coordinates (with the ray() function) rather than the standard rectangular coordinates used by the translate() function, or animating an element along a defined path, making it easy to define complex and beautiful 2d spatial transitions.

For example, the following picture shows a curving path (indicated with dotted lines), and an airplane graphic positioned at various points along the path. The plane faces in the direction of the path at each position on the path.
Example Path

The plane is shown at different offset-distance values: 0%, 50%, and 100%.

1.1. Module interactions

This specification defines additional types of transforms (see [css-transforms-1]) that can be applied to an element.

As described in CSS Transforms 2 § 6 Current Transformation Matrix, the transforms defined by this document are layered after the individual transform properties (translate/rotate/scale, defined in [css-transforms-2]) and before the transform property (defined in [css-transforms-1]).

1.2. Values

This specification follows the CSS property definition conventions from [CSS21]. The <basic-shape> type is defined in CSS Shapes Module Level 1 [CSS-SHAPES]. The <coord-box> type is defined in CSS Box Model Module Level 3 [CSS-BOX-3]. Value types not defined in these specifications are defined in CSS Values and Units Module Level 3 [CSS3VAL].

In addition to the property-specific values listed in their definitions, all properties defined in this specification also accept CSS-wide keywords such as initial and inherit as their property value [CSS3VAL]. For readability it has not been repeated explicitly.

2. Motion Paths

2.1. Defining A Path: the offset-path property

Name: offset-path
Value: none | <offset-path> || <coord-box>
Initial: none
Applies to: transformable elements
Inherited: no
Percentages: n/a
Computed value: as specified
Canonical order: per grammar
Animation type: by computed value
Media: visual

Specifies the offset path, a geometrical path the box gets positioned on.

<offset-path> = <ray()> | <url> | <basic-shape>

Values have the following meanings:

none

The element does not have an offset transform.

<offset-path> || <coord-box>

The element has an offset transform, defined by some offset path. See § 2.7 Calculating The Offset Transform for details on how to calculate the offset transform.

All the usual effects of having a transform apply (such as creating a stacking context, etc.) See CSS Transforms 1 § 3 The Transform Rendering Model for details.

If <offset-path> is omitted, it defaults to inset(0 round X), where X is the value of border-radius on the element that establishes the containing block for this element. If <coord-box> is omitted, it defaults to border-box.

See the specific values (below) for the interpretation of each component.

<ray()>

The offset path is a line extending from the origin at some angle. See § 2.1.1 The ray() Function for details.

The <coord-box> provides the reference box for the ray.

<url>

A URL reference to an SVG shape element. The offset path is the referenced element’s equivalent path. [SVG2]

If the URL does not reference a shape element (because it references a different element, or resolves to a non-SVG document, or doesn’t resolve at all, etc) this behaves as path("m 0 0") (a <basic-shape>) instead.

The <coord-box> defines the viewport and user coordinate system for the shape element, with the origin (the 0,0 point) at the top left corner, and units being 1px in size.

<basic-shape>

The offset path is the equivalent path of the <basic-shape> function.

For all <basic-shape>s, if they accept an at <position> argument but that argument is omitted, and the element defines an offset starting position via offset-position, it uses the specified offset starting position for that argument. Otherwise it defaults as specified for each function.

The <coord-box> provides the [=/reference box=] for the <basic-shape>.

<coord-box>

Defines the box that the <offset-path> sizes into.

In CSS contexts, the boxes being referenced are from the element that establishes the containing block for this element.

In SVG contexts, all values behave as view-box.

Tests

2.1.1. The ray() Function

The ray() function defines an offset path as a straight line emerging from a point at some defined angle:

ray() = ray( <angle> && <ray-size>? && contain? && [at <position>]? )

<ray-size> = closest-side | closest-corner | farthest-side | farthest-corner | sides

Its arguments are:

<angle>

The offset path is a single line segment that starts from the offset starting position and proceeds in the direction defined by the specified <angle>. (Its length is determined by the other arguments.) As with gradient functions, <angle> values are interpreted as bearing angles, with 0deg pointing up and positive angles representing clockwise rotation.

<ray-size>

Specifies the length of the offset path (the distance between the offset-distance: 0% and offset-distance: 100% points) relative to the containing box.

If no <ray-size> is specified it defaults to closest-side.

Note: For sides, the distance depends on the <angle> specified; for all other values, the distance is constant regardless of the <angle>.

Individual keywords are:

closest-side

The distance from the ray’s starting point to whichever side of the containing block is closest.

closest-corner

The distance from the ray’s starting point to whichever corner of the containing block is closest.

farthest-side

The distance from the ray’s starting point to whichever side of the containing block is farthest.

farthest-corner

The distance from the ray’s starting point to whichever corner of the containing block is farthest.

sides

The distance from the ray’s starting point to the point where the offset path intersects the containing block’s boundary.

If the ray’s starting point is on the containing block’s boundary, or outside its bounds entirely, the distance is zero.

Note: For closest-side and closest-corner, if the ray’s starting point is on an edge/corner, that’s the closest one. (In other words, the distance is zero.)

Note: For closest-side and farthest-side, if the ray’s starting point is outside the containing block entirely, the edges of the containing block are considered to extend out to infinity.

contain

The length of the offset path is reduced so that the element stays within the containing block even at offset-distance: 100%.

Specifically, the path’s length is reduced by half the width or half the height of the element’s border box, whichever is larger, and floored at zero.

This behavior is optimized for a particular case—the element’s width and height are equal or nearly so; the element is either completely rounded by border-radius or the corners aren’t relevant to its appearance; the ray() uses closest-side positioning; and offset-anchor is set to center.

Under these conditions, which are common for situations like positioning elements around the edge of a round clock face, this ensures that each element is positioned fairly snugly against the inner edge of the clock face at offset-distance: 100%.

In other conditions this will act similarly but might not give quite as optimal a result.

at <position>

Specifies the origin of the ray, where the ray’s line begins (the 0% position). It’s resolved by using the <position> to position a 0x0 object area within the box’s containing block.

If omitted, it uses the offset starting position of the element, given by offset-position.

If the element doesn’t have an offset starting position either, it behaves as at center.

Note: ray() is currently only usable as an offset path. If it ever gets extended to other uses, its usage of offset-position will be limited solely to when it’s an offset path, similar to other <basic-shape> functions.

Tests

all of these examples need to be rewritten.

Here are some examples. The first example shows that some parts of boxes are outside of the offset path.
<style>
    body {
        transform-style: preserve-3d;
        width: 200px;
        height: 200px;
    }
    .box {
        width: 50px;
        height: 50px;
        offset-position: 50% 50%;
        offset-distance: 100%;
        offset-rotate: 0deg;
    }
    #redBox {
        background-color: red;
        offset-path: ray(45deg closest-side);
    }
    #blueBox {
        background-color: blue;
        offset-path: ray(180deg closest-side);
    }
</style>
<body>
    <div class="box" id="redBox"></div>
    <div class="box" id="blueBox"></div>
</body>
An image of boxes positioned without contain
offset-path without contain

In the second example, contain is given to the offset-path value of each box to avoid overflowing.

<style>
    body {
        transform-style: preserve-3d;
        width: 200px;
        height: 200px;
    }
    .box {
        width: 50px;
        height: 50px;
        offset-position: 50% 50%;
        offset-distance: 100%;
        offset-rotate: 0deg;
    }
    #redBox {
        background-color: red;
        offset-path: ray(45deg closest-side contain);
    }
    #blueBox {
        background-color: blue;
        offset-path: ray(180deg closest-side contain);
    }
</style>
<body>
    <div class="box" id="redBox"></div>
    <div class="box" id="blueBox"></div>
</body>
An image of boxes positioned with contain
offset-path with contain

In the third example, the path size is increased so that the box can be contained. The used offset distance is negative.

<style>
    body {
        transform-style: preserve-3d;
        width: 250px;
        height: 250px;
    }
    .box {
        width: 60%;
        height: 10%;

        offset-position: 20% 20%;
        offset-distance: 0%;
        offset-rotate: 0deg;
        offset-anchor: 200% -300%;
    }
    #blueBox {
        background-color: blue;
        offset-path: ray(-90deg closest-side contain);
    }
</style>
<body>
    <div class="box" id="blueBox"></div>
</body>
An image of an increased path size
offset-path with path size increased

In the fourth example, the initial position is outside the containing block.

<style>
    #container {
        transform-style: preserve-3d;
        width: 200px;
        height: 200px;
    }
    .box {
        width: 20%;
        height: 20%;
        offset-position: 140% 70%;
        offset-distance: 100%;
    }
    #redBox {
        background-color: red;
        offset-path: ray(-90deg sides);
    }
    #blueBox {
        background-color: blue;
        offset-path: ray(180deg closest-side);
    }
</style>
<div id="container">
    <div class="box" id="redBox"></div>
    <div class="box" id="blueBox"></div>
</div>
An image with initial position outside the containing block
Initial position outside the containing block

2.1.2. Examples Of <basic-shape> Positioning

This example uses a circle with implicit center position.
<style>
    body {
        width: 323px;
        height: 131px;
        margin: 0px;
        border: 2px solid black;
        padding: 8px;
        transform-style: preserve-3d;
    }
    .item {
        width:  90px;
        height: 40px;
        background-color: violet;
    }
    #middle {
        offset-position: auto;
        offset-path: circle(60%) margin-box;
        offset-distance: 25%;
        offset-anchor: left top;
    }
</style>
<body>
    <div class="item"></div>
    <div class="item" id="middle"></div>
    <div class="item"></div>
</body>
Normal flow determining circle center
The circle center is determined by normal flow.

2.1.3. Examples of <coord-box> Positioning

This example shows how <coord-box> offset path works in combination with border-radius.
<style>
    body {
        width: 500px;
        height: 300px;
        border-radius: 80px;
        border: dashed aqua;
        margin: 0;
    }
    #blueBox {
        width: 40px;
        height: 20px;
        background-color: blue;
        offset-path: margin-box;
    }
</style>
<body>
    <div id="blueBox"></div>
</body>
An image of example for geometry-box with border-radius
The initial position is the left end of the top horizontal line.

2.2. Position On The Path: the offset-distance property

Name: offset-distance
Value: <length-percentage>
Initial: 0
Applies to: transformable elements
Inherited: no
Percentages: relative to the offset path length
Computed value: a computed <length-percentage> value
Canonical order: per grammar
Animation type: by computed value
Media: visual

Specifies where along the offset path the offset position is.

<length-percentage>

The offset position is the point that is the specified distance along the element’s offset path. See § 2.2.1 Calculating the computed distance along a path for details about how to calculate distances along a path.

Percentages are relative to the total length of the offset path.

Tests

Note: By animating the offset-distance, an element can easily trace out a complex path.

If the element does not have an offset path, this property does nothing.

2.2.1. Calculating the computed distance along a path

Processing the distance along an offset path operates differently depending upon the nature of the offset path:

To determine the used offset distance for a given offset path and offset distance:

  1. Let the total length be the total length of offset path with all sub-paths.

  2. Convert offset distance to pixels, with 100% being converted to total length.

  3. If offset path is an unbounded ray:

    Let used offset distance be equal to offset distance.

    Otherwise if offset path is an <angle> path with contain:

    Let used offset distance be equal to offset distance, clamped so that the box lies entirely within the path.

    If offset path is any other unclosed interval:

    Let used offset distance be equal to offset distance clamped by 0 and the total length of the path.

    Otherwise offset path is a closed loop:

    Let used offset distance be equal to offset distance modulo the total length of the path. If the total length of the path is 0, used offset distance is also 0.

    Note: “Modulo” here uses the traditional mathematical definition, where the output is always non-negative.

This example shows boxes placed along an unclosed interval.
<style>
    .item {
        width: 100px;
        height: 40px;
        offset-position: 0% 0%;
        offset-path: path('m 0 0 h 200 v 150');
    }
    #box1 {
        background-color: red;
        offset-distance: -280%;
    }
    #box2 {
        background-color: green;
        offset-distance: 190%;
    }
</style>
<body>
    <div class="item" id="box1"></div>
    <div class="item" id="box2"></div>
</body>
An example of boxes placed along an unclosed interval
An example of boxes placed along an unclosed interval
This example shows boxes placed along a closed interval.
<style>
    .item {
        width: 100px;
        height: 40px;
        offset-position: 0% 0%;
        offset-path: path('m 0 0 h 200 v 150 z');
    }
    #box1 {
        background-color: red;
        offset-distance: -280%;
    }
    #box2 {
        background-color: green;
        offset-distance: 190%;
    }
</style>
<body>
    <div class="item" id="box1"></div>
    <div class="item" id="box2"></div>
</body>
An example of boxes placed along a closed interval
An example of boxes placed along a closed interval
This example shows a way to align boxes within the polar coordinate system using offset-path, offset-distance.
<style>
    body {
        transform-style: preserve-3d;
        width: 300px;
        height: 300px;
        border: dashed gray;
        border-radius: 50%;
    }
    .circleBox {
        position: absolute;
        left: 50%;
        top: 50%;
        width: 40px;
        height: 40px;
        background-color: red;
        border-radius: 50%;
    }
    #circle1 {
        offset-path: ray(0deg farthest-side);
        offset-distance: 50%;
    }
    #circle2 {
        offset-path: ray(90deg farthest-side);
        offset-distance: 20%;
    }
    #circle3 {
        offset-path: ray(225deg farthest-side);
        offset-distance: 100%;
    }
</style>
<body>
    <div class="circleBox" id="circle1"></div>
    <div class="circleBox" id="circle2"></div>
    <div class="circleBox" id="circle3"></div>
</body>
An image of three boxes positioned to polar coordinates
An example of positioning box in polar coordinates

2.3. Starting Point Of The Path: the offset-position property

Name: offset-position
Value: normal | auto | <position>
Initial: normal
Applies to: transformable elements
Inherited: no
Percentages: Refer to the size of containing block
Computed value: The normal or auto keywords, or a computed <position>
Canonical order: per grammar
Animation type: by computed value
Media: visual

Specifies the offset starting position that is used by the <offset-path> functions if they don’t specify their own starting position.

Values are defined as follows:

normal

The element does not have an offset starting position.

auto

The offset starting position is the top-left corner of the box.

Note: This is the top-left corner of the element’s own box, not that of its containing block! It’s completely different from specifiying top left. It’s meant, for example, to allow a path() to start relative to the element’s own position.

<position>

The offset starting position is the result of using the <position> to position a 0x0 object area within the box’s containing block.

Tests
This example shows positioning a box with offset-position.
<style>
    #wrap {
        position: relative;
        width: 300px;
        height: 300px;
        border: 1px solid black;
    }

    #box {
        width: 100px;
        height: 100px;
        background-color: green;
        position: absolute;
        top: 100px;
        left: 80px;
        offset-position: auto;
        offset-anchor: center;
        offset-path: ray(45deg);
    }
</style>
<body>
    <div id="wrap">
        <div id="box"></div>
    </div>
</body>
An image of offset-position: auto
An example when auto is given to offset-position
This example shows the interaction with the transform property, and with an individual transform property (rotate). The motion path transform is a vertical translation moving (left, top) to offset-position.
<style>
    #wrap {
        transform-style: preserve-3d;
        width: 400px;
        height: 350px;
    }
    .item {
        position: absolute;
        left: 200px;
        top: 0px;
        offset-position: 200px 100px; /* translates by 0px,100px */
        offset-anchor: left top;
        transform-origin: left top;
        width: 130px;
        height: 80px;
        border-top-right-radius: 23px;
    }
    #box1 {
        background-color: tomato;
        offset-position: auto;
    }
    #box2 {
        background-color: green;
    }
    #box3 {
        background-color: navy;
        rotate: 90deg; /* applied before motion path transform */
    }
    #box4 {
        background-color: gold;
        transform: rotate(90deg); /* applied after motion path transform */
    }
</style>
<body>
    <div id="wrap">
        <div class="item" id="box1"></div>
        <div class="item" id="box2"></div>
        <div class="item" id="box3"></div>
        <div class="item" id="box4"></div>
    </div>
</body>
An example when motion path and other transforms interact
An example when motion path and other transforms interact
This example uses position static, so offset-position generates translations from the normal flow positions. By amplifying these translations using scale, the normal flow is rotated 180 degrees around the offset-position, and the boxes are exploded away from each other.
<style>
    #wrap {
        transform-style: preserve-3d;
        width: 500px;
        height: 250px;
        line-height: 0px;
    }
    span {
        position: static;
        display: inline-block;
        width: 100px;
        height: 50px;
        border-top-right-radius: 23px;
        scale: 2.5 2.5; /* applied before motion path transform */
        offset-position: center;
        transform: scale(0.4); /* applied after motion path transform */
    }
    #box1 {
        background-color: tomato;
    }
    #box2 {
        background-color: green;
    }
    #box3 {
        background-color: navy;
    }
    #box4 {
        background-color: gold;
    }
</style>
<body>
    <div id="wrap">
        <div>
            <span id="box1"></span><span id="box2"></span>
        </div>
        <div>
            <span id="box3"></span><span id="box4"></span>
        </div>
    </div>
</body>
An example when motion path and scale interact
An example when motion path and scale interact
In this example, each offset-position value is ignored as offset-path is a <geometry-box>, but the other offset properties combine to have an effect equivalent to that for offset-position 'right bottom'.
<style>
    #wrap {
        transform-style: preserve-3d;
        width: 540px;
        height: 420px;
    }
    .item {
        position: absolute;
        width: 90px;
        height: 70px;
        border-top-right-radius: 23px;
        scale: 0.8 0.8; /* applied before motion path transform */
        offset-path: padding-box;
        offset-distance: 50%;
        offset-rotate: 0deg;
        offset-anchor: right bottom;
        transform: scale(1.25); /* applied after motion path transform */
    }
    #box1 {
        background-color: tomato;
        position: static;
        offset-position: auto; /* ignored */
    }
    #box2 {
        background-color: green;
        right: 0px;
        top: 0px;
        offset-position: 23% 45%; /* ignored */
    }
    #box3 {
        background-color: navy;
        left: 0px;
        bottom: 0px;
        offset-position: 34% 56px; /* ignored */
    }
    #box4 {
        background-color: gold;
        right: 0px;
        bottom: 0px;
        offset-position: 45px 67px; /* ignored */
    }
</style>
<body>
    <div id="wrap">
        <div class="item" id="box1"></div>
        <div class="item" id="box2"></div>
        <div class="item" id="box3"></div>
        <div class="item" id="box4"></div>
    </div>
</body>
An example when offset-position is ignored
An example when offset-position is ignored

2.4. The Element’s Anchor Point: the offset-anchor property

Name: offset-anchor
Value: auto | <position>
Initial: auto
Applies to: transformable elements
Inherited: no
Percentages: relative to the width and the height of the element’s reference box
Computed value: the auto keyword or a computed <position>
Canonical order: per grammar
Animation type: by computed value
Media: visual

Defines the element’s offset anchor pointthe point that is aligned with the offset position along the offset path.

Values have the following meanings:

auto

The anchor point is the same as the point indicated by transform-origin.

Specifically, the computed value of transform-origin is resolved as a <position> against the element’s reference box.

<position>

The anchor point is the result of resolving the <position> against the element’s reference box.

Tests

Which box this is resolved against is being discussed in Issue 503.

The following explains how to set the anchor point of the box.
#plane {
    offset-anchor: center;
}

The red dot in the middle of the shape indicates the anchor point of the shape.

Shape with its anchor point
A red dot in the middle of a plane shape indicates the shape’s anchor point.
This example shows an alignment of four boxes with different anchor points.
<style>
    body {
        transform-style: preserve-3d;
        width: 300px;
        height: 300px;
        border: 2px solid gray;
        border-radius: 50%;
    }
    .box {
        width: 50px;
        height: 50px;
        background-color: orange;
        offset-position: 50% 50%;
        offset-distance: 100%;
        offset-rotate: 0deg;
    }
    #item1 {
        offset-path: ray(45deg closest-side);
        offset-anchor: right top;
    }
    #item2 {
        offset-path: ray(135deg closest-side);
        offset-anchor: right bottom;
    }
    #item3 {
        offset-path: ray(225deg closest-side);
        offset-anchor: left bottom;
    }
    #item4 {
        offset-path: ray(315deg closest-side);
        offset-anchor: left top;
    }
</style>
<body>
    <div class="box" id="item1"></div>
    <div class="box" id="item2"></div>
    <div class="box" id="item3"></div>
    <div class="box" id="item4"></div>
</body>
An example of offset-anchor
An example of offset-anchor
This example shows boxes centered at their offset-position.
<style>
    body {
        width: 500px;
        height: 500px;
    }
    .box {
        background-color: mediumpurple;
        offset-path: none;
        offset-anchor: center;
    }
    #item1 {
        offset-position: 90% 20%;
        width: 60%;
        height: 20%;
    }
    #item2 {
        offset-position: 100% 100%;
        width: 30%;
        height: 10%;
    }
    #item3 {
        offset-position: 50% 100%;
        width: 20%;
        height: 60%;
    }
    #item4 {
        offset-position: 0% 100%;
        width: 30%;
        height: 90%;
    }
</style>
<body>
    <div class="box" id="item1"></div>
    <div class="box" id="item2"></div>
    <div class="box" id="item3"></div>
    <div class="box" id="item4"></div>
</body>
An example of offset-anchor: center
An example of 'offset-anchor: center'
This example shows how offset-anchor computes to their offset-position.
<style>
    body {
        width: 500px;
        height: 500px;
    }
    .box {
        background-color: mediumpurple;
        offset-path: none;
        offset-anchor: auto;
    }
    #item1 {
        offset-position: 90% 20%;
        width: 60%;
        height: 20%;
    }
    #item2 {
        offset-position: 100% 100%;
        width: 30%;
        height: 10%;
    }
    #item3 {
        offset-position: 50% 100%;
        width: 20%;
        height: 60%;
    }
    #item4 {
        offset-position: 0% 100%;
        width: 30%;
        height: 90%;
    }
</style>
<body>
    <div class="box" id="item1"></div>
    <div class="box" id="item2"></div>
    <div class="box" id="item3"></div>
    <div class="box" id="item4"></div>
</body>
An example of offset-anchor: auto
An example of 'offset-anchor: auto'

2.5. Rotating To Match The Path: the offset-rotate property

Name: offset-rotate
Value: [ auto | reverse ] || <angle>
Initial: auto
Applies to: transformable elements
Inherited: no
Percentages: n/a
Computed value: computed <angle> value, optionally preceded by auto
Canonical order: per grammar
Animation type: by computed value
Media: visual

Defines a rotation component of the offset transform, possibly based on the direction of the offset path at the offset position. Values have the following meanings:

auto <angle>?

The offset transform will have a rotation component equal to the difference between the offset path’s direction at the offset position and the direction of the positive X axis (that is, a line going toward the right). See SVG’s direction of a path for details on how to calculate this.

If specified with an <angle>, the angle is added to the rotation component.

Note: In other words, if the offset path is moving to the right, auto doesn’t add any rotation. As it diverges from straight rightward, the rotation matches. By combining auto with an <angle>, you can adjust the "starting" rotation.

reverse <angle>?

Identical to auto, but adds an additional 180deg to the rotation.

<angle>

When specified on its own, adds a rotation component to the offset transform of the specified angle. (That is, offset-rotate: 45deg; is similar to transform: rotate(45deg); it’s just ordered to be part of the offset transform.)

Tests
The following examples use the shape of a plane. The red dot in the middle of the shape indicates the anchor point of the shape. When no offset properties are set, the shape is not translated or rotated along the path.
Path without offset
A black plane at the beginning of the path, with no offset properties set.

When the shape’s anchor point is placed at different positions along the path and offset-rotate is 0deg, the shape is not rotated.

Path without rotation
A black plane at different positions on a blue dotted path without rotation transforms.

If the offset-rotate property is set to auto, and the shape’s anchor point is placed at different positions along the path, the shape is rotated based on the gradient at the current position and faces the direction of the path at this position.

Path with auto rotation
A black plane at different positions on a blue dotted path, rotated in the direction of the path.

In this example, the offset-rotate property is set to reverse. The plane faces the opposite direction of the path at each position on the path.

Path with reverse auto rotation
A black plane at different positions on a blue dotted path, rotated in the opposite direction of the path.

The last example sets the offset-rotate property to -45deg. The shape is rotated anticlockwise by 45 degree once and keeps the rotation at each position on the path.

Path with fixed rotation
A black plane at different positions on a blue dotted path, rotated by a fixed amount of degree.
This example shows how auto or reverse work when specified in combination with <angle>. The computed value of <angle> is added to the computed value of auto or reverse.
<style>
    body {
        width: 300px;
        height: 300px;
        margin: 0px;
        border: solid gray;
        border-radius: 50%;
    }
    .circle {
        offset-position: 150px 150px;
        offset-distance: 86%;
        width: 42px;
        height: 42px;
        background-color: mediumpurple;
        border-radius: 50%;
        display: flex;
        align-items: center;
        justify-content: center;
    }
    #item1 {
        offset-path: ray(0deg closest-side);
        offset-rotate: auto 90deg;
    }
    #item2 {
        offset-path: ray(45deg closest-side);
        offset-rotate: auto 90deg;
    }
    #item3 {
        offset-path: ray(135deg closest-side);
        offset-rotate: auto -90deg;
    }
    #item4 {
        offset-path: ray(180deg closest-side);
        offset-rotate: auto -90deg;
    }
    #item5 {
        offset-path: ray(225deg closest-side);
        offset-rotate: reverse 90deg;
    }
    #item6 {
        offset-path: ray(-45deg closest-side);
        offset-rotate: reverse -90deg;
    }
</style>
<body>
    <div class="circle" id="item1">1</div>
    <div class="circle" id="item2">2</div>
    <div class="circle" id="item3">3</div>
    <div class="circle" id="item4">4</div>
    <div class="circle" id="item5">5</div>
    <div class="circle" id="item6">6</div>
</body>
An image of example for offset-rotate
The boxes are rotated by the value of auto with a fixed amount of degree.

2.6. The offset Shorthand

Name: offset
Value: [ <'offset-position'>? [ <'offset-path'> [ <'offset-distance'> || <'offset-rotate'> ]? ]? ]! [ / <'offset-anchor'> ]?
Initial: see individual properties
Applies to: transformable elements
Inherited: see individual properties
Percentages: see individual properties
Computed value: see individual properties
Animation type: see individual properties
Canonical order: per grammar
Tests

This is a shorthand property for setting offset-position, offset-path, offset-distance, offset-rotate and offset-anchor. Omitted values are set to their initial values.

2.7. Calculating The Offset Transform

The offset transform is a 2d transform, a translation followed by a rotation:

3. Equivalent Paths For <basic-shape>

The <basic-shape> definition given by [css-shapes] defines each function as producing a shapea 2-dimensional figure with an outline, an inside, and an outside.

This specification instead uses <basic-shape> as producing a patha line with a starting point, ending point, and direction, that happens to trace out a particular shape’s outline. The details of what makes up a path are defined by SVG. [SVG2]

The equivalent path for all the <basic-shape> values are:

<path()>
<shape()>

The path is the defined path. [SVG11]

<circle()>
<ellipse()>

The path is the outline of the circle/ellipse. It starts at the rightmost point of the circle/ellipse, and then is composed of four circular arcs, each comprising a quarter of the circle/ellipse, proceeding clockwise, ending with a segment-completing close path operation.

rect()
inset()
xywh()

The path is the outline of the (possibly-rounded) rectangle, composed of four or eight segments (depending on whether rounded corners are specified or not), and ending with a segment-completing close path operation. It starts at the left end of the top straight edge, immediately to the right of any rounded corners, and continues to the right (clockwise).

<polygon()>

The path is the outline of the polygon, composed of straight line segments connecting each coordinate pair to the following coordinate pair, and finally connecting the last back to the first, with a segment-completing close path operation.

For all of these, the direction at any point along the path is defined by SVG; see SVG 2 § 9.4 Path directionality.

Note: All of these are meant to match the "equivalent paths" defined for the similar SVG shape elements.

Note: This list should be in sync with the full set of <basic-shape> functions defined in [css-shapes]. If anything is missing, this should be considered a specification bug. This list might move to Shapes in the future, but for now is kept here as this spec is the only consumer of this information.

4. Privacy Considerations

This specification introduces no new privacy considerations.

5. Security Considerations

This specification introduces no new security considerations.

Changes

This section is non-normative.

Changes since the 18 December 2018 Working Draft

Changes since the 9 April 2015 First Public Working Draft

Acknowledgments

Thanks to fantasai, Hyojin Song, and all the rest of the CSS WG members for their reviews, comments, and corrections.

Conformance

Document conventions

Conformance requirements are expressed with a combination of descriptive assertions and RFC 2119 terminology. The key words “MUST”, “MUST NOT”, “REQUIRED”, “SHALL”, “SHALL NOT”, “SHOULD”, “SHOULD NOT”, “RECOMMENDED”, “MAY”, and “OPTIONAL” in the normative parts of this document are to be interpreted as described in RFC 2119. However, for readability, these words do not appear in all uppercase letters in this specification.

All of the text of this specification is normative except sections explicitly marked as non-normative, examples, and notes. [RFC2119]

Examples in this specification are introduced with the words “for example” or are set apart from the normative text with class="example", like this:

This is an example of an informative example.

Informative notes begin with the word “Note” and are set apart from the normative text with class="note", like this:

Note, this is an informative note.

Advisements are normative sections styled to evoke special attention and are set apart from other normative text with <strong class="advisement">, like this: UAs MUST provide an accessible alternative.

Tests

Tests relating to the content of this specification may be documented in “Tests” blocks like this one. Any such block is non-normative.


Conformance classes

Conformance to this specification is defined for three conformance classes:

style sheet
A CSS style sheet.
renderer
A UA that interprets the semantics of a style sheet and renders documents that use them.
authoring tool
A UA that writes a style sheet.

A style sheet is conformant to this specification if all of its statements that use syntax defined in this module are valid according to the generic CSS grammar and the individual grammars of each feature defined in this module.

A renderer is conformant to this specification if, in addition to interpreting the style sheet as defined by the appropriate specifications, it supports all the features defined by this specification by parsing them correctly and rendering the document accordingly. However, the inability of a UA to correctly render a document due to limitations of the device does not make the UA non-conformant. (For example, a UA is not required to render color on a monochrome monitor.)

An authoring tool is conformant to this specification if it writes style sheets that are syntactically correct according to the generic CSS grammar and the individual grammars of each feature in this module, and meet all other conformance requirements of style sheets as described in this module.

Partial implementations

So that authors can exploit the forward-compatible parsing rules to assign fallback values, CSS renderers must treat as invalid (and ignore as appropriate) any at-rules, properties, property values, keywords, and other syntactic constructs for which they have no usable level of support. In particular, user agents must not selectively ignore unsupported component values and honor supported values in a single multi-value property declaration: if any value is considered invalid (as unsupported values must be), CSS requires that the entire declaration be ignored.

Implementations of Unstable and Proprietary Features

To avoid clashes with future stable CSS features, the CSSWG recommends following best practices for the implementation of unstable features and proprietary extensions to CSS.

Non-experimental implementations

Once a specification reaches the Candidate Recommendation stage, non-experimental implementations are possible, and implementors should release an unprefixed implementation of any CR-level feature they can demonstrate to be correctly implemented according to spec.

To establish and maintain the interoperability of CSS across implementations, the CSS Working Group requests that non-experimental CSS renderers submit an implementation report (and, if necessary, the testcases used for that implementation report) to the W3C before releasing an unprefixed implementation of any CSS features. Testcases submitted to W3C are subject to review and correction by the CSS Working Group.

Further information on submitting testcases and implementation reports can be found from on the CSS Working Group’s website at https://www.w3.org/Style/CSS/Test/. Questions should be directed to the [email protected] mailing list.

Index

Terms defined by this specification

Terms defined by reference

References

Normative References

[CSS-BACKGROUNDS-3]
Elika Etemad; Brad Kemper. CSS Backgrounds and Borders Module Level 3. 11 March 2024. CR. URL: https://www.w3.org/TR/css-backgrounds-3/
[CSS-BOX-3]
Elika Etemad. CSS Box Model Module Level 3. 11 April 2024. REC. URL: https://www.w3.org/TR/css-box-3/
[CSS-BOX-4]
Elika Etemad. CSS Box Model Module Level 4. 4 August 2024. WD. URL: https://www.w3.org/TR/css-box-4/
[CSS-CASCADE-5]
Elika Etemad; Miriam Suzanne; Tab Atkins Jr.. CSS Cascading and Inheritance Level 5. 13 January 2022. CR. URL: https://www.w3.org/TR/css-cascade-5/
[CSS-CONTAIN-2]
Tab Atkins Jr.; Florian Rivoal; Vladimir Levin. CSS Containment Module Level 2. 17 September 2022. WD. URL: https://www.w3.org/TR/css-contain-2/
[CSS-DISPLAY-3]
Elika Etemad; Tab Atkins Jr.. CSS Display Module Level 3. 30 March 2023. CR. URL: https://www.w3.org/TR/css-display-3/
[CSS-IMAGES-4]
Tab Atkins Jr.; Elika Etemad; Lea Verou. CSS Images Module Level 4. 17 February 2023. WD. URL: https://www.w3.org/TR/css-images-4/
[CSS-SHAPES]
Rossen Atanassov; Alan Stearns. CSS Shapes Module Level 1. 15 November 2022. CR. URL: https://www.w3.org/TR/css-shapes-1/
[CSS-SHAPES-2]
CSS Shapes Module Level 2. Editor's Draft. URL: https://drafts.csswg.org/css-shapes-2/
[CSS-TRANSFORMS-1]
Simon Fraser; et al. CSS Transforms Module Level 1. 14 February 2019. CR. URL: https://www.w3.org/TR/css-transforms-1/
[CSS-TRANSFORMS-2]
Tab Atkins Jr.; et al. CSS Transforms Module Level 2. 9 November 2021. WD. URL: https://www.w3.org/TR/css-transforms-2/
[CSS-VALUES-4]
Tab Atkins Jr.; Elika Etemad. CSS Values and Units Module Level 4. 12 March 2024. WD. URL: https://www.w3.org/TR/css-values-4/
[CSS-VALUES-5]
Tab Atkins Jr.; Elika Etemad; Miriam Suzanne. CSS Values and Units Module Level 5. 17 September 2024. WD. URL: https://www.w3.org/TR/css-values-5/
[CSS21]
Bert Bos; et al. Cascading Style Sheets Level 2 Revision 1 (CSS 2.1) Specification. 7 June 2011. REC. URL: https://www.w3.org/TR/CSS21/
[CSS3VAL]
Tab Atkins Jr.; Elika Etemad. CSS Values and Units Module Level 3. 22 March 2024. CR. URL: https://www.w3.org/TR/css-values-3/
[RFC2119]
S. Bradner. Key words for use in RFCs to Indicate Requirement Levels. March 1997. Best Current Practice. URL: https://datatracker.ietf.org/doc/html/rfc2119
[SVG11]
Erik Dahlström; et al. Scalable Vector Graphics (SVG) 1.1 (Second Edition). 16 August 2011. REC. URL: https://www.w3.org/TR/SVG11/
[SVG2]
Amelia Bellamy-Royds; et al. Scalable Vector Graphics (SVG) 2. 4 October 2018. CR. URL: https://www.w3.org/TR/SVG2/

Informative References

[CSS-MASKING-1]
Dirk Schulze; Brian Birtles; Tab Atkins Jr.. CSS Masking Module Level 1. 5 August 2021. CR. URL: https://www.w3.org/TR/css-masking-1/
[CSS-POSITION-3]
Elika Etemad; Tab Atkins Jr.. CSS Positioned Layout Module Level 3. 10 August 2024. WD. URL: https://www.w3.org/TR/css-position-3/
[CSS-ROUND-DISPLAY-1]
Jihye Hong. CSS Round Display Level 1. 22 December 2016. WD. URL: https://www.w3.org/TR/css-round-display-1/
[MOTION-1]
Dirk Schulze; et al. Motion Path Module Level 1. 18 December 2018. WD. URL: https://www.w3.org/TR/motion-1/

Property Index

Name Value Initial Applies to Inh. %ages Anim­ation type Canonical order Com­puted value Media
offset [ <'offset-position'>? [ <'offset-path'> [ <'offset-distance'> || <'offset-rotate'> ]? ]? ]! [ / <'offset-anchor'> ]? see individual properties transformable elements see individual properties see individual properties see individual properties per grammar see individual properties
offset-anchor auto | <position> auto transformable elements no relative to the width and the height of the element’s reference box by computed value per grammar the auto keyword or a computed <position> visual
offset-distance <length-percentage> 0 transformable elements no relative to the offset path length by computed value per grammar a computed <length-percentage> value visual
offset-path none | <offset-path> || <coord-box> none transformable elements no n/a by computed value per grammar as specified visual
offset-position normal | auto | <position> normal transformable elements no Refer to the size of containing block by computed value per grammar The normal or auto keywords, or a computed <position> visual
offset-rotate [ auto | reverse ] || <angle> auto transformable elements no n/a by computed value per grammar computed <angle> value, optionally preceded by auto visual

Issues Index

all of these examples need to be rewritten.
Which box this is resolved against is being discussed in Issue 503.