📄 tanstack/pacer/latest/docs/framework/solid/examples/createThrottler
File: createThrottler.md | Updated: 11/15/2025
Source: https://tanstack.com/pacer/latest/docs/framework/solid/examples/createThrottler
Search...
+ K
Auto
Docs Examples GitHub Contributors
Docs Examples GitHub Contributors
Docs Examples GitHub Contributors
Docs Examples Github Contributors
Docs Examples Github Contributors
Docs Examples Github Contributors
Docs Examples Github Contributors
Docs Examples Github Contributors
Maintainers Partners Support Learn StatsBETA Discord Merch Blog GitHub Ethos Brand Guide
Documentation
Framework
Solid
Version
Latest
Search...
+ K
Menu
Getting Started
Guides
API Reference
Debouncer API Reference
Throttler API Reference
Rate Limiter API Reference
Queue API Reference
Batcher API Reference
Debouncer Examples
Throttler Examples
Rate Limiter Examples
Queue Examples
Batcher Examples
Framework
Solid
Version
Latest
Menu
Getting Started
Guides
API Reference
Debouncer API Reference
Throttler API Reference
Rate Limiter API Reference
Queue API Reference
Batcher API Reference
Debouncer Examples
Throttler Examples
Rate Limiter Examples
Queue Examples
Batcher Examples
Solid Example: CreateThrottler
=====================================================================================================================================================================================================================================================================================================================================================================================================================================
Code ExplorerCode
Interactive SandboxSandbox
-
public
-
src
index.tsx
-
.eslintrc.cjs
-
.gitignore
-
README.md
-
index.html
-
package.json
-
tsconfig.json
-
vite.config.ts
tsx
import { createSignal } from 'solid-js'
import { render } from 'solid-js/web'
import { createThrottler } from '@tanstack/solid-pacer/throttler'
function App1() {
// Use your state management library of choice
const [instantCount, setInstantCount] = createSignal(0)
const [throttledCount, setThrottledCount] = createSignal(0)
// Lower-level createThrottler hook - requires you to manage your own state
const setCountThrottler = createThrottler(
setThrottledCount,
{
wait: 1000,
enabled: () => instantCount() > 2, // optional, defaults to true
},
// Optional Selector function to pick the state you want to track and use
(state) => ({
executionCount: state.executionCount,
}),
)
function increment() {
// this pattern helps avoid common bugs with stale closures and state
setInstantCount((c) => {
const newInstantCount = c + 1 // common new value for both
setCountThrottler.maybeExecute(newInstantCount) // throttled state update
return newInstantCount // instant state update
})
}
return (
<div>
<h1>TanStack Pacer createThrottler Example 1</h1>
<table>
<tbody>
<tr>
<td>Execution Count:</td>
<td>{setCountThrottler.state().executionCount}</td>
</tr>
<tr>
<td>Instant Count:</td>
<td>{instantCount()}</td>
</tr>
<tr>
<td>Throttled Count:</td>
<td>{throttledCount()}</td>
</tr>
</tbody>
</table>
<div>
<button onClick={increment}>Increment</button>
</div>
</div>
)
}
function App2() {
const [instantSearch, setInstantSearch] = createSignal('')
const [throttledSearch, setThrottledSearch] = createSignal('')
// Lower-level createThrottler hook - requires you to manage your own state
const setSearchThrottler = createThrottler(
setThrottledSearch,
{
wait: 1000,
// enabled: () => instantSearch().length > 2, // optional, defaults to true
},
// Optional Selector function to pick the state you want to track and use
(state) => ({
executionCount: state.executionCount,
}),
)
function handleSearchChange(e: Event) {
const target = e.target as HTMLInputElement
const newValue = target.value
setInstantSearch(newValue)
setSearchThrottler.maybeExecute(newValue)
}
return (
<div>
<h1>TanStack Pacer createThrottler Example 2</h1>
<div>
<input
autofocus
type="search"
value={instantSearch()}
onInput={handleSearchChange}
placeholder="Type to search..."
style={{ width: '100%' }}
/>
</div>
<table>
<tbody>
<tr>
<td>Execution Count:</td>
<td>{setSearchThrottler.state().executionCount}</td>
</tr>
<tr>
<td>Instant Search:</td>
<td>{instantSearch()}</td>
</tr>
<tr>
<td>Throttled Search:</td>
<td>{throttledSearch()}</td>
</tr>
</tbody>
</table>
</div>
)
}
function App3() {
const [currentValue, setCurrentValue] = createSignal(50)
const [throttledValue, setThrottledValue] = createSignal(50)
const [instantExecutionCount, setInstantExecutionCount] = createSignal(0)
// Lower-level createThrottler hook - requires you to manage your own state
const setValueThrottler = createThrottler(
setThrottledValue,
{
wait: 250,
},
// Optional Selector function to pick the state you want to track and use
(state) => ({
executionCount: state.executionCount,
}),
)
function handleRangeChange(e: Event) {
const target = e.target as HTMLInputElement
const newValue = parseInt(target.value, 10)
setCurrentValue(newValue)
setInstantExecutionCount((c) => c + 1)
setValueThrottler.maybeExecute(newValue)
}
return (
<div>
<h1>TanStack Pacer createThrottler Example 3</h1>
<div style={{ 'margin-bottom': '20px' }}>
<label>
Current Range:
<input
type="range"
min="0"
max="100"
value={currentValue()}
onInput={handleRangeChange}
style={{ width: '100%' }}
/>
<span>{currentValue()}</span>
</label>
</div>
<div style={{ 'margin-bottom': '20px' }}>
<label>
Throttled Range (Readonly):
<input
type="range"
min="0"
max="100"
value={throttledValue()}
readOnly
style={{ width: '100%' }}
/>
<span>{throttledValue()}</span>
</label>
</div>
<table>
<tbody>
<tr>
<td>Instant Executions:</td>
<td>{instantExecutionCount()}</td>
</tr>
<tr>
<td>Throttled Executions:</td>
<td>{setValueThrottler.state().executionCount}</td>
</tr>
<tr>
<td>Saved Executions:</td>
<td>
{instantExecutionCount() -
setValueThrottler.state().executionCount}
</td>
</tr>
<tr>
<td>% Reduction:</td>
<td>
{instantExecutionCount() === 0
? '0'
: Math.round(
((instantExecutionCount() -
setValueThrottler.state().executionCount) /
instantExecutionCount()) *
100,
)}
%
</td>
</tr>
</tbody>
</table>
<div style={{ color: '#666', 'font-size': '0.9em' }}>
<p>Throttled with 250ms wait time</p>
</div>
</div>
)
}
render(
() => (
<div>
<App1 />
<hr />
<App2 />
<hr />
<App3 />
</div>
),
document.getElementById('root')!,
)
import { createSignal } from 'solid-js'
import { render } from 'solid-js/web'
import { createThrottler } from '@tanstack/solid-pacer/throttler'
function App1() {
// Use your state management library of choice
const [instantCount, setInstantCount] = createSignal(0)
const [throttledCount, setThrottledCount] = createSignal(0)
// Lower-level createThrottler hook - requires you to manage your own state
const setCountThrottler = createThrottler(
setThrottledCount,
{
wait: 1000,
enabled: () => instantCount() > 2, // optional, defaults to true
},
// Optional Selector function to pick the state you want to track and use
(state) => ({
executionCount: state.executionCount,
}),
)
function increment() {
// this pattern helps avoid common bugs with stale closures and state
setInstantCount((c) => {
const newInstantCount = c + 1 // common new value for both
setCountThrottler.maybeExecute(newInstantCount) // throttled state update
return newInstantCount // instant state update
})
}
return (
<div>
<h1>TanStack Pacer createThrottler Example 1</h1>
<table>
<tbody>
<tr>
<td>Execution Count:</td>
<td>{setCountThrottler.state().executionCount}</td>
</tr>
<tr>
<td>Instant Count:</td>
<td>{instantCount()}</td>
</tr>
<tr>
<td>Throttled Count:</td>
<td>{throttledCount()}</td>
</tr>
</tbody>
</table>
<div>
<button onClick={increment}>Increment</button>
</div>
</div>
)
}
function App2() {
const [instantSearch, setInstantSearch] = createSignal('')
const [throttledSearch, setThrottledSearch] = createSignal('')
// Lower-level createThrottler hook - requires you to manage your own state
const setSearchThrottler = createThrottler(
setThrottledSearch,
{
wait: 1000,
// enabled: () => instantSearch().length > 2, // optional, defaults to true
},
// Optional Selector function to pick the state you want to track and use
(state) => ({
executionCount: state.executionCount,
}),
)
function handleSearchChange(e: Event) {
const target = e.target as HTMLInputElement
const newValue = target.value
setInstantSearch(newValue)
setSearchThrottler.maybeExecute(newValue)
}
return (
<div>
<h1>TanStack Pacer createThrottler Example 2</h1>
<div>
<input
autofocus
type="search"
value={instantSearch()}
onInput={handleSearchChange}
placeholder="Type to search..."
style={{ width: '100%' }}
/>
</div>
<table>
<tbody>
<tr>
<td>Execution Count:</td>
<td>{setSearchThrottler.state().executionCount}</td>
</tr>
<tr>
<td>Instant Search:</td>
<td>{instantSearch()}</td>
</tr>
<tr>
<td>Throttled Search:</td>
<td>{throttledSearch()}</td>
</tr>
</tbody>
</table>
</div>
)
}
function App3() {
const [currentValue, setCurrentValue] = createSignal(50)
const [throttledValue, setThrottledValue] = createSignal(50)
const [instantExecutionCount, setInstantExecutionCount] = createSignal(0)
// Lower-level createThrottler hook - requires you to manage your own state
const setValueThrottler = createThrottler(
setThrottledValue,
{
wait: 250,
},
// Optional Selector function to pick the state you want to track and use
(state) => ({
executionCount: state.executionCount,
}),
)
function handleRangeChange(e: Event) {
const target = e.target as HTMLInputElement
const newValue = parseInt(target.value, 10)
setCurrentValue(newValue)
setInstantExecutionCount((c) => c + 1)
setValueThrottler.maybeExecute(newValue)
}
return (
<div>
<h1>TanStack Pacer createThrottler Example 3</h1>
<div style={{ 'margin-bottom': '20px' }}>
<label>
Current Range:
<input
type="range"
min="0"
max="100"
value={currentValue()}
onInput={handleRangeChange}
style={{ width: '100%' }}
/>
<span>{currentValue()}</span>
</label>
</div>
<div style={{ 'margin-bottom': '20px' }}>
<label>
Throttled Range (Readonly):
<input
type="range"
min="0"
max="100"
value={throttledValue()}
readOnly
style={{ width: '100%' }}
/>
<span>{throttledValue()}</span>
</label>
</div>
<table>
<tbody>
<tr>
<td>Instant Executions:</td>
<td>{instantExecutionCount()}</td>
</tr>
<tr>
<td>Throttled Executions:</td>
<td>{setValueThrottler.state().executionCount}</td>
</tr>
<tr>
<td>Saved Executions:</td>
<td>
{instantExecutionCount() -
setValueThrottler.state().executionCount}
</td>
</tr>
<tr>
<td>% Reduction:</td>
<td>
{instantExecutionCount() === 0
? '0'
: Math.round(
((instantExecutionCount() -
setValueThrottler.state().executionCount) /
instantExecutionCount()) *
100,
)}
%
</td>
</tr>
</tbody>
</table>
<div style={{ color: '#666', 'font-size': '0.9em' }}>
<p>Throttled with 250ms wait time</p>
</div>
</div>
)
}
render(
() => (
<div>
<App1 />
<hr />
<App2 />
<hr />
<App3 />
</div>
),
document.getElementById('root')!,
)
