use-clamp
TypeScript icon, indicating that this package has built-in type declarations

1.0.3 • Public • Published

useClamp react hook

npm

A React Hook to keep the given value(s) between the given minimum and maximum values.



clamp description

Installation

$ yarn add use-clamp

Import

import useClamp from 'use-clamp';

Usage

const clampedValue = useClamp(value, 0, 100);

Multiple Values

With passing array of numbers as first arguments will keep sum of the values between range.

  • Each value will stay above the min value.
  • If total of the values exceeds maximum value, each values will have the weighted values.
const clampedValue = useClamp([20, 80, 50, 50], 0, 100);
// clampedValue = [10, 40, 25, 25]

Dependencies (0)

    Dev Dependencies (5)

    Package Sidebar

    Install

    npm i use-clamp

    Weekly Downloads

    1

    Version

    1.0.3

    License

    GPL-3.0-or-later

    Unpacked Size

    37.8 kB

    Total Files

    7

    Last publish

    Collaborators

    • baristna