|
| 1 | +# Readable Numbers |
| 2 | + |
| 3 | +[](https://github.com/laravel-ready/readable-numbers) |
| 4 | + |
| 5 | +[![Stable Version][badge_stable]][link_packagist] |
| 6 | +[![Unstable Version][badge_unstable]][link_packagist] |
| 7 | +[![Total Downloads][badge_downloads]][link_packagist] |
| 8 | +[![License][badge_license]][link_license] |
| 9 | + |
| 10 | +Human readable numbers for Laravel. In some cases, you may need to format numbers in a way that is easier to read. Especially when you are dealing with numbers that are very large, for example we want to show page views and we have `100000000` views. So we can show it in the `100M` format. |
| 11 | + |
| 12 | +## Installation |
| 13 | + |
| 14 | +```bash |
| 15 | +composer require laravel-ready/readable-numbers |
| 16 | +``` |
| 17 | + |
| 18 | +## Thresholds |
| 19 | + |
| 20 | +| Threshold | Suffix | Result | |
| 21 | +| ------------------ | ----------- | ------ | |
| 22 | +| 900 | | 900 | |
| 23 | +| 900.000 | k | 0.9 K | |
| 24 | +| 900.000.000 | m | 0.9 M | |
| 25 | +| 900.000.000.000 | b | 9 T | |
| 26 | +| 90.000.000.000.000 | t | 900 T | |
| 27 | + |
| 28 | +## Usages |
| 29 | + |
| 30 | +`make` method takes 3 aguments: `make(float $value, int $decimals = 1, $lang = null)` |
| 31 | + |
| 32 | + |
| 33 | +### Service Example |
| 34 | + |
| 35 | +```php |
| 36 | + |
| 37 | +use LaravelReady\ReadableNumbers\Services\ReadableNumbers; |
| 38 | + |
| 39 | +... |
| 40 | + |
| 41 | +$readableNumber = ReadableNumbers::make(123456789); // 123.5 M |
| 42 | +$readableNumber = ReadableNumbers::make(-123456789); // -123.5 M |
| 43 | + |
| 44 | +// with more decimals |
| 45 | +$readableNumber = ReadableNumbers::make(123456789, 2); // 123.46 M |
| 46 | + |
| 47 | +// with target language (default is english) |
| 48 | +$readableNumber = ReadableNumbers::make(123456789, 2, 'tr'); // 123.46 Mn |
| 49 | +$readableNumber = ReadableNumbers::make(123456789, 3, 'ja'); // 123.457 億 |
| 50 | +$readableNumber = ReadableNumbers::make(123456789, 4, 'de'); // 123.4568 Mio. |
| 51 | + |
| 52 | +``` |
| 53 | + |
| 54 | +### Directive Example |
| 55 | + |
| 56 | +There is only one directive: `@readableNumber()`, again takes three arguments: `@readableNumber(float $value, int $decimals = 1, $lang = null)` and all arguments are required. If you use a multi-language system, you should remember to directives are cached. So, you should pass decimal count and language. |
| 57 | + |
| 58 | + |
| 59 | +```html |
| 60 | + |
| 61 | +... |
| 62 | + |
| 63 | +<span> |
| 64 | + @readableNumber(123456789, 1, app()->getLocale()) |
| 65 | +</span> |
| 66 | + |
| 67 | +... |
| 68 | + |
| 69 | +<span class="view-counter"> |
| 70 | + <i class="icon icon-eye"></i> |
| 71 | + |
| 72 | + Viewed @readableNumber($blogPost->views, 1, app()->getLocale()) times |
| 73 | +</span> |
| 74 | + |
| 75 | +``` |
| 76 | + |
| 77 | +## Languages |
| 78 | + |
| 79 | +Supported languages are listed [here](lang/) and reference are used in [unicode.org](https://www.unicode.org/cldr/cldr-aux/charts/28/verify/numbers/). If you want to add your own language and send PR. |
| 80 | + |
| 81 | +Don't forget to these shortings are depends on a mathematical view. |
| 82 | + |
| 83 | + |
| 84 | +[badge_downloads]: https://img.shields.io/packagist/dt/laravel-ready/readable-numbers.svg?style=flat-square |
| 85 | + |
| 86 | +[badge_license]: https://img.shields.io/packagist/l/laravel-ready/readable-numbers.svg?style=flat-square |
| 87 | + |
| 88 | +[badge_stable]: https://img.shields.io/github/v/release/laravel-ready/readable-numbers?label=stable&style=flat-square |
| 89 | + |
| 90 | +[badge_unstable]: https://img.shields.io/badge/unstable-dev--main-orange?style=flat-square |
| 91 | + |
| 92 | +[link_license]: LICENSE |
| 93 | + |
| 94 | +[link_packagist]: https://packagist.org/packages/laravel-ready/readable-numbers |
| 95 | + |
0 commit comments