1.0.3 • Published 4 years ago

use-clamp v1.0.3

Weekly downloads
2
License
GPL-3.0-or-later
Repository
github
Last release
4 years ago

useClamp react hook

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

  • Installation
  • Multiple 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]