An open API service indexing awesome lists of open source software.

https://github.com/basklein/angular-full-width-to-half-width

Full-width to half-width character filter for AngularJS
https://github.com/basklein/angular-full-width-to-half-width

Last synced: 3 months ago
JSON representation

Full-width to half-width character filter for AngularJS

Awesome Lists containing this project

README

        

[![npm version](https://badge.fury.io/js/angular-full-width-to-half-width.svg)](https://badge.fury.io/js/angular-full-width-to-half-width)
[![GitHub issues](https://img.shields.io/github/issues/basklein/angular-full-width-to-half-width.svg?style=flat-square)](https://github.com/basklein/angular-full-width-to-half-width/issues)
[![GitHub license](https://img.shields.io/github/license/basklein/angular-full-width-to-half-width.svg?style=flat-square)](https://github.com/basklein/angular-full-width-to-half-width/blob/master/LICENSE)

# angular-full-width-to-half-width
Full-width to half-width character service and filters for AngularJS

## Description
This is a service for AngularJS that converts full-width Unicode characters to their half-width counterparts. This service can be used as is, or through the filter `fullWidthToHalfWidth`.

At the moment the service only converts the characters in the Unicode range 0xFF00 - 0xFF5E. I am planning on adding the ability to convert the rest of the characters in the U+FF00 - U+FFEF block, but this will take time.

## Usage

1. Install via [npm](https://www.npmjs.com/) or downloaded files:
1. via npm: `npm install --save angular-full-width-to-half-width`
2. via [downloaded files](https://github.com/basklein/angular-full-width-to-half-width/master)
2. Add `angular-full-width-to-half-width` to your application's module dependencies.
3. Include dependencies and angular-full-width-to-half-width in your HTML.
- When using npm
```html

```
- When using downloaded files
```html

```
4. Use the angular filter `fullWidthToHalfWidth`, or use the angular service `fullWidthToHalfWidthService`.

## Documentation

### Services

#### convertToHalfWidthService
##### convertToHalfWidth
Converts the full-width characters in a string to half-width counterparts.
* `@param {string} value` The string containing characters to convert to half-width.
* `@return {string}` A string containing half-width characters converted from the original value.

### Filters
##### fullWidthToHalfWidth
Converts the full-width characters in a string to half-width counterparts.
* `@param {string} input` The string containing characters to convert to half-width.
* `@return {string}` A string containing half-width characters converted from the original value.

## Example

HTML
```html


{{"hえllo world!" | fullWidthToHalfWidth }} : hえllo world!



{{"What, is this?" | fullWidthToHalfWidth}} : What, is this?


```

Result:
```html


hえllo world! : hえllo world!



What, is this? : What, is this?


```

Javascript:
```javascript
angular.module('app', ['angular-full-width-to-half-width']);

angular.module('app')
.controller('appController', function ($scope, $filter) {
$scope.javascriptTest = $filter('fullWidthToHalfWidth')("Hello world!");
$scope.javascriptExample = $filter('fullWidthToHalfWidth')("hえllo world!");
});
```

Result:
```html


Hello world! : $scope.javascriptTest Hello world!



hえllo world! : $scope.javascriptString hえllo world!


```

# LICENSE
MIT