{"id":13581001,"url":"https://github.com/JsDaddy/ngx-mask","last_synced_at":"2025-04-06T06:32:21.759Z","repository":{"id":37927331,"uuid":"69059417","full_name":"JsDaddy/ngx-mask","owner":"JsDaddy","description":"Angular Plugin to make masks on form fields and html elements.","archived":false,"fork":false,"pushed_at":"2025-03-25T20:02:06.000Z","size":29537,"stargazers_count":1193,"open_issues_count":56,"forks_count":298,"subscribers_count":20,"default_branch":"develop","last_synced_at":"2025-04-01T22:17:03.905Z","etag":null,"topics":["angular","character","decimals","decimals-enter","dot-separator","eparator","input","input-mask","mask","mask-options","ng","ngx","ngx-mask","percent","pipe","special-characters","sufix","symbol","typescript","web"],"latest_commit_sha":null,"homepage":"https://jsdaddy.github.io/ngx-mask","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/JsDaddy.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":"CODE_OF_CONDUCT.md","threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2016-09-23T20:44:28.000Z","updated_at":"2025-04-01T21:47:28.000Z","dependencies_parsed_at":"2023-11-11T21:04:55.550Z","dependency_job_id":"ec291754-bd0e-42df-8d70-287522825482","html_url":"https://github.com/JsDaddy/ngx-mask","commit_stats":{"total_commits":860,"total_committers":106,"mean_commits":8.11320754716981,"dds":0.7511627906976744,"last_synced_commit":"cced9568d114593b025d7b5949cf50655b8ac46c"},"previous_names":["nepipenkoigor/ngx-mask","nepipenkoigor/ng2-mask"],"tags_count":49,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/JsDaddy%2Fngx-mask","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/JsDaddy%2Fngx-mask/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/JsDaddy%2Fngx-mask/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/JsDaddy%2Fngx-mask/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/JsDaddy","download_url":"https://codeload.github.com/JsDaddy/ngx-mask/tar.gz/refs/heads/develop","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247362540,"owners_count":20926797,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["angular","character","decimals","decimals-enter","dot-separator","eparator","input","input-mask","mask","mask-options","ng","ngx","ngx-mask","percent","pipe","special-characters","sufix","symbol","typescript","web"],"created_at":"2024-08-01T15:01:57.166Z","updated_at":"2025-04-06T06:32:21.754Z","avatar_url":"https://github.com/JsDaddy.png","language":"TypeScript","readme":"\u003ca href=\"http://jsdaddy.io/img/logo.png\"\u003e\n  \u003ch1 align=\"center\"\u003eNGX MASK\u003c/h1\u003e\n\u003c/a\u003e\n\n\u003cp align=\"center\"\u003e\n  NGX MASK is the best directive to solve masking input with needed pattern\n\u003c/p\u003e\n\n[![CI](https://github.com/JsDaddy/ngx-mask/actions/workflows/quality-check.yml/badge.svg?branch=develop)](https://github.com/JsDaddy/ngx-mask/actions/workflows/main.yml)\n[![npm](https://img.shields.io/npm/v/ngx-mask.svg)](https://www.npmjs.com/package/ngx-mask)\n[![npm downloads](https://img.shields.io/npm/dt/ngx-mask.svg)](https://npmjs.org/ngx-mask)\n\n[![npm](https://img.shields.io/npm/dm/ngx-mask.svg)](https://www.npmjs.com/package/ngx-mask)\n\n[![GitHub contributors](https://img.shields.io/github/contributors/JSDaddy/ngx-mask.svg?style=flat)](https://github.com/JSDaddy/ngx-mask)\n\n[![GitHub stars](https://img.shields.io/github/stars/JSDaddy/ngx-mask.svg?label=GitHub%20Stars\u0026style=flat)](https://github.com/JSDaddy/ngx-mask)\n\nYou can also try our NGX LOADER INDICATOR [check](https://www.npmjs.com/package/ngx-loader-indicator).\nYou can also try our NGX COPYPASTE [check](https://www.npmjs.com/package/ngx-copypaste).\n\n### You can try live [documentation](https://jsdaddy.github.io/ngx-mask/) with examples\n\n## Installing\n\nAngular version 17.x.x\n\n```bash\n$ npm install --save ngx-mask\n```\n\nAngular version 16.x.x\n\n```bash\n$ npm install --save ngx-mask@16.4.2\n```\n\nAngular version 15.x.x\n\n```bash\n$ npm install --save ngx-mask@15.2.3\n```\n\nAngular version 14.x.x\n\n```bash\n$ npm install --save ngx-mask@14.3.3\n```\n\nAngular version 13.x.x or 12.x.x\n\n```bash\n$ npm install --save ngx-mask@13.2.2\n```\n\n## Quickstart if ngx-mask version \u003e= 15.0.0\n\nImport **ngx-mask** directive, pipe and provide NgxMask providers with `provideNgxMask` function.\n\n### With default config options application level\n\n```typescript\nbootstrapApplication(AppComponent, {\n    providers: [\n        (...)\n        provideEnvironmentNgxMask(),\n        (...)\n    ],\n}).catch((err) =\u003e console.error(err));\n```\n\n### Passing your own mask config options\n\n```typescript\nimport { NgxMaskConfig } from 'ngx-mask'\n\nconst maskConfig: Partial\u003cNgxMaskConfig\u003e = {\n  validation: false,\n};\n\nbootstrapApplication(AppComponent, {\n    providers: [\n        (...)\n        provideEnvironmentNgxMask(maskConfig),\n        (...)\n    ],\n}).catch((err) =\u003e console.error(err));\n```\n\n### Using a function to configure:\n\n```typescript\nconst maskConfigFunction: () =\u003e Partial\u003cNgxMaskConfig\u003e = () =\u003e {\n  return {\n    validation: false,\n  };\n};\n\nbootstrapApplication(AppComponent, {\n    providers: [\n         (...)\n         provideEnvironmentNgxMask(maskConfigFunction),\n         (...)\n],\n}).catch((err) =\u003e console.error(err));\n```\n\n### With config options feature level\n\n```typescript\n@Component({\n    selector: 'my-feature',\n    templateUrl: './my-feature.component.html',\n    styleUrls: ['./my-feature.component.css'],\n    standalone: true,\n    imports: [NgxMaskDirective, (...)],\n    providers: [\n          (...)\n          provideNgxMask(),\n          (...)\n    ],\n})\nexport class MyFeatureComponent {}\n```\n\nThen, import directive, pipe to needed standalone component and just define masks in inputs.\n\n### With Angular modules\n\n```typescript\n@NgModule({\n  imports: [\n      NgxMaskDirective, NgxMaskPipe\n  ],\n  providers: [provideNgxMask()]\n})\n```\n\n## Quickstart if ngx-mask version \u003c 15.0.0\n\nFor version ngx-mask \u003c 15.0.0\nImport **ngx-mask** module in Angular app.\n\n### With default mask config options\n\n```typescript\nimport { NgxMaskModule, NgxMaskConfig } from 'ngx-mask'\n\nexport const options: Partial\u003cnull | NgxMaskConfig\u003e | (() =\u003e Partial\u003cNgxMaskConfig\u003e) = null;\n\n@NgModule({\n  imports: [\n    NgxMaskModule.forRoot(),\n  ],\n})\n```\n\n### Passing in your own mask config options\n\n```typescript\nimport { NgxMaskModule, NgxMaskConfig } from 'ngx-mask'\n\nconst maskConfig: Partial\u003cNgxMaskConfig\u003e = {\n  validation: false,\n};\n\n@NgModule({\n  imports: [\n    NgxMaskModule.forRoot(maskConfig),\n  ],\n})\n```\n\nOr using a function to get the config:\n\n```typescript\nconst maskConfigFunction: () =\u003e Partial\u003cNgxMaskConfig\u003e = () =\u003e {\n  return {\n    validation: false,\n  };\n};\n\n@NgModule({\n  imports: [\n    NgxMaskModule.forRoot(maskConfigFunction),\n  ],\n})\n```\n\nThen, just define masks in inputs.\n\n## Actively supported versions\n\nngx-mask follows the official Angular support policy, supporting the Active and LTS (Long-Term Support) versions of Angular. As of the latest release, Angular v17 and newer are supported.\n\nProjects using Angular versions outside the supported range (e.g., older than v17) should use the last compatible version of ngx-mask. However, these versions will no longer receive updates, bug fixes, or new features.\n\nFor detailed information about Angular's versioning and support schedule, visit the official [Angular releases page](https://angular.dev/reference/releases#actively-supported-versions).\n\n## Usage\n\nText [documentation](https://github.com/JsDaddy/ngx-mask/blob/develop/USAGE.md)\n\n## Contributing\n\nWe would love some contributions! Check out this [document](https://github.com/JsDaddy/ngx-mask/blob/develop/CONTRIBUTING.md) to get started.\n","funding_links":[],"categories":["TypeScript","Third Party Components"],"sub_categories":["Forms"],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2FJsDaddy%2Fngx-mask","html_url":"https://awesome.ecosyste.ms/projects/github.com%2FJsDaddy%2Fngx-mask","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2FJsDaddy%2Fngx-mask/lists"}