HTMLAreaElement: search property

فهرست فصل‌ها دانلود آرشیوناشر

MDN Web Docs · نسخهٔ df622a2a1c1e · CC BY-SA 2.5 و مجوز جداگانهٔ ناشر برای نمونه‌کد

{{ApiRef("HTML DOM")}}

The **search** property of the {{domxref("HTMLAreaElement")}} interface is a search string, also called a _query string_, that is a string containing a "?" followed by the parameters of the <area> element's href. If the URL does not have a search query, 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. Setting it to "" removes the query string.

The query is {{Glossary("Percent-encoding", "percent-encoded")}} when setting but not percent-decoded when reading.

Modern browsers provide [URLSearchParams](/en-US/docs/Web/API/URLSearchParams/get#examples) and [URL.searchParams](/en-US/docs/Web/API/URL/searchParams#examples) to make it easy to parse out the parameters from the query string.

See {{domxref("URL.search")}} for more information.

Value

A string.

Examples

Getting the search string from an area link

js
// An <area id="myArea" href="/en-US/docs/HTMLAreaElement?q=123"> element is in the document
const area = document.getElementById("myArea");
area.search; // returns '?q=123'

Advanced parsing using URLSearchParams

Alternatively, [URLSearchParams](/en-US/docs/Web/API/URLSearchParams/get#examples) can be used:

js
let params = new URLSearchParams(queryString);
let q = parseInt(params.get("q"), 10); // returns the number 123

Specifications

{{Specifications}}

Browser compatibility

{{Compat}}

See also

  • The {{domxref("HTMLAreaElement")}} interface it belongs to.