https://github.com/basklein/angular-japanese-numerals
Japanese numeral filter for AngularJS
https://github.com/basklein/angular-japanese-numerals
angularjs filter japanese japanese-characters kanji numerals
Last synced: 2 months ago
JSON representation
Japanese numeral filter for AngularJS
- Host: GitHub
- URL: https://github.com/basklein/angular-japanese-numerals
- Owner: basklein
- License: mit
- Created: 2019-06-20T04:49:18.000Z (almost 6 years ago)
- Default Branch: master
- Last Pushed: 2023-05-06T02:38:39.000Z (about 2 years ago)
- Last Synced: 2025-02-16T23:32:31.789Z (3 months ago)
- Topics: angularjs, filter, japanese, japanese-characters, kanji, numerals
- Language: JavaScript
- Size: 235 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
[](https://badge.fury.io/js/angular-japanese-numerals)
[](https://github.com/basklein/angular-japanese-numerals/issues)
[](https://github.com/basklein/angular-japanese-numerals/blob/master/LICENSE)
# angular-japanese-numerals
Japanese numeral service and filters for AngularJS
## Demo
[demo on plnkr](https://plnkr.co/edit/eK0dOA?p=info)
## Description
This is a service for AngularJS that converts common Arabic numerals to Japanese numerals. This service can be used as is, or through the filters `japaneseNumerals` and `simpleJapaneseNumerals`.
The `japaneseNumerals` filter will convert the Arabic numerals to Japanese numerals, including the power of ten kanji characters.
The `simpleJapaneseNumerals` filter will convert the Arabic numerals to Japanese numerals, using the '〇' character and positions instead of the power of ten kanji characters.
Both filters can be adjusted with parameters as described in the 'Documentation' section.
## Usage
1. Install via [npm](https://www.npmjs.com/) or downloaded files:
1. via npm: `npm install --save angular-japanese-numerals`
2. via [downloaded files](https://github.com/basklein/angular-japanese-numerals/master)
2. Add `angular-japanese-numerals` to your application's module dependencies.
3. Include dependencies and angular-japanese-numerals in your HTML.
- When using npm
```html
```
- When using downloaded files
```html
```
4. Use the angular filters `japaneseNumerals` and `simpleJapaneseNumerals`, or use the angular service `japaneseNumeralService`.
## Documentation
### Services
#### japaneseNumeralService
##### characters
Object containing all Japanese numeral characters.
##### convertToJapaneseNumerals
Converts a number or string of Arabic numerals to a string of Japanese numerals with power of ten characters.
* `@param {number | string}` value The value to convert to Japanese numerals.
* `@param {bool=} formal` Optional toggle to use formal numbers.
* `@param {bool=} buFraction` Optional toggle to use bu fractions instead of wari fractions.
* `@return {string}` A string of Japanese numerals converted from the original value.
##### convertToSimpleJapaneseNumerals
Converts a number or string of Arabic numerals to a string of Japanese numerals without the power of ten characters.
* `@param {number | string}` value The value to convert to Japanese numerals.
* `@param {bool=} formal` Optional toggle to use formal numbers.
* `@return {string}` A string of Japanese numerals converted from the original value.
### Filters
##### japaneseNumerals
Converts a number or string of Arabic numerals to a string of Japanese numerals with power of ten characters.
* `@param {number | string} input` The value to convert to Japanese numerals.
* `@param {bool=} formal` Optional toggle to use formal numbers.
* `@param {bool=} buFraction` Optional toggle to use bu fractions instead of wari fractions.
* `@return {string}` A string of Japanese numerals converted from the original value.
##### simpleJapaneseNumerals
Converts a number or string of Arabic numerals to a string of Japanese numerals without power of ten characters.
* `@param {number | string} input` The value to convert to Japanese numerals.
* `@param {bool=} formal` Optional toggle to use formal numbers.
* `@return {string}` A string of Japanese numerals converted from the original value.
## Sample
HTML
```html
{{ 11 | japaneseNumerals }} : 11 normal
{{ 17 | japaneseNumerals: true }} : 17 formal
{{ '151' | japaneseNumerals }} : '151' normal
{{ 10.51 | japaneseNumerals: false: true }} : 10.51 normal buFraction
```
Result:
```html
十一 : 11 normal
拾七 : 17 formal
百五十一 : '151' normal
十・五分一厘 : 10.51 normal
```
Javascript:
```javascript
angular.module('app', ['angular-japanese-numerals']);
angular.module('app')
.controller('appController', function ($scope, $filter) {
$scope.javascriptNormal = $filter('japaneseNumerals')(469);
$scope.javascriptFormal = $filter('japaneseNumerals')(469, true);
});
```
Result:
```html
四百六十九 : $scope.javascriptNormal 469 normal
四百六拾九 : $scope.javascriptFormal 469 formal
```
# LICENSE
MIT