From e2ca21e22c43361210cbff61ef74bf858a3eb21f Mon Sep 17 00:00:00 2001 From: Igor Rafael Date: Sat, 18 Nov 2017 08:41:28 -0200 Subject: [PATCH] docs: remove examples from README --- README.md | 156 ++---------------------------------------------------- 1 file changed, 3 insertions(+), 153 deletions(-) diff --git a/README.md b/README.md index e9a350bd..e15a244d 100644 --- a/README.md +++ b/README.md @@ -20,7 +20,7 @@ npm install --save angular-input-masks ## Configuration -### With npm (without browserify): +### Without browserify: 1. Import the ```angular-input-masks-standalone.min.js``` script in your page. For example: @@ -36,7 +36,7 @@ Obs: for npm the build scripts are available inside ```releases``` folder. angular.module('app', ['ui.utils.masks']); ``` -### With npm and browserify: +### With browserify: ``` angular.module('demo', [require('angular-input-masks')]); @@ -48,9 +48,7 @@ Some masks are internationalized, so you need to include the proper angular-loca ## How to use -### ui-number-mask ### - - - Example: + - Number mask Example : ```html @@ -62,159 +60,11 @@ Some masks are internationalized, so you need to include the proper angular-loca ``` -- Allow negative numbers using the ```ui-negative-number``` attribute: - -```html - -``` - -- Support to the ```min```, ```max``` and ```ui-hide-group-sep``` attributes. - -```html - -``` - -```html - - -``` - -- Internationalized: Used the decimal separator and the thousands separator defined in the client browser configuration. - -### ui-percentage-mask ### - - - Example: - -```html - -``` - -- You can set the number of decimals (default is 2): - -```html - -``` - -- The $modelValue is the $viewValue / 100, so $viewValue - 100% = $modelValue - 1 - -- You can use the same value in $modelValue and $viewValue using ```ui-percentage-value```: - -```html - -``` - -- Support to the ```min```, ```max``` and ```ui-hide-group-sep``` attributes. - -- Internationalized: Used the decimal separator and thousands separator defined in the client browser configuration. - -- The $modelValue is the $viewValue / 100, so $viewValue - 100% = $modelValue - 1 - -- You can add ```ui-hide-space``` attribute to hide space between [NUMBER] and % - -### ui-money-mask ### - - - Example: - -```html - -``` - -- Define the number of decimals (default is 2): - -```html - -``` - -- Support to the ```min```, ```max``` and ```ui-hide-group-sep``` attributes. - -- Internationalized: Used the currency symbol, decimal separator and thousands separator defined in the client browser configuration. - -- You can add ```ui-hide-space``` attribute to hide space between [Currency symbol] and [NUMBER] - -### ui-br-phone-number ### -```html - -``` - -### ui-br-cep-mask ### -```html - -``` - -### ui-br-cpf-mask ### - - - Example: - -```html - -``` - -### ui-br-cnpj-mask ### - - - Example: - -```html - -``` - -### ui-br-cpfcnpj-mask ### - - - Example: - -```html - -``` - -### ui-br-ie-mask ### -```html - - -``` -- Support masks for all the 27 brazillian states. - -- Validations according to the [Sintegra especification](http://www.sintegra.gov.br/insc_est.html). - -### ui-time-mask ### --Example: - -```html - -``` -- Support to the ```short``` attributes. -```html - -``` - -### ui-date-mask ### --Example: - -```html - -``` -- Support to the custom date masks (See moment.js date formats). -```html - -``` -- Support to ```parse``` attribute. When the attribute is set to ```false```, the inputed value will be passed to the model as a string. Default value of the attribute is ```true```. -```html - -``` ### More examples ### _See more usage examples in the [Demo page](http://assisrafael.github.io/angular-input-masks/)_ -### Masks without documentation (help wanted!) - -- ui-nfe-access-key-mask -- ui-time-mask -- ui-date-mask -- ui-br-boleto-bancario-mask -- ui-br-car-plate-mask -- ui-scientific-notation-mask -- ui-us-phone-number -- ui-fr-phone-number - ## Other build options If you are using npm (without browserify):