Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
182 changes: 182 additions & 0 deletions files/en-us/web/css/reference/properties/path-length/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,182 @@
---
title: "`path-length` CSS property"
short-title: path-length
slug: Web/CSS/Reference/Properties/path-length
page-type: css-property
browser-compat: css.properties.path-length
sidebar: cssref
---

The **`path-length`** [CSS](/en-US/docs/Web/CSS) property specifies a total path length, in user units. This value is then used to calibrate the browser's distance calculations with those of the author, by scaling all distance computations using the ratio path-length / _(computed value of path length)_.

This can affect the browser's distance-along-a-path calculations and therefore the actual rendered lengths of paths — this includes text paths, animation paths, and various stroke operations.

If present, the `path-length` CSS property overrides an SVG element's {{SVGAttr("pathLength")}} attribute.

> [!NOTE]
> The `path-length` property only applies to {{SVGElement("circle")}}, {{SVGElement("ellipse")}}, {{SVGElement("line")}}, {{SVGElement("path")}}, {{SVGElement("polygon")}}, {{SVGElement("polyline")}}, and {{SVGElement("rect")}} elements nested in an {{SVGElement("svg")}}. It doesn't apply to other SVG, HTML, or pseudo-elements.

## Syntax

```css
/* Keywords */
path-length: none;

/* <length> values */
path-length: 0;
path-length: 70;
path-length: 500;

/* Global values */
path-length: inherit;
path-length: initial;
path-length: revert;
path-length: revert-layer;
path-length: unset;
```

### Values

- `none`
- : No author path length is specified and the user agent's own computed path length is used for all path-related calculations.

- `<length>`
- : A non-negative unitless value representing an author-defined total path length, in user units.

## Formal definition

{{CSSInfo}}

## Formal syntax

{{csssyntax}}

## Examples

### Basic usage

This example defines a path and shows how to apply a path length to it using the `path-length` CSS property.

#### SVG

Our SVG defines a single curved {{SVGElement("path")}} element with a colored {{SVGAttr("stroke")}}. It includes a {{SVGAttr("stroke-dasharray")}} attribute that defines a regular dashed pattern for the stroke.

```html live-sample___basic-path-length live-sample___path-length-animation
<svg viewBox="0 0 600 200">
<path
d="M 30 100 C 150 20, 250 180, 380 100 S 520 20, 570 100"
fill="none"
stroke="#D85A30"
stroke-width="4"
stroke-dasharray="24 24"></path>
</svg>
```

#### CSS

We set a `path-length` value on the `<path>`:

```css live-sample___basic-path-length
path {
path-length: 500;
}
```

#### Results

{{EmbedLiveSample("basic-path-length", "100%", "230")}}

Setting a large `path-length` value results in the dashes becoming smaller and more frequent.

### Animating `path-length`

One major advantage of making `path-length` available as a CSS property is that you can apply standard CSS functionality such as [animations](/en-US/docs/Web/CSS/Guides/Animations) and [transitions](/en-US/docs/Web/CSS/Guides/Transitions) to it. This example builds on the previous one, showing how to animate a `path-length` with a CSS animation.

#### HTML and SVG

This example includes the same SVG `<path>` as the previous one. In addition, it includes an [`<input type="range">`](/en-US/docs/Web/HTML/Reference/Elements/input/range) element that can be used to change the value of `path-length` applied to the `<path>` at runtime. We also include an {{htmlelement("output")}} element to display the current slider value.

```html live-sample___path-length-animation
<div>
<label for="path-slider">Adjust path-length</label>
<input type="range" min="0" max="800" value="200" />
<output>200</output>
</div>
```

#### CSS

On the {{cssxref(":root")}} element, we define a [CSS custom property](/en-US/docs/Web/CSS/Reference/Properties/--*) called `--path-length` and give it an initial value of `200`. We then set the `<path>` element's `path-length` value to the `--path-length` property, and set an {{cssxref("animation")}} on it that runs an infinite number of times and alternates between forwards and backwards.

