Octane Example: Throttle

GitHub StackBlitz CodeSandbox

import { useCallback, useState } from 'octane'
import { createRoot } from 'octane'
import { throttle } from '@tanstack/octane-pacer/throttler'

function App1() {
  // Use your state management library of choice
  const [instantCount, setInstantCount] = useState(0)
  const [throttledCount, setThrottledCount] = useState(0)

  // Create throttled setter function - Stable reference required!
  const throttledSetCount = useCallback(
    throttle(setThrottledCount, {
      wait: 1000,
    }),
    [], // must be memoized to avoid re-creating the throttler on every render (consider using useThrottler instead in react)
  )

  function increment() {
    // this pattern helps avoid common bugs with stale closures and state
    setInstantCount((c) => {
      const newInstantCount = c + 1 // common new value for both
      throttledSetCount(newInstantCount) // throttled state update
      return newInstantCount // instant state update
    })
  }

  return (
    <div>
      <h1>{'TanStack Pacer throttle Example 1'}</h1>
      <table>
        <tbody>
          <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 [text, setText] = useState('')
  const [throttledText, setThrottledText] = useState('')

  // Create throttled setter function - Stable reference required!
  const throttledSetText = useCallback(
    throttle(setThrottledText, {
      wait: 1000,
    }),
    [],
  )

  function handleTextChange(e: Event & { currentTarget: HTMLInputElement }) {
    const newValue = e.currentTarget.value
    setText(newValue)
    throttledSetText(newValue)
  }

  return (
    <div>
      <h1>{'TanStack Pacer throttle Example 2'}</h1>
      <div>
        <input
          autoFocus
          type="search"
          value={text}
          onInput={handleTextChange}
          placeholder="Type text (throttled to 1 update per second)..."
          style={{ width: '100%' }}
        />
      </div>
      <table>
        <tbody>
          <tr>
            <td>{'Instant Text:'}</td>
            <td>{text}</td>
          </tr>
          <tr>
            <td>{'Throttled Text:'}</td>
            <td>{throttledText}</td>
          </tr>
        </tbody>
      </table>
    </div>
  )
}

function App3() {
  const [currentValue, setCurrentValue] = useState(50)
  const [throttledValue, setThrottledValue] = useState(50)
  const [instantExecutionCount, setInstantExecutionCount] = useState(0)

  // Create throttled setter function - Stable reference required!
  const throttledSetValue = useCallback(
    throttle(setThrottledValue, {
      wait: 250,
    }),
    [],
  )

  function handleRangeChange(e: Event & { currentTarget: HTMLInputElement }) {
    const newValue = parseInt(e.currentTarget.value, 10)
    setCurrentValue(newValue)
    setInstantExecutionCount((c) => c + 1)
    throttledSetValue(newValue)
  }

  return (
    <div>
      <h1>{'TanStack Pacer throttle Example 3'}</h1>
      <div style={{ marginBottom: '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={{ marginBottom: '20px' }}>
        <label>
          {'Throttled Range (Readonly):'}
          <input
            type="range"
            min="0"
            max="100"
            value={throttledValue}
            disabled
            style={{ width: '100%' }}
          />
          <span>{throttledValue}</span>
        </label>
      </div>
      <table>
        <tbody>
          <tr>
            <td>{'Instant Executions:'}</td>
            <td>{instantExecutionCount}</td>
          </tr>
        </tbody>
      </table>
      <div style={{ color: '#666', fontSize: '0.9em' }}>
        <p>{'Throttled with 250ms wait time'}</p>
      </div>
    </div>
  )
}

function PacerExample() {
  return (
    <div>
      <App1 />
      <hr />
      <App2 />
      <hr />
      <App3 />
    </div>
  )
}
createRoot(document.getElementById('app')!).render(PacerExample)