intercooler/www/attributes/ic-disable-when-doc-hidden.html

Making AJAX as easy as anchor tags

---
layout: default
nav: attributes > ic-disable-when-doc-hidden
---

<div class="container">

  <div class="row">
    <div class="col-md-12">

      <h2><code>ic-disable-when-doc-hidden</code> - Disable When Document Hidden Attribute</h2>

      <h3>Summary</h3>

      <p>The <code>ic-disable-when-doc-hidden</code> attribute tells Intercooler to not to issue a given request if the
        document is currently hidden, as determined by the <code>document.hidden</code> property.  This allows you to
      pause polling, for example, when a document is in an inactive tab, or the screen saver is running.</p>

      <h3>Syntax</h3>

      <p>The value of the attribute should be <code>true</code> or <code>false</code></p>

      <h3>Dependencies</h3>

      <p><code>ic-disable-when-doc-hidden</code> has no dependency implications.</p>

    </div>
  </div>
</div>