<use>
Baseline Widely available *
This feature is well established and works across many devices and browser versions. It’s been available across browsers since July 2015.
* Some parts of this feature may have varying levels of support.
The <use>
element takes nodes from within an SVG document, and duplicates them somewhere else.
The effect is the same as if the nodes were deeply cloned into a non-exposed DOM, then pasted where the <use>
element is, much like cloned <template>
elements.
Usage context
Categories | Graphics element, Graphics referencing element, Structural element |
---|---|
Permitted content | Any number of the following elements, in any order: Animation elements Descriptive elements |
Attributes
href
-
The URL to an element/fragment that needs to be duplicated. See Usage notes for details on common pitfalls.
Value type:<URL>
; Default value: none; Animatable: yes xlink:href
Deprecated-
An
<IRI>
reference to an element/fragment that needs to be duplicated. If bothhref
andxlink:href
are present, the value given byhref
is used.
Value type:<IRI>
; Default value: none; Animatable: yesWarning: Since SVG 2, the
xlink:href
attribute is deprecated in favor ofhref
. Seexlink:href
page for more information. x
-
The x coordinate of an additional final offset transformation applied to the
<use>
element.
Value type:<coordinate>
; Default value:0
; Animatable: yes y
-
The y coordinate of an additional final offset transformation applied to the
<use>
element.
Value type:<coordinate>
; Default value:0
; Animatable: yes width
-
The width of the
<use>
element.
Value type:<length>
; Default value:0
; Animatable: yes height
-
The height of the
<use>
element.
Value type:<length>
; Default value:0
; Animatable: yes
Note: width
, and height
have no effect on <use>
elements, unless the element referenced has a viewBox - i.e., they only have an effect when <use>
refers to a <svg>
or <symbol>
element.
Note:
Starting with SVG2, x
, y
, width
, and height
are Geometry Properties, meaning those attributes can also be used as CSS properties for that element.
DOM Interface
This element implements the SVGUseElement
interface.
Example
The following example shows how to use the <use>
element to draw a circle with a different fill and stroke color.
In the last circle, stroke="red"
will be ignored because stroke was already set on myCircle
.
<svg viewBox="0 0 30 10" xmlns="http://www.w3.org/2000/svg">
<circle id="myCircle" cx="5" cy="5" r="4" stroke="blue" />
<use href="#myCircle" x="10" fill="blue" />
<use href="#myCircle" x="20" fill="white" stroke="red" />
</svg>
Usage notes
Most attributes on <use>
are ignored if the corresponding attribute is already defined on the element referenced by <use>
. (This differs from how CSS style attributes override those set 'earlier' in the cascade).
Only the attributes x
, y
, width
, height
and href
on the <use>
element will or may have some effect, described later, if the referenced element has already defined the corresponding attribute. However, any other attributes not set on the referenced element will be applied to the <use>
element.
Since the cloned nodes are not exposed, care must be taken when using CSS to style a <use>
element and its cloned descendants. CSS properties are not guaranteed to be inherited by the cloned DOM unless you explicitly request them using CSS inheritance.
For security reasons, browsers may apply the same-origin policy on <use>
elements and may refuse to load a cross-origin URL in the href
attribute. There is currently no defined way to set a cross-origin policy for <use>
elements.
Loading resources from external files via <use>
You can load nodes from an external SVG file via the <use>
element by specifying the path of the file followed by a URL fragment pointing to the id
of the node to load:
<svg>
<use href="../assets/my-svg.svg#my-fragment"></use>
</svg>
Historically, the URL fragment was always required, even if you just wanted to load the entire SVG document. In such a case, the id
would be included on the SVG root element:
<svg xmlns="http://www.w3.org/2000/svg" id="my-fragment">
<circle cx="150" cy="100" r="80" fill="green" />
</svg>
However, modern implementations have been updated so that if you want to load the entire external document, you can refer to it without a URL fragment (and the id
is no longer needed on the SVG document root element):
<svg>
<use href="../assets/my-svg.svg"></use>
</svg>
Check the Browser compatibility table for browser support.
Loading resources from data URIs via <use>
Loading resources with data URIs in the href
attribute is deprecated for security reasons. This applies to <use href="data:...
and also when setting href
by using the set
or setAttribute
method.
Again, check the Browser compatibility table for browser support.
Specifications
Specification |
---|
Scalable Vector Graphics (SVG) 2 # UseElement |