ng2-editable v1.0.2

ng2-editable

In-place editing for Angular2

Installation

ng2-editable is available via npm:

npm install --save ng2-editable

Use it by improting EditableModule into your module:

import { EditableModule } from 'ng2-editable';

@NgModule({
  imports: [
    EditableModule,
    ...
  ]
})

To use components in other modules, also add EditableModule to exports.

Usage

Include the components you need into your HTML file, specifying the property you want to bind to.

<ng2-text-editable [(text)]="myText"</ng2-text-editable>

ng2-editable uses two-way binding, so no event handlers are required.

The component will render the property you provide. On click, it will replace it with an <input> or <select> element. It will return to default state if you click anywhere else.

Documentation

Common features

Toggle event

All ng2-editable components expose a (toggled) Output which will fire whenever the component changes state. It emits an object with the following interface:

interface ToggleEvent {
  isActive: boolean;
  isChanged: boolean;
};

Text editable

A simple component for editing strings.

selector: ng2-text-editable

property name: text

Date editable

Same as text editable, but takes dates and provides a calendar.

selector: ng2-date-editable

property name: date

Selectable

This component allows selecting an option from a dropdown list.

selector: ng2-selectable

property name: value

Required inputs

options: the list of options to select from, must be an array of any type.

Optional inputs

valueProperty: the property which will be used as the value of the option; defaults to id

labelProperty: the property of the object which will be displayed; defaults to label

valueAccessor: a function which takes an element of the list and returns its value; has precedence over valueProperty

labelAccessor: a function which renders an element of the list as a string; has precedence over labelProperty

Example

<ng2-selectable [(value)]="userId" [options]="users"
  [labelAccessor]="getUserLabel">
</ng2-selectable>

public getUserLabel = (user) => `${user.name} (${user.organization})`;

Toggleable

A component that displays boolean states.

selector: ng2-toggleable

property name: value

Optional inputs:

showFalse: if true, does not display anything if value is true; defaults to false.

Contribute

Contributions are welcome on Github.