forked from openexchangerates/accounting.js
-
Notifications
You must be signed in to change notification settings - Fork 0
/
index.html
473 lines (366 loc) · 18.6 KB
/
index.html
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
<!doctype html>
<html lang="en" class="no-js">
<head>
<meta charset="utf-8">
<title>accounting.js: JavaScript number and currency formatting library</title>
<link href="demo-resources/style.css" rel="stylesheet"/>
<link rel="canonical" href="http://openexchangerates.github.io/accounting.js/" />
<script type="text/javascript">
var _gaq = _gaq || [];
_gaq.push(['_setAccount', 'UA-17884149-3']);
_gaq.push(['_trackPageview']);
(function() {
var ga = document.createElement('script'); ga.type = 'text/javascript'; ga.async = true;
ga.src = ('https:' == document.location.protocol ? 'https://ssl' : 'http://www') + '.google-analytics.com/ga.js';
var s = document.getElementsByTagName('script')[0]; s.parentNode.insertBefore(ga, s);
})();
</script>
</head>
<body>
<section>
<h1>accounting.js</h1>
<p><strong>accounting.js</strong> is a tiny JavaScript library by <a href="https://openexchangerates.org" title="Open Exchange Rates free currency data API" target="_blank">Open Exchange Rates</a>, providing simple and advanced number, money and currency formatting.</p>
<p>Features custom output formats, parsing/unformatting of numbers, easy localisation and spreadsheet-style column formatting (to line up symbols and decimals).</p>
<p>It's lightweight, has no dependencies and is suitable for all client-side and server-side JavaScript applications.</p>
<p><a href="http://twitter.com/share" class="twitter-share-button" data-count="horizontal" data-via="josscrowcroft" data-url="http://openexchangerates.github.io/accounting.js" data-text="accounting.js - JavaScript library for money/currency formatting">Tweet</a> <g:plusone size="medium"></g:plusone></p>
<ul>
<li><a href="#methods" title="library methods overvew">methods & examples</a>
<li><a href="#demo" title="demo">demo</a>
<li><a href="#instructions" title="instructions">instructions</a>
<li><a href="#documentation" title="documentation">documentation</a>
<li><a href="#roadmap" title="roadmap">roadmap</a>
<li><a href="#support" title="support">feedback / support</a>
<li><a href="#download" title="download">download</a>
<li><a href="#links" title="links">links</a>
</ul>
</section>
<section id="methods">
<h2>Library Methods</h2>
<h4><strong>formatMoney()</strong> - format any number into currency</h4>
<p>The most basic library function for formatting numbers as money values, with customisable currency symbol, precision (decimal places), and thousand/decimal separators:</p>
<pre class="prettyprint lang-js">// Default usage:
accounting.formatMoney(12345678); // $12,345,678.00
// European formatting (custom symbol and separators), can also use options object as second parameter:
accounting.formatMoney(4999.99, "€", 2, ".", ","); // €4.999,99
// Negative values can be formatted nicely:
accounting.formatMoney(-500000, "£ ", 0); // £ -500,000
// Simple `format` string allows control of symbol position (%v = value, %s = symbol):
accounting.formatMoney(5318008, { symbol: "GBP", format: "%v %s" }); // 5,318,008.00 GBP</pre>
<h4><strong>formatColumn()</strong> - format a list of values for column-display</h4>
<p>This table demonstrates how <strong>accounting.js</strong> can take a list of numbers and money-format them with padding to line up currency symbols and decimal places</p>
<p>In order for the padded spaces to render correctly, the containing element must be CSS styled with <code>white-space: pre</code> (pre-formatted) - otherwise the browser will squash them into single spaces.</p>
<table id="demo-table">
<thead>
<tr>
<th>Original Number:</th>
<th>With accounting.js:</th>
<th>Different settings:</th>
<th>European format:</th>
<th>Symbol after value:</th>
</tr>
</thead>
<tbody></tbody>
</table>
<pre class="prettyprint lang-js">// Format list of numbers for display:
accounting.formatColumn([123.5, 3456.49, 777888.99, 12345678, -5432], "$ ");</pre>
<h4><strong>formatNumber()</strong> - format a number with custom precision and localisation</h4>
<p>The base function of the library, which takes any number or array of numbers, runs <code>accounting.unformat()</code> to remove any formatting, and returns the number(s) formatted with separated thousands and custom precision:</p>
<pre class="prettyprint lang-js">accounting.formatNumber(5318008); // 5,318,008
accounting.formatNumber(9876543.21, 3, " "); // 9 876 543.210</pre>
<h4><strong>toFixed()</strong> - better rounding for floating point numbers</h4>
<p>Implementation of toFixed() that treats floats more like decimal values than binary, fixing inconsistent precision rounding in JavaScript (where some .05 values round up, while others round down):</p>
<pre class="prettyprint lang-js">(0.615).toFixed(2); // "0.61"
accounting.toFixed(0.615, 2); // "0.62"</pre>
<h4><strong>unformat()</strong> - parse a value from any formatted number/currency string</h4>
<p>Takes any number and removes all currency formatting. Aliased as <code>accounting.parse()</code></p>
<pre class="prettyprint lang-js">accounting.unformat("£ 12,345,678.90 GBP"); // 12345678.9</pre>
</section>
<section id="demo">
<h2>Demo / Try it out</h2>
<h4>Money formatting:</h4>
<div class="well">
<p>Enter any number into the box and choose currency. Uses <code>accounting.formatMoney()</code>:</p>
<p>
<select id="demo-number-symbol">
<option value="$ ">$</option>
<option value="£ ">£</option>
<option value="HK$ ">HK$</option>
<option data-locale="european" value="€ ">€ </option>
</select>
<input type="text" maxlength="20" class="" id="demo-number-value" value="" />
</p>
<p>Result: <strong><span id="demo-number-result">$ 0.00</span></strong></p>
</div>
<h4>Column formatting:</h4>
<div class="well">
<p>Edit the values in the table to see how <strong>formatColumn()</strong> keeps them aligned:</p>
<table id="demo-column">
<tbody>
<tr>
<td><input type="text" value="1000000" maxlength="20" /></td>
<td class="output">$ 1,000,000.00</td>
<td class="output2">GBP 1,000,000</td>
</tr>
<tr>
<td><input type="text" value="-5000" maxlength="20" /></td>
<td class="output">$ -5,000.00</td>
<td class="output2">GBP (5,000)</td>
</tr>
<tr>
<td><input type="text" value="0" maxlength="20" /></td>
<td class="output">$ 0.00</td>
<td class="output2">GBP --</td>
</tr>
</tbody>
</table>
</div>
</section>
<section id="instructions">
<h2>Basic Instructions:</h2>
<p>1. Download the script and put it somewhere, then reference it in your HTML like so:</p>
<pre class="prettyprint"><script src="path/to/accounting.js"></script>
<script type="text/javascript">
// Library ready to use:
accounting.formatMoney(5318008);
</script></pre>
<p>2. See the documentation and source-code for full method/parameter information.</p>
</section>
<section id="documentation">
<h2>Documentation</h2>
<p>Information on the parameters of each method. See <a href="#methods" title="accounting.js library methods">library methods</a> above for more examples. Optional parameters are in <code><em>[italics]</em></code>, with the default value indicated.</p>
<h4><strong>accounting.settings</strong></h4>
<pre class="prettyprint lang-js">// Settings object that controls default parameters for library methods:
accounting.settings = {
currency: {
symbol : "$", // default currency symbol is '$'
format: "%s%v", // controls output: %s = symbol, %v = value/number (can be object: see below)
decimal : ".", // decimal point separator
thousand: ",", // thousands separator
precision : 2 // decimal places
},
number: {
precision : 0, // default precision on numbers is 0
thousand: ",",
decimal : "."
}
}
// These can be changed externally to edit the library's defaults:
accounting.settings.currency.format = "%s %v";
// Format can be an object, with `pos`, `neg` and `zero`:
accounting.settings.currency.format = {
pos : "%s %v", // for positive values, eg. "$ 1.00" (required)
neg : "%s (%v)", // for negative values, eg. "$ (1.00)" <em>[optional]</em>
zero: "%s -- " // for zero values, eg. "$ --" <em>[optional]</em>
};
// Example using underscore.js - extend default settings (also works with $.extend in jQuery):
accounting.settings.number = _.defaults({
precision: 2,
thousand: " "
}, accounting.settings.number);</pre>
<h4><strong>accounting.formatMoney()</strong></h4>
<pre class="prettyprint lang-js">// Standard usage and parameters (returns string):
accounting.formatMoney(number<em>,[symbol = "$"],[precision = 2],[thousand = ","],[decimal = "."],[format = "%s%v"]</em>)
// Second parameter can be an object:
accounting.formatMoney(number<em>, [options]</em>)
// Available fields in options object, matching `settings.currency`:
var options = {
symbol : "$",
decimal : ".",
thousand: ",",
precision : 2,
format: "%s%v"
};
// Example usage:
accounting.formatMoney(12345678); // $12,345,678.00
accounting.formatMoney(4999.99, "€", 2, ".", ","); // €4.999,99
accounting.formatMoney(-500000, "£ ", 0); // £ -500,000
// Example usage with options object:
accounting.formatMoney(5318008, {
symbol: "GBP",
precision: 0,
thousand: "·",
format: {
pos : "%s %v",
neg : "%s (%v)",
zero: "%s --"
}
});
// Will recursively format an array of values:
accounting.formatMoney([123, 456, [78, 9]], "$", 0); // ["$123", "$456", ["$78", "$9"]]</pre>
<h4><strong>accounting.formatColumn()</strong></h4>
<pre class="prettyprint lang-js">// Standard usage and parameters (returns array):
accounting.formatColumn(list<em>, [symbol = "$"],[precision = 2],[thousand = ","],[decimal = "."],[format = "%s%v"]</em>)
// Second parameter can be an object (see formatNumber for available options):
accounting.formatColumn(list, <em>[options]</em>)
// Example usage (NB. use a space after the symbol to add arbitrary padding to all values):
var list = [123, 12345];
accounting.formatColumn(list, "$ ", 0); // ["$ 123", "$ 12,345"]
// List of numbers can be a multi-dimensional array (formatColumn is applied recursively):
var list = [[1, 100], [900, 9]];
accounting.formatColumn(list); // [["$ 1.00", "$100.00"], ["$900.00", "$ 9.00"]]</pre>
<h4><strong>accounting.formatNumber()</strong></h4>
<pre class="prettyprint lang-js">// Standard usage and parameters (returns string):
accounting.formatNumber(number<em>, [precision = 0], [thousand = ","], [decimal = "."]</em>)
// Second parameter can also be an object matching `settings.number`:
accounting.formatNumber(number<em>, [object]</em>)
// Example usage:
accounting.formatNumber(9876543); // 9,876,543
accounting.formatNumber(4999.99, 2, ".", ","); // 4.999,99
// Example usage with options object:
accounting.formatNumber(5318008, {
precision : 3,
thousand : " "
});
// Will recursively format an array of values:
accounting.formatNumber([123456, [7890, 123]]); // ["123,456", ["7,890", "123"]]</pre>
<h4><strong>accounting.toFixed()</strong></h4>
<pre class="prettyprint lang-js">// Standard usage and parameters (returns string):
accounting.toFixed(number<em>, [precision = 0]</em>);
// Example usage:
accounting.toFixed(0.615, 2); // "0.62"
// Compare to regular JavaScript `Number.toFixed()` method:
(0.615).toFixed(2); // "0.61"</pre>
<h4><strong>accounting.unformat()</strong></h4>
<pre class="prettyprint lang-js">// Standard usage and parameters (returns number):
accounting.unformat(string<em>, [decimal]</em>);
// Example usage:
accounting.unformat("GBP £ 12,345,678.90"); // 12345678.9
// If a non-standard decimal separator was used (eg. a comma) unformat() will need it in order to work out
// which part of the number is a decimal/float:
accounting.unformat("€ 1.000.000,00", ","); // 1000000</pre>
</section>
<section id="roadmap">
<h2>Roadmap</h2>
<h4>Next Version:</h4>
<ul>
<li><s>Add more fine-grained control of formatting, with negatives and zero-values</s></li>
<li><s>Implement <code>map()</code> and type-checking helper methods to clean up API methods</s></li>
<li>Find performance bottlenecks and work on speed optimisations</li>
<li>Write more tests, docs and examples, add FAQ</li>
<li>Implement <a href="https://github.com/openexchangerates/accounting.js/issues/" title="accounting.js issues">feedback</a></li>
</ul>
<h4>Later:</h4>
<ul>
<li>Add padding parameter to override amount of space between currency symbol and value.</li>
<li>Add digit-grouping control, to allow eg. "$10,0000"</li>
<li>Add choice of rounding method for precision (up, down or nearest-neighbour).</li>
<li>Add several other general and excel-style money formatting methods.</li>
<li>Create NPM package, if there's demand for it.</li>
<li>Create wrapper for jQuery as a separate plugin (not in core) to allow eg. <code>$('td.accounting').formatMoney()</code></li>
</ul>
<p>See the <a href="https://github.com/openexchangerates/accounting.js/issues" title="accounting.js issues">Github Issues page</a> for currently active issues.</p>
</section>
<section id="support">
<h2>Feedback / Support</h2>
<p>Please create issues on the <a href="https://github.com/openexchangerates/accounting.js" title="accounting.js Github repository">accounting.js Github repository</a> if you have feedback or need support, or <a href="mailto:info@openexchangerates.org" title="Contact Open Exchange Rates">contact Open Exchange Rates here</a>.</p>
</section>
<section id="download">
<h2>Download</h2>
<ul>
<li><strong><a href="https://raw.github.com/openexchangerates/accounting.js/master/accounting.js" title="accounting.js">accounting.js</a></strong> - Latest version from Github (12kb)</li>
<li><strong><a href="https://raw.github.com/openexchangerates/accounting.js/master/accounting.min.js" title="accounting.min.js">accounting.min.js</a></strong> - Latest version from Github (3kb, minified)</li>
<li>Or check out the <a href="https://github.com/openexchangerates/accounting.js" title="accounting.js Github repository">accounting.js Github repository</a> for the full package.</li>
</ul>
</section>
<section id="links">
<h2>Links</h2>
<p>accounting.js is maintained by <strong><a href="https://openexchangerates.org" title="Open Exchange Rates free currency data API" target="_blank">Open Exchange Rates</a></strong> - the lightweight currency data API for startups, SMEs and Fortune 500s.</p>
<p>Feedback, support or questions? <strong><a href="mailto:info@openexchangerates.org" title="Contact Open Exchange Rates">Contact Open Exchange Rates</a></strong> for guidance.</p>
<p>Bugs, issues, suggestions or contributions? Please <strong><a href="https://github.com/openexchangerates/accounting.js" title="accounting.js Github repository">post them here</a></strong>.</p>
<p>accounting.js works great with <strong><a href="http://openexchangerates.github.com/money.js" title="money.js - JavaScript currency conversion library">money.js</a></strong> - the tiny (1kb) standalone JavaScript currency conversion library, for web & nodeJS</p>
<br />
<hr />
<p><a href="http://twitter.com/share" class="twitter-share-button" data-count="horizontal" data-via="josscrowcroft" data-url="http://openexchangerates.github.io/accounting.js" data-text="accounting.js - JavaScript library for money/currency formatting">Tweet</a> <g:plusone size="medium"></g:plusone></p>
</section>
<script src="accounting.js"></script>
<script src="demo-resources/js/libs/jquery.min.js"></script>
<script src="demo-resources/js/prettify.js"></script>
<script type="text/javascript">
// demo functions:
jQuery(document).ready(function($) {
var numbers = [123.5, 3456.615, 777888.99, -5432, -1234567, 0];
// Use accounting.js to format the list of numbers several ways:
var formatted = accounting.formatColumn(numbers, "$ "),
different = accounting.formatColumn(numbers, {
symbol:"HK$",
precision:0,
format: {
pos : "%s %v",
neg : "%s (%v)",
zero : "%s --"
}
}),
european = accounting.formatColumn(numbers, {
symbol: '€ ',
thousand:'.',
decimal:','
}),
symbolAfter = accounting.formatColumn(numbers, {
symbol : "GBP",
format : "%v %s"
});
// Concat some nasty demo HTML:
for ( var i = 0; i < numbers.length; i++ ) {
$('<tr><td>'+numbers[i]+'</td><td>'+formatted[i]+'</td><td>'+different[i]+'</td><td>'+european[i]+'</td><td>'+symbolAfter[i]+'</td></tr>').appendTo('table#demo-table tbody');
}
// Try it yourself clicky demo:
var $demoValue = $('#demo-number-value'),
$demoSymbol = $('#demo-number-symbol'),
$demoResult = $('#demo-number-result');
$demoValue.add($demoSymbol).bind('keydown keyup keypress focus blur paste change', function() {
var symbol = $demoSymbol.find(':selected').val(),
result = accounting.formatMoney(
$demoValue.val(),
symbol,
2,
($demoSymbol.find(':selected').data('locale') === 'european') ? "." : ",",
($demoSymbol.find(':selected').data('locale') === 'european') ? "," : "."
);
$demoResult.text(result);
});
// Try it yourself clicky column formatting demo:
var $columnValues = $('#demo-column').find('input'),
$columnOutputs = $('#demo-column').find('.output'),
$columnOutputs2 = $('#demo-column').find('.output2');
$columnValues.bind('keydown keyup keypress focus blur paste', function() {
var list = $.map( $columnValues, function(each) { return $(each).val(); } ),
formatted = accounting.formatColumn(list, {
format : "%s %v"
}),
formatted2 = accounting.formatColumn(list, {
symbol : "GBP",
precision : 0,
format : {
pos : "%s %v",
neg : "%s (%v)",
zero: "%s --"
}
});
$.each($columnOutputs, function(i, each) {
$(each).text(formatted[i]);
});
$.each($columnOutputs2, function(i, each) {
$(each).text(formatted2[i]);
});
});
});
// prettify:
prettyPrint();
// twitter:
(function(d, t) {
var g = d.createElement(t),
s = d.getElementsByTagName(t)[0];
g.async = true;
g.src = 'http://platform.twitter.com/widgets.js';
s.parentNode.insertBefore(g, s);
})(document, 'script');
// google plus:
window.___gcfg = {lang: 'en-GB'};
(function() {
var po = document.createElement('script'); po.type = 'text/javascript'; po.async = true;
po.src = 'https://apis.google.com/js/plusone.js';
var s = document.getElementsByTagName('script')[0]; s.parentNode.insertBefore(po, s);
})();
</script>
</body>
</html>