angular-inline-editors
TypeScript icon, indicating that this package has built-in type declarations

2.0.4 • Public • Published

angular-inline-editors | Simple and easy to use.

angular-inline-editors is a small Angular library that allows the experience to use editable elements (click-to-edit) without the pain and/or hassle.

angular-inline-editors

npm version Build Status npm GitHub issues npm

Dependencies

angular-inline-editors was built to work with Angular 4+, current dependencies are Bootstrap (3.3.7+) and FontAwesome.

Road Map - Inline Editors

  • input
    • input - text
    • input - password - pattern
    • input - number
    • input - email
    • input - phone
    • input - pattern
  • textarea
  • select
  • checkbox
  • checkbox list
  • radio list
  • tags
  • date
  • time
  • datetime picker
  • typeahead
  • validations
    • input - required
    • textarea - required
    • date - required
    • time - required
    • tags - required
    • typeahead - required
    • select - required
    • checkbox list - required
    • radio list - required
  • editable data table
  • customize css/themes

Date and Time uses ngx-bootstrap, please make sure to install it when using date and time controls. Also, include this style reference into your index.html header <link rel="stylesheet" href="https://unpkg.com/ngx-bootstrap/datepicker/bs-datepicker.css"> NOTE: Working in a solution to remove this dependency.

IF YOU LIKE IT AND WANT TO SUPPORT DONATE!

Getting Started

  1. install angular-inline-editors through npm package using the following command:

     `npm install angular-inline-editors --save`
    
  2. Dependencies to be included in your project:

  • Bootstrap (3.3.7+) - Styling. We Recommend Bootstrap 4
  • FontAwesome - Icons.
  • ngx-bootstrap for date, time, and datetime editors.

Adding angular-inline-editors to your Module

Following the principle of Angular is based on Modules and you use what you want when you want to use it. You can add each angular-inline-editors separate. This means you add Modules based on what you need.

How to use

Add the module

import {InputEditorModule} from 'angular-inline-editors';
 
@NgModule({
  imports: [
    InputEditorModule.forRoot()
  ]
})

Add more

import {InputEditorModule} from 'angular-inline-editors';
import { SelectEditorModule } from 'angular-inline-editors';
 
@NgModule({
  imports: [
    InputEditorModule.forRoot(),
    SelectEditorModule.forRoot()
    
  ]
})

On your html

<input-editor label="First Name" id="txtname" [(ngModel)]="name" type="text" placeholder="Enter First Name" (onSave)="sampleClick()"></input-editor>

On your component

name:string;
 
sampleClick(){
  console.log('clicked!!');
}

angular-inline-editors API

All angular-inline-editors have onSave and onCancel events with default behavior that your will read below. Also you can bind onSave and onCancel to trigger your saving data function or your cancel undo data.

NOTE: All examples below follow our DEMO code which link you'll find at the top of the place along with the source code.

(onSave)="YOUR_SAVE_FUNCTION" 
(onCancel)="YOUR_CANCEL_FUNCTION"

input-editor

label - string - Label value for input element  
id - string - Identifier for input element 
[(ngModel)] - angular two ways binding 
type="text" - Recommend type to use this control.
placeholder - string - Placeholder value for input element
disabled - string - true | false - by defult control is not disabled
stringlength - string - Set maximun string length for input element
(onSave) - Bound to the green button - accepts the changes made in the input element - (optional) triggers your save changes function. 
(onCancel) - Bound to the red button - undo or cancel chnages mde in the input element - (optional) triggers your cancel/undo function.

Basic use

<input-editor label="Full Name" id="txtname" 
[(ngModel)]="fullName" 
type="text"  
placeholder="Enter Full Name">
</input-editor>

textarea-editor

label - string - Label value for input element  
id - string - Identifier for input element 
[(ngModel)] - angular two ways binding 
placeholder - string - Placeholder value for input element
disabled - string - true | false - by defult control is not disabled
stringlength - string - Set maximun string length for input element
maxheight - string - Set max height of the textarea - auto | 100% | pixes | rem
(onSave) - Bound to the green button - accepts the changes made in the input element - (optional) triggers your save changes function. 
(onCancel) - Bound to the red button - undo or cancel chnages mde in the input element - (optional) triggers your cancel/undo function.

Basic use

<textarea-editor [(ngModel)]="myBio" 
stringlength="700" 
label="My Bio" 
maxheight="200px">
</textarea-editor>

select-editor

label - string - Label value for input element  
id - string - Identifier for input element 
disabled - string - true | false - by defult control is not disabled
placeholder - string - Placeholder value for input element
[(ngModel)] - angular two ways binding for selected item 
[options] - binding to a collection/array of objects
displayValue - string - Set the name of the property to be display;
dataValue - string - Set the name of the property to get the selected value;
(onSave) - Bound to the green button - accepts the changes made in the input element - (optional) triggers your save changes function. 
(onCancel) - Bound to the red button - undo or cancel chnages mde in the input element - (optional) triggers your cancel/undo function.

Basic use

<select-editor label="Country" id="dpCountry" 
[(ngModel)]="selectedCountry" 
[options]="countryOptions" 
displayValue="longName"
dataValue="shortName">
</select-editor>

checkbox-editor

label - string - Label value for input element  
id - string - Identifier for input element 
disabled - string - true | false - by defult control is not disabled
[(ngModel)] - angular two ways binding
checkedDisplayValue - string - Text to display when checkbox is checked.
uncheckedDisplayValue - string - Text to display when checkbox is unchecked.
(onSave) - Bound to the green button - accepts the changes made in the input element - (optional) triggers your save changes function. 
(onCancel) - Bound to the red button - undo or cancel chnages mde in the input element - (optional) triggers your cancel/undo function.

