SVGAElement: search property

Experimental: This is an experimental technology
Check the Browser compatibility table carefully before using this in production.

The search property of the SVGAElement interface represents the element's query string. It is a "?" followed by the parameters of the SVG <a> element's href. If the URL does not have any parameters, this property contains an empty string, "".

This property can be set to change the query string of the URL. When setting, a single "?" prefix is added to the provided value, if not already present, and setting it to "" removes the query string. Setting it also rewrites the element's href attribute as a complete, absolute URL.

The query is percent-encoded when setting but not percent-decoded when reading.

See URL.search for more information.

Value

A string.

Examples

Given the following SVG:

html

We can read the query string of the link:

js

Advanced parsing using URLSearchParams

Alternatively, URLSearchParams can be used to read individual parameters out of the query string:

html
<svg viewBox="0 0 200 30" xmlns="http://www.w3.org/2000/svg">
  <a id="link" href="https://example.com/search?q=svg">
    <text x="0" y="20">Search for SVG</text>
  </a>
</svg>
js
const link = document.getElementById("link");
const params = new URLSearchParams(link.search);

log(`q: "${params.get("q")}"`); // q: "svg"

Specifications

Specification
Scalable Vector Graphics (SVG) 2
# InterfaceSVGAElement

Browser compatibility

See also