1.0.7 • Published 6 years ago
ngx-multi-inputs v1.0.7
Angular Multi-Input-Array Component Ngx-multi-inputs (Angular 2+)
Component will return array of input fields values which you sepcify its type i.e. text, email, etc..
Features
- The package will work just fine with its default values in case you didn't provide properties input values.
- Set title to be shown on inputs, if you provided a
titleproperty it will be show on the lable, placeholder and the button. For example if your fileds is forskillsyou provide the title like thistitle="skills"and the label will become "please enter skill", the button will read "Add skills", and so on. Or you can provide the text for each of these items. - You set the limit to the number of fields can be added
- You can make the first input required field
- You can provide a RegExp pattern for the first input field to be validated with.
- You can specify all the text even the error messages for the required field. In case not specified default values text will be shown.
- You can use the default style like in the image or you can specify classes for each element (form tag, for-group, label, field, btn, and error messages).
- In case you provided classes, only the classes your provided will be applied to the element and the default class will be removed
Getting Started
Installing
npm i ngx-multi-inputsConfiguration
Ensure you import the module and the dependencies:
import { BrowserModule } from "@angular/platform-browser";
import { NgModule } from "@angular/core";
import { MultiInputsModule } from "ngx-multi-inputs";
@NgModule({
declarations: [],
imports: [BrowserModule, MultiInputsModule],
exports: [],
providers: []
})
export class AppModule {}Basic Usage
<ngx-multi-inputs
title="Email"
type="email"
formClasses="my-form"
placeholder="enter email"
btnText="Add"
name="emails"
[required]="true"
[tabIndex]="1"
[limit]="4"
(inputValues)="getValues($event)"
>
</ngx-multi-inputs>@Component({
selector: 'app',
templateUrl: "./app.component.html",
styleUrls: ["./app.component.css"],
});
export class App {
getValues(inputValues) {
console.log({ inputValues })
}
}Api for multi-inputs Component
These are the list of Inputs[] that are supported by the component. Configure the settings to meet your requirement.
| Input | Type | Description | Default Value |
|---|---|---|---|
| title | string | Will be used as the title. if provided, it will be show on the lable, placeholder and the button. For example if your fileds is for social link, the label will become "please enter social link", the button will read "Add social link", and so on. Or you can provide the text for each of these items. | none |
| type | string | type attribute of input fields. | text |
| btnText | string | The text will be written on the button which adds more fields. | Add |
| labelText | string | The text will be used as the label for the first input then it will have number beside the text. ex: enter value will become evnter value 2 for the second input field. | Please enter ${this.title || 'value'} |
| placeholder | String | The text will be used as the placeholder for the first input then it will have number beside the text. ex: enter value will become evnter value 2 for the second input field. | Please enter ${this.title || 'value'} |
| iconSrc | string | The URL of your icon src. | component's icon |
| requiredFieldMsg | string | The text will be shown in case the first field is required and it's not provided. | Required field |
| invalidValueMsg | string | The text will be shown in case the first field has a pattern which is not mathced. | Invalid pattern |
| tabIndex | number | The value of tabindex attribute which will be accumlative in other fields. | 1 |
| required | boolean | Wether the value pf first inputs is required or not. | false |
| limit | number | Maximum number of fields total fields plus the default one. | 5 |
| name | string | name attribute for each input field which is accumlative in the added fields. | multi-inputs |
| formClasses | string | To provide a class or classes for the enclosing <form> tag. | default class |
| inputGroupClasses | string | To provide a class or classes for the inputs group which contains the label, the input field, and the error message div. | default class |
| fieldClasses | string | To provide a class or classes for the inputs field. | default class |
| labelClasses | string | To provide a class or classes for the label. | default class |
| errClasses | string | To provide a class or classes for error message <div>. | default class |
| removeIconClasses | string | To provide a class or classes for delete field icon. | default class |
| btnClasses | string | To provide a class or classes for "add field" button. | default class |
Outputs ()
inputValues- Return the array of values of the inputs.
