-
Notifications
You must be signed in to change notification settings - Fork 2.2k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Gilad Gray
committed
Dec 1, 2018
1 parent
2518adb
commit 97ac2c0
Showing
2 changed files
with
102 additions
and
81 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,87 @@ | ||
| /* | ||
| * Copyright 2018 Palantir Technologies, Inc. All rights reserved. | ||
| * | ||
| * Licensed under the terms of the LICENSE file distributed with this project. | ||
| */ | ||
|
|
||
| import { clamp } from "../../common/utils"; | ||
|
|
||
| export function clampValue(value: number, min?: number, max?: number) { | ||
| // defaultProps won't work if the user passes in null, so just default | ||
| // to +/- infinity here instead, as a catch-all. | ||
| const adjustedMin = min != null ? min : -Infinity; | ||
| const adjustedMax = max != null ? max : Infinity; | ||
| return clamp(value, adjustedMin, adjustedMax); | ||
| } | ||
|
|
||
| export function getValueOrEmptyValue(value: number | string = "") { | ||
| return value.toString(); | ||
| } | ||
|
|
||
| /** Returns `true` if the string represents a valid numeric value, like "1e6". */ | ||
| export function isValueNumeric(value: string) { | ||
| // checking if a string is numeric in Typescript is a big pain, because | ||
| // we can't simply toss a string parameter to isFinite. below is the | ||
| // essential approach that jQuery uses, which involves subtracting a | ||
| // parsed numeric value from the string representation of the value. we | ||
| // need to cast the value to the `any` type to allow this operation | ||
| // between dissimilar types. | ||
| return value != null && (value as any) - parseFloat(value) + 1 >= 0; | ||
| } | ||
|
|
||
| export function isValidNumericKeyboardEvent(e: React.KeyboardEvent) { | ||
| // unit tests may not include e.key. don't bother disabling those events. | ||
| if (e.key == null) { | ||
| return true; | ||
| } | ||
|
|
||
| // allow modified key strokes that may involve letters and other | ||
| // non-numeric/invalid characters (Cmd + A, Cmd + C, Cmd + V, Cmd + X). | ||
| if (e.ctrlKey || e.altKey || e.metaKey) { | ||
| return true; | ||
| } | ||
|
|
||
| // keys that print a single character when pressed have a `key` name of | ||
| // length 1. every other key has a longer `key` name (e.g. "Backspace", | ||
| // "ArrowUp", "Shift"). since none of those keys can print a character | ||
| // to the field--and since they may have important native behaviors | ||
| // beyond printing a character--we don't want to disable their effects. | ||
| const isSingleCharKey = e.key.length === 1; | ||
| if (!isSingleCharKey) { | ||
| return true; | ||
| } | ||
|
|
||
| // now we can simply check that the single character that wants to be printed | ||
| // is a floating-point number character that we're allowed to print. | ||
| return isFloatingPointNumericCharacter(e.key); | ||
| } | ||
|
|
||
| /** | ||
| * A regex that matches a string of length 1 (i.e. a standalone character) | ||
| * if and only if it is a floating-point number character as defined by W3C: | ||
| * https://www.w3.org/TR/2012/WD-html-markup-20120329/datatypes.html#common.data.float | ||
| * | ||
| * Floating-point number characters are the only characters that can be | ||
| * printed within a default input[type="number"]. This component should | ||
| * behave the same way when this.props.allowNumericCharactersOnly = true. | ||
| * See here for the input[type="number"].value spec: | ||
| * https://www.w3.org/TR/2012/WD-html-markup-20120329/input.number.html#input.number.attrs.value | ||
| */ | ||
| const FLOATING_POINT_NUMBER_CHARACTER_REGEX = /^[Ee0-9\+\-\.]$/; | ||
| export function isFloatingPointNumericCharacter(character: string) { | ||
| return FLOATING_POINT_NUMBER_CHARACTER_REGEX.test(character); | ||
| } | ||
|
|
||
| /** | ||
| * Round the value to have _up to_ the specified maximum precision. | ||
| * | ||
| * This differs from `toFixed(5)` in that trailing zeroes are not added on | ||
| * more precise values, resulting in shorter strings. | ||
| */ | ||
| export function toMaxPrecision(value: number, maxPrecision: number) { | ||
| // round the value to have the specified maximum precision (toFixed is the wrong choice, | ||
| // because it would show trailing zeros in the decimal part out to the specified precision) | ||
| // source: http://stackoverflow.com/a/18358056/5199574 | ||
| const scaleFactor = Math.pow(10, maxPrecision); | ||
| return Math.round(value * scaleFactor) / scaleFactor; | ||
| } |
97ac2c0There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
pull pure methods out to utils file
Previews: documentation | landing | table