Components
Structure
Unit
Documentation up to date

Unit

Unit

Expand code

Editable Example

import { Unit } from "@wfp/react";

() => {
  const action = () => {};
  return (
    <Unit
      maximumFractionDigits={3}
      minimumFractionDigits={3}
      type="num"
    >
      123456.12
    </Unit>
  );
};
PropDefaultDescriptionValue

children

ReactNode
–

The value which should be displayed

from

string |number
–

Only used for type Percentage will divide value/from string, float

input

"thousand" |"million" |"billion" |"auto"
–

The interface of the input value

hideEmpty

boolean
–

Hide the Unit if it's value is zero.

minimumFractionDigits

number
–

The minimum number of fraction digits to use. Possible values are from 0 to 20. Only used on numeric types

maximumFractionDigits

number
–

The maximum number of fraction digits to use. Possible values are from 0 to 20. Only used on numeric types

maximumSignificantDigits

number
–

A value between 1-21, The maximum number of significant digits to use. Possible values are from 1 to 21; the default is minimumSignificantDigits.

enableUnitOutputInStringType

boolean
–

Formats the Unit output into a single-line string

localeStringLanguage

string
–

A string with a BCP 47 language code, or an array of language codes. For the general form and interpretation of the locale argument see the toLocaleString on developer.mozilla.org page.

svg

boolean
–

Render output as svg text

type

"none" |"usd" |"partners" |"beneficiaries" |"households" |"months" |"mt" |"metricTons" |"kg" |"num" |"yearMonth" |"level" |"people" |"countries" |"percentage"
–

The unit type

On this page

References