MDN self-hosted library · e01.org

SVGAElement: search property

SVG

no runnable cells web-api-instance-property upstream source

SVG

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 live-sample___svgaelement-search Search for SVG


```html hidden live-sample___svgaelement-search
<pre id="log"></pre>

```css hidden live-sample___svgaelement-search svg { width: 200px; height: 30px; } svg a text { fill: blue; text-decoration: underline; }

log {

padding: 0.5rem; border: 1px solid black; }


```js hidden live-sample___svgaelement-search
const logElement = document.querySelector("#log");
function log(text) {
  logElement.innerText = `${logElement.innerText}${text}\n`;
}

We can read the query string of the link:

```js live-sample___svgaelement-search const link = document.getElementById("link");

log(search: "${link.search}"); // search: "?q=svg"


100%

### Advanced parsing using URLSearchParams

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

```html live-sample___svgaelement-search-params
<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>

```html hidden live-sample___svgaelement-search-params




```css hidden live-sample___svgaelement-search-params
svg {
  width: 200px;
  height: 30px;
}
svg a text {
  fill: blue;
  text-decoration: underline;
}
#log {
  padding: 0.5rem;
  border: 1px solid black;
}

``js hidden live-sample___svgaelement-search-params const logElement = document.querySelector("#log"); function log(text) { logElement.innerText =${logElement.innerText}${text}\n`; }


```js live-sample___svgaelement-search-params
const link = document.getElementById("link");
const params = new URLSearchParams(link.search);

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

100%

Specifications

Browser compatibility

See also

  • SVG a element
  • HTMLAnchorElement.search