<p>React ScrollTop gets displayed after a certain scroll position and used to navigates to the top of the page quickly.</p>
<h3 id="setup">Setup</h3>
<p>Refer to PrimeReact <a target="_blank" href="https://primefaces.org/primereact/showcase/#/setup">setup documentation</a> for download and installation steps for your environment.</p>
<h3 id="import">Import</h3>
<pre><code class="lang-js"><span class="hljs-keyword">import</span> { ScrollTop } <span class="hljs-keyword">from</span> <span class="hljs-string">'primereact/scrolltop'</span>;
</code></pre>
<h3 id="getting-started">Getting Started</h3>
<p>Without any configuration, ScrollTop listens window scroll.</p>
<pre><code class="lang-html"><span class="hljs-tag">&lt;<span class="hljs-name">ScrollTop</span> /&gt;</span>
</code></pre>
<p>Threshold</p>
<p>When the vertical scroll position reaches a certain value, ScrollTop gets displayed. This value is defined with the <strong>threshold</strong> property that defaults to 400.</p>
<pre><code class="lang-html"><span class="hljs-tag">&lt;<span class="hljs-name">ScrollTop</span> <span class="hljs-attr">threshold</span>=<span class="hljs-string">{200}</span> /&gt;</span>
</code></pre>
<h3 id="target-element">Target Element</h3>
<p>ScrollTop can also be assigned to its parent element by setting <strong>target</strong> as "parent".</p>
<pre><code class="lang-html"><span class="hljs-tag">&lt;<span class="hljs-name">div</span> <span class="hljs-attr">style</span>=<span class="hljs-string">{{height:</span> '<span class="hljs-attr">400px</span>', <span class="hljs-attr">overflow:</span> '<span class="hljs-attr">auto</span>'}}&gt;</span>
    Content that overflows to container
    <span class="hljs-tag">&lt;<span class="hljs-name">ScrollTop</span> /&gt;</span>
<span class="hljs-tag">&lt;/<span class="hljs-name">div</span>&gt;</span>
</code></pre>
<h3 id="theming">Theming</h3>
<p>ScrollTop supports various themes featuring Material, Bootstrap, Fluent as well as your own custom themes via the <a target="_blank" href="https://primefaces.org/primereact/showcase/#/theming">Designer</a> tool.</p>
<h3 id="resources">Resources</h3>
<p>Visit the PrimeReact <a target="_blank" href="https://primefaces.org/primereact/showcase/#/scrolltop">ScrollTop</a> showcase for demos and documentation.</p>


React ScrollTop gets displayed after a certain scroll position and used to navigates to the top of the page quickly.

### Setup

Refer to PrimeReact [setup documentation](https://primefaces.org/primereact/showcase/#/setup) for download and installation steps for your environment.

### Import
```js
import { ScrollTop } from 'primereact/scrolltop';
```

### Getting Started

Without any configuration, ScrollTop listens window scroll.

```html
<ScrollTop />
```

Threshold

When the vertical scroll position reaches a certain value, ScrollTop gets displayed. This value is defined with the **threshold** property that defaults to 400.

```html
<ScrollTop threshold={200} />
```

### Target Element

ScrollTop can also be assigned to its parent element by setting **target** as "parent".

```html
<div style={{height: '400px', overflow: 'auto'}}>
    Content that overflows to container
    <ScrollTop />
</div>
```

### Theming

ScrollTop supports various themes featuring Material, Bootstrap, Fluent as well as your own custom themes via the [Designer](https://primefaces.org/primereact/showcase/#/theming) tool.

### Resources

Visit the PrimeReact [ScrollTop](https://primefaces.org/primereact/showcase/#/scrolltop) showcase for demos and documentation.
