angular5-input-mask
v7.2.4
Published
input-mask
Downloads
4
Readme
Форк https://github.com/text-mask/text-mask
#Установка Запустить npm i angular5-input-mask
#Документация Для использования импортировать в модуль: InputMaskModule
- Станет доступна директива: inputMask, директива принимает в себя:
- Маску, в формате
mask
[inputMask]='[ regExp | string, ]'
- Pipe функцию постобрабортки
inputMaskPipe
- Preset
inputMaskPreset
состящий из:mask = [ regExp | string, ]
массив regExp | string на каждый символpipe? = (InputmaskPipe)
функция постобраборткиguide? = (boolean)
- Показывать маску при заполненииkeepCharPositions? = (boolean)
- сдвигать ли уже добавленные символы при добавлении / удаленииplaceholderChar? = (string)
- Символ заполнитель маски
#Cборка Перед коммитом требуется сборка: npm run packagr
#Расширенная документация
- Параметры:
mask
((RegExp /string)[]) - Маскаguide
(boolean) - Показывать маску при заполненииplaceholderChar
(string) - ЗаполнительkeepCharPositions
(boolean)pipe
(function) - Постобработка функциейshowMask
(boolean)
- Included
conformToMask
- Supported
<input>
types
mask
mask
Массив регулярных выражений или строк, каждый элемент которой соответствует символу в значении.
Регулярное выражение будет использоваться для проверки пользовательского ввода и либо разрешить его, либо отклонить.
Например, маска для номера телефона в США, такого как (555) 392-4932
, может быть:
['(', /[1-9]/, /\d/, /\d/, ')', ' ', /\d/, /\d/, /\d/, '-', /\d/, /\d/, /\d/, /\d/]
Это означает, что пользователь может ввести только число от 1 до 9 в первом слоте, и только цифры далее.
Примечание. Можно установить маску на false
, чтобы полностью отключить маскировку.
guide
guide
- логическое значение, указывающее компоненту, должен ли он находиться в режиме * guide * или * no guide *.
**По у молчанию включен режим * guide *
placeholderChar
Символ-заполнитель представляет собой слот в маске.
Заполнитель по умолчанию символ подчеркивания, _
.
Пример, для маски ...
['(', /[1-9]/, /\d/, /\d/, ')', ' ', /\d/, /\d/, /\d/, '-', /\d/, /\d/, /\d/, /\d/]
... placeholder будет (___) ___-____
.
Вы можете передать другой символ-заполнитель. Например, символ юникода U + 2000
сделать маску выше похожим на () -
. В JavaScript вы должны передать такой символ юникода
как '\u2000'
.
Внимание!: нельзя использовать в маске символ заполнитель.
keepCharPositions
keepCharPositions
изменяет поведение компонента Text Mask касаемо курсора ввода.
It is set to false
by default,
pipe
Pipe функция позволяет дополнительно обработать значение ( подтвердить / отвергнуть / дополнить ) перед отображением.
Функция принимает параметры:
- conformedValue
- PipeConfig
conformedValue - значение введенное пользователем и подтвержденной маской ввода.
Функция может вернуть 3 типа ответа : false
, string
, or object
.
false
- опровергает пользовательский ввод.
Функция может модифицировать строку после пользователя, когда функция модифицирует строку, она должна вернуть объект:
value
: новая строкаindexesOfPipedChars
: массив целых чисел, который содержит индексы всех символов, которые были добавлены
Примеры:
createAutoCorrectedDatePipe
Text Mask addon.
showMask
showMask
логическое значение, которое сообщает компоненту Text Mask отображать маску как
placeholder вместо обычного заполнителя, когда значение входного элемента пусто.
Поддерживаемые типы <input>
Обратите внимание: Text Mask поддерживает тип ввода text
, tel
, url
, password
и search
. Из-за ограничения
в API браузера другие типы ввода, такие как email
или number
, не поддерживаются.
Fork angular-library-seed
- the starter for Angular libraries
https://github.com/trekhleb/angular-library-seed#angular-library-seed---the-starter-for-angular-libraries
Quick Start
# Clone the repository
git clone https://github.com/trekhleb/angular-library-seed.git
# Go to repository folder
cd angular-library-seed
# Install all dependencies
yarn install
# Build the library
yarn build
File Structure
angular-library-seed
├─ demo * Folder for demo applications (MAY BE DELETED if not required)
| ├─ esm * AOT/JIT demo project
| ├─ umd * UMD demo project
| └─ ... * More details about this folder may be found in demo folder README file.
|
├─ src * Library sources home folder (THE PLACE FOR YOUR LIBRARY SOURCES)
| ├─ components * Example of library components with tests
| ├─ services * Example of library services with tests
| ├─ index.ts * Library entry point that is used by builders
| └─ tick-tock.module.ts * Example of library module
|
├─ .editorconfig * Common IDE configuration
├─ .gitignore * List of files that are ignored while publishing to git repo
├─ .npmignore * List of files that are ignored while publishing to npm
├─ .travis.yml * Travic CI configuration
├─ LICENSE * License details
├─ README.md * README for you library
├─ gulpfile.js * Gulp helper scripts
├─ karma-test-entry.ts * Entry script for Karma tests
├─ karma.conf.ts * Karma configuration for our unit tests
├─ package.json * NPM dependencies, scripts and package configuration
├─ tsconfig-aot.json * TypeScript configuration for AOT build
├─ tsconfig.json * TypeScript configuration for UMD and Test builds
├─ tslint.json * TypeScript linting configuration
├─ webpack-test.config.ts * Webpack configuration for building test version of the library
├─ webpack-umd.config.ts * Webpack configuration for building UMD bundle
└─ yarn.lock * Yarn lock file that locks dependency versions
Getting Started
Dependencies
Node/NPM
Install latest Node and NPM following the instructions. Make sure you have Node version ≥ 7.0 and NPM ≥ 4.
brew install node
for Mac.
Yarn
Yarn package manager is optional but highly recommended. If you prefer to work with npm
directly you may ignore this step.
Yarn installs library dependencies faster and also locks theirs versions. It has more advantages but these two are already pretty attractive.
Install Yarn by following the instructions.
brew install yarn
for Mac.
Installing
fork
this repository.clone
your fork to your local environment.yarn install
to install required dependencies (ornpm i
).
Build the library
yarn build
for building the library once (both ESM and AOT versions).yarn build:watch
for building the library (both ESM and AOT versions) and watch for file changes.
You may also build UMD bundle and ESM files separately:
yarn build:esm
- for building AOT/JIT compatible versions of files.yarn build:esm:watch
- the same as previous command but in watch-mode.yarn build:umd
- for building UMD bundle only.yarn build:umd:watch
- the same as previous command but in watch-mode.
Other commands
Lint the code
yarn lint
for performing static code analysis.
Explore the bundle
yarn explorer
to find out where all your code in bundle is coming from.
Bump library version
npm version patch
to increase library version. More on bumping.
preversion
script in this case will automatically run project testing and linting in prior in order to check that the library is ready for publishing.
Publish library to NPM
npm publish
to publish your library sources on npmjs.com. Once the library is published it will be available for usage in npm packages.
prepublishOnly
script in this case will automatically run project testing and linting in prior in order to check that the library is ready for publishing.
Cleaning
yarn clean:tmp
command will clean up all temporary files likedocs
,dist
,coverage
etc.yarn clean:all
command will clean up all temporary files along withnode_modules
folder.
Library development workflow
In order to debug your library in browser you need to have Angular project that will consume your library, build the application and display it. For your convenience all of that should happen automatically in background so once you change library source code you should instantly see the changes in browser.
There are several ways to go here:
- Use your real library-consumer project and link your library to it via
yarn link
command (see below). - Use demo applications that are provided for your convenience as a part of this repository.
- Use Angular-CLI to generate library-consumer project for you and then use
yarn link
to link your library to it.
Using yarn link
In you library root folder:
# Create symbolic link
yarn link
# Build library in watch mode
yarn build:watch
In you project folder that should consume the library:
# Link you library to the project
yarn link "angular-library-seed"
# Build your project. In case of Angular-CLI use the following command.
ng serve --aot
Then you need to import your library into your project's source code.
Now, once you update your library source code it will automatically be re-compiled and your project will be re-built so you may see library changes instantly.
More information about yarn link
command.