Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/revolist/revogrid-column-numeral
Numeral.js RevoGrid column type
https://github.com/revolist/revogrid-column-numeral
datagrid excel grid numeral numeraljs reactgrid revogrid vuegrid
Last synced: 3 months ago
JSON representation
Numeral.js RevoGrid column type
- Host: GitHub
- URL: https://github.com/revolist/revogrid-column-numeral
- Owner: revolist
- License: mit
- Created: 2020-10-23T12:10:41.000Z (about 4 years ago)
- Default Branch: main
- Last Pushed: 2023-03-14T15:06:08.000Z (almost 2 years ago)
- Last Synced: 2024-05-02T02:21:32.398Z (8 months ago)
- Topics: datagrid, excel, grid, numeral, numeraljs, reactgrid, revogrid, vuegrid
- Language: TypeScript
- Homepage: https://github.com/revolist/revogrid
- Size: 421 KB
- Stars: 3
- Watchers: 2
- Forks: 3
- Open Issues: 7
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
### 🚨 Repository Notice 🚨
This repo is read-only and will be **deprecated** in v5+ in favor of monorepos. Post issues [here](https://github.com/revolist/revogrid). Happy coding! 🖥️💻
---
# Number Column Type
Number column type for RevoGrid system based on [numeraljs](http://numeraljs.com) library.
Use any format you love to assign number format for your grid.
## Installation
```
npm i @revolist/revogrid-column-numeral
```
## Output
### Number
|Number|Format|String|
|--- |--- |--- |
|10000|'0,0.0000'|10,000.0000|
|10000.23|'0,0'|10,000|
|10000.23|'+0,0'|+10,000|
|-10000|'0,0.0'|-10,000.0|
|10000.1234|'0.000'|10000.123|
|100.1234|'00000'|00100|
|1000.1234|'000000,0'|001,000|
|10|'000.00'|010.00|
|10000.1234|'0[.]00000'|10000.12340|
|-10000|'(0,0.0000)'|(10,000.0000)|
|-0.23|'.00'|-.23|
|-0.23|'(.00)'|(.23)|
|0.23|'0.00000'|0.23000|
|0.23|'0.0[0000]'|0.23|
|1230974|'0.0a'|1.2m|
|1460|'0 a'|1 k|
|-104000|'0a'|-104k|
|1|'0o'|1st|
|100|'0o'|100th|
### Currency
|Number|Format|String|
|--- |--- |--- |
|1000.234|'$0,0.00'|$1,000.23|
|1000.2|'0,0[.]00 $'|1,000.20 $|
|1001|'$ 0,0[.]00'|$ 1,001|
|-1000.234|'($0,0)'|($1,000)|
|-1000.234|'$0.00'|-$1000.23|
|1230974|'($ 0.00 a)'|$ 1.23 m|
## Usage in revo-grid:
```js
import NumberColumnType from '@revolist/revogrid-column-numeral';
const columnTypes = {
'numeric': new NumberColumnType('0,0')
};
const columns = [
{
prop: 'Num',
name: 'My number',
columnType: 'numeric'
},
{
prop: 'Num2',
name: 'My number2',
columnType: 'numeric'
}
];
const rows = [{
'Num': 1000,
'Num2': 1000
}];
const grid = document.querySelector('revo-grid');
grid.columnTypes = columnTypes;
grid.source = rows;
grid.columns = columns;
// '1,000'
```
## Advanced
If you need to get numeric library instance you can do this as simple as:
```js
import NumberColumnType from '@revolist/revogrid-column-numeral';
const numeral = NumberColumnType.getNumeralInstance;
numeral.register('format', 'percentage', {});
```
Also plugin provides access to beforeValueFormatted instance:
emiter?: (event: string, instance: Numeral)
```js
import NumberColumnType from '@revolist/revogrid-column-numeral';
const columnTypes = {
'numeric': new NumberColumnType('0,0', (eventName, numeralInstance) => {
// numeralInstance operations
}),
};
```