```css live-sample___path-length-animation
:root {
--path-length: 200;
}

path {
path-length: var(--path-length);
animation: path-length-anim 2s alternate infinite ease-in-out;
}
```

```css hidden live-sample___path-length-animation
div {
position: fixed;
bottom: 0;
left: 0;
display: flex;
align-items: center;
}
```

Next, we define the {{cssxref("@keyframes")}} block for the animation — it animates the `path-length` property between the `--path-length` value and the `--path-length` value multiplied by `1.5`.

```css live-sample___path-length-animation
@keyframes path-length-anim {
from {
path-length: var(--path-length);
}

to {
path-length: calc(var(--path-length) * 1.5);
}
}
```

#### JavaScript

We start our script by grabbing references to the `<input type="range">`, `<output>`, and `:root` elements.

```js live-sample___path-length-animation
const slider = document.querySelector("input");
const output = document.querySelector("output");
const rootElem = document.querySelector(":root");
```

Next, we add an `input` event handler to the range slider so that, when its value is changed, the `<output>` element's `textContent` and the value of the `--path-length` custom property are set to equal the slider's new value.

```js live-sample___path-length-animation
slider.addEventListener("input", () => {
output.textContent = slider.value;
rootElem.style.setProperty("--path-length", slider.value);
});
```

#### Results

{{EmbedLiveSample("path-length-animation", "100%", "230")}}

Adjust the slider, and note how larger values rules in a smaller dash size.

## Specifications

{{Specifications}}

## Browser compatibility

{{Compat}}

## See also

- SVG {{SVGAttr("pathLength")}} attribute
- Presentation properties: {{cssxref("fill")}}, {{cssxref("clip-rule")}}, {{cssxref("color-interpolation-filters")}}, {{cssxref("fill-opacity")}}, {{cssxref("fill-rule")}}, {{cssxref("marker-end")}}, {{cssxref("marker-mid")}}, {{cssxref("marker-start")}}, `path-length`, {{cssxref("shape-rendering")}}, {{cssxref("stop-color")}}, {{cssxref("stop-opacity")}}, {{cssxref("stroke")}}, {{cssxref("stroke-dasharray")}}, {{cssxref("stroke-dashoffset")}}, {{cssxref("stroke-linecap")}}, {{cssxref("stroke-linejoin")}}, {{cssxref("stroke-miterlimit")}}, {{cssxref("stroke-opacity")}}, {{cssxref("stroke-width")}}, {{cssxref("text-anchor")}}, and {{cssxref("vector-effect")}}
1 change: 1 addition & 0 deletions files/en-us/web/svg/reference/attribute/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -378,6 +378,7 @@ Most presentation attributes inherit when used as CSS properties (for example, {
- {{SVGAttr("mask-type")}}
- {{SVGAttr("opacity")}}
- {{SVGAttr("overflow")}}
- {{SVGAttr("pathLength")}}
- {{SVGAttr("pointer-events")}}
- {{SVGAttr("r")}}
- {{SVGAttr("rx")}}
Expand Down
7 changes: 7 additions & 0 deletions files/en-us/web/svg/reference/attribute/pathlength/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,9 @@ You can use this attribute with the following SVG elements:
- {{SVGElement('polyline')}}
- {{SVGElement('rect')}}

> [!NOTE]
> The `pathLength` attribute also has a CSS property counterpart: [`path-length`](/en-US/docs/Web/CSS/Reference/Properties/path-length). When both are specified, the CSS property takes priority.

## Example

```css hidden
Expand Down Expand Up @@ -238,3 +241,7 @@ For {{SVGElement('rect')}}, `pathLength` lets authors specify a total length for
## Specifications

{{Specifications}}

## See also

- [`path-length`](/en-US/docs/Web/CSS/Reference/Properties/path-length) CSS property