mirror of
https://github.com/apache/superset.git
synced 2024-09-19 20:19:37 -04:00
.. | ||
src | ||
test | ||
package.json | ||
README.md |
@superset-ui/number-format
Description
Example usage
Functions getNumberFormatter
and formatNumber
should be used instead of calling d3.format
directly.
import { getNumberFormatter } from '@superset-ui/number-format';
const formatter = getNumberFormatter('.2f');
console.log(formatter(1000));
or
import { formatNumber } from '@superset-ui/number-format';
console.log(formatNumber('.2f', 1000));
It is powered by a registry to support registration of custom formatting, with fallback to d3.format
and handle error for invalid format string.
import { getNumberFormatterRegistry, formatNumber, NumberFormatter } from '@superset-ui/number-format';
getNumberFormatterRegistry().registerValue('my_format', new NumberFormatter({
id: 'my_format',
formatFunc: v => `my special format of ${v}`
});
console.log(formatNumber('my_format', 1000));
// prints 'my special format of 1000'
It also define constants for common d3 formats. See the full list of formats in NumberFormats.js.
import { NumberFormats } from '@superset-ui-number-format';
NumberFormats.PERCENT // ,.2%
NumberFormats.PERCENT_3_POINT // ,.3%
API
fn(args)
- Do something
Development
@data-ui/build-config
is used to manage the build configuration for this package including babel
builds, jest testing, eslint, and prettier.