use-counter

Increments/decrements state within given boundaries

Source

View source code

Docs

Edit this page

PackageIcon

@mantine/hooks

Usage

Count: 0

import { Group, Button, Text } from '@mantine/core';
import { useCounter } from '@mantine/hooks';

function Demo() {
  const [count, handlers] = useCounter(0, { min: 0, max: 10 });

  return (
    <>
      <Text>Count: {count}</Text>
      <Group justify="center">
        <Button onClick={handlers.increment}>Increment</Button>
        <Button onClick={handlers.decrement}>Decrement</Button>
        <Button onClick={handlers.reset}>Reset</Button>
        <Button onClick={() => handlers.set(5)}>Set 5</Button>
      </Group>
    </>
  );
}

Definition

interface UseCounterOptions {
  min?: number;
  max?: number;
}

interface UseCounterHandlers {
  increment: () => void;
  decrement: () => void;
  set: (value: number) => void;
  reset: () => void;
}

type UseCounterReturnValue = [number, UseCounterHandlers];

function useCounter(
  initialValue?: number,
  options?: UseCounterOptions,
): UseCounterReturnValue

Exported types

The UseCounterOptions, UseCounterHandlers, and UseCounterReturnValue types are exported from the @mantine/hooks package; you can import them in your application:

import type { UseCounterOptions, UseCounterHandlers, UseCounterReturnValue } from '@mantine/hooks';

use-window-scroll

use-debounced-callback