Basic use

<checkbox-editor 
checkedDisplayValue="Remember Me!!" 
uncheckedDisplayValue="Don't Remember Me" 
[(ngModel)]="checkboxValue"
label="Remember me?">
</checkbox-editor>

checklist-editor

label - string - Label value for input element  
id - string - Identifier for input element 
disabled - string - true | false - by defult control is not disabled
placeholder - string - Placeholder value for input element
displayValue - string - Set the name of the property to be display;
dataValue - string - Set the name of the property to get the selected value;
[options] - binding to a collection/array of objects
[(ngModel)] - angular two ways binding for selected items. It will return a array of dataValue. 
(onSave) - Bound to the green button - accepts the changes made in the input element - (optional) triggers your save changes function. 
(onCancel) - Bound to the red button - undo or cancel chnages mde in the input element - (optional) triggers your cancel/undo function.

Basic Use

<checklist-editor 
[options]="langOptions" 
[(ngModel)]="selectedLang" 
label="Speaks" 
placeholder="Select languages"
displayValue="longName" 
dataValue="shortName">
</checklist-editor>

Returns an array of selected values.

[
   'en',
   'sp'       
]

radiolist-editor

label - string - Label value for input element  
id - string - Identifier for input element 
disabled - string - true | false - by defult control is not disabled
placeholder - string - Placeholder value for input element
displayValue - string - Set the name of the property to be display;
dataValue - string - Set the name of the property to get the selected value;
[options] - binding to a collection/array of objects
[(ngModel)] - angular two ways binding for selected items. It will return the selected dataValue. 
(onSave) - Bound to the green button - accepts the changes made in the input element - (optional) triggers your save changes function. 
(onCancel) - Bound to the red button - undo or cancel chnages mde in the input element - (optional) triggers your cancel/undo function.

Basic Use

<radiolist-editor 
[options]="genderOptions" 
[(ngModel)]="selectedGender" 
label="Gender" 
placeholder="Select gender"
displayValue="longName" 
dataValue="shortName">
</radiolist-editor>

tags-editor

label - string - Label value for input element  
id - string - Identifier for input element 
disabled - string - true | false - by defult control is not disabled
placeholder - string - Placeholder value for input element
[(ngModel)] - angular two ways binding.
(onSave) - Bound to the green button - accepts the changes made in the input element - (optional) triggers your save changes function. 
(onCancel) - Bound to the red button - undo or cancel chnages mde in the input element - (optional) triggers your cancel/undo function.

Basic Use

<tags-editor 
[(ngModel)]="tags" 
label="Categories" 
placeholder="Enter a category">
</tags-editor>            

Return a array

[ 'test 1', 'test 2', test 3]

date-editor

ngx-bootstrap is required in order to use this editor. Make sure you've read the information in top of the page.

label - string - Label value for input element  
id - string - Identifier for input element 
disabled - string - true | false - by defult control is not disabled
placeholder - string - Placeholder value for input element
[(ngModel)] - angular two ways binding.
format - string - medium | short | fullDate | longDate | mediumDate | shortDate - follows angular standard -> https://v2.angular.io/docs/ts/latest/api/common/index/DatePipe-pipe.html
(onSave) - Bound to the green button - accepts the changes made in the input element - (optional) triggers your save changes function. 
(onCancel) - Bound to the red button - undo or cancel chnages mde in the input element - (optional) triggers your cancel/undo function.

Basic Use

<date-editor 
[(ngModel)]="selectedDate" 
label="Date Sample" 
placeholder="Enter a Date" 
format="shortDate">
</date-editor>

time-editor

ngx-bootstrap is required in order to use this editor. Make sure you've read the information in top of the page.

label - string - Label value for input element  
id - string - Identifier for input element 
disabled - string - true | false - by defult control is not disabled
placeholder - string - Placeholder value for input element
[(ngModel)] - angular two ways binding.
format - string - mediumTime | shortTime - follows angular standard -> https://v2.angular.io/docs/ts/latest/api/common/index/DatePipe-pipe.html
(onSave) - Bound to the green button - accepts the changes made in the input element - (optional) triggers your save changes function. 
(onCancel) - Bound to the red button - undo or cancel chnages mde in the input element - (optional) triggers your cancel/undo function.

Basic Use

<time-editor 
[(ngModel)]="timeSample" 
label="Time Sample" 
placeholder="Enter Time" 
format="shortTime">
</time-editor> 

typeahead-editor

label - string - Label value for input element  
id - string - Identifier for input element 
disabled - string - true | false - by defult control is not disabled
placeholder - string - Placeholder value for input element
displayValue - string - Set the name of the property to be display;
dataValue - string - Set the name of the property to get the selected value;
[options] - binding to a collection/array of objects
[(ngModel)] - angular two ways binding for selected items. 
(onSave) - Bound to the green button - accepts the changes made in the input element - (optional) triggers your save changes function. 
(onCancel) - Bound to the red button - undo or cancel chnages mde in the input element - (optional) triggers your cancel/undo function.

Basic Use

<typeahed-editor 
[(ngModel)]="selectedTypeahead" 
[options]="countries" 
displayValue="longName" 
dataValue="shortName" 
placeholder="Enter a Country">
</typeahed-editor> 

Package Sidebar

Install

npm i angular-inline-editors

Weekly Downloads

111

Version

2.0.4

License

MIT

Unpacked Size

170 kB

Total Files

64

Last publish

Collaborators

  • codechavez