HTMLIFrameElement.clearMatch()

Warning: Removed in Firefox 65.

The clearMatch() method of the HTMLIFrameElement clears any content highlighted by findAll() or findNext().

Invoking this method results in a mozbrowserfindchange event firing, which carries details about the search results.

Note: Use of the Browser API requires a privileged app, and browser and/or embed-apps permissions, depending on what you want to do. See Using the Browser API for more details.

Syntax

instanceOfHTMLIframeElement.clearMatch();

Returns

Void.

Parameters

None.

Examples

The following function is taken from our Browser API demo, and (amongst other things) clears the search results when the search bar is hidden, if an existing search is active. See Implementing the search bar for more explanation.

searchToggle.addEventListener('touchend',function() {
  if(search.getAttribute('class') === 'search') {
    search.setAttribute('class', 'search shifted');
  } else if(search.getAttribute('class') === 'search shifted') {
    search.setAttribute('class', 'search');
    if(searchActive) {
      browser.clearMatch();
      searchActive = false;
      prev.disabled = true;
      next.disabled = true;
      searchBar.value = '';
    }
  }
});

Specification

Not part of any specification.

Browser compatibility

Supported since Firefox 47, in chrome code only. Removed completely in Firefox 65.

Unlikely ever to be supported in other browsers.

See also

Document Tags and Contributors

Contributors to this page: chrisdavidmills, fscholz, Sebastianz
Last updated by: chrisdavidmills,