angular2-bootstrap-confirm

Angular2 bootstrap confirm

Demo

https://mattlewis92.github.io/angular2-bootstrap-confirm/

Table of contents

• About
• Installation
• Documentation
• Development
• License

About

A simple angular2 directive to display a bootstrap styled confirmation popover when an element is clicked.

Pull requests are welcome.

AngularJS 1.x version

Installation

Install through npm:

npm install --save angular2-bootstrap-confirm

Then use it in your app on a component:

import {Component} from '@angular/core';
import {Confirm, ConfirmOptions, ConfirmPopover, Position} from 'angular2-bootstrap-confirm';
import {PositionService} from 'angular2-bootstrap-confirm/position/position';
// Or if you're already using the ng2-bootstrap module
// import {PositionService} from 'ng2-bootstrap/components/position';

@Component({
  selector: 'my-component',
  providers: [ // you can pass both of these when bootstrapping the app to configure globally throughout your app
    ConfirmOptions,
     // this is required so you can use the bundled position service rather than rely on the `ng2-bootstrap` module
    {provide: Position, useClass: PositionService}
  ],
  directives: [
    Confirm
  ],
  precompile: [
    ConfirmPopover
  ],
  template: `
    <button
      class="btn btn-default"
      mwlConfirm
      [title]="title"
      [message]="message"
      placement="left"
      (confirm)="confirmClicked = true"
      (cancel)="cancelClicked = true"
      [(isOpen)]="isOpen">
      Click me!
    </button>
  `
})
class MyComponent {
  public title: string = 'Popover title';
  public message: string = 'Popover description';
  public confirmClicked: boolean = false;
  public cancelClicked: boolean = false;
  public isOpen: boolean = false;
}

You may also find it useful to view the demo source.

Usage without a module bundler

<script src="node_modules/angular2-bootstrap-confirm/position/position.js"></script>
<script src="node_modules/angular2-bootstrap-confirm/angular2-bootstrap-confirm.js"></script>
<script>
    // position service available as ng2BootstrapPosition.PositionService
    // confirm options, directive and position token available as ng2BootstrapConfirm.ConfirmOptions, ng2BootstrapConfirm.Confirm, ng2BootstrapConfirm.Position
</script>

Usage with universal

You will need to add this line in your server bootstrap code to get this module to work with universal:

(global as any).HTMLElement = () => {};

Documentation

All documentation is auto-generated from the source via typedoc and can be viewed here: https://mattlewis92.github.io/angular2-bootstrap-confirm/docs/

The main confirm directive options can be viewed here.

Development

Prepare your environment

• Install Node.js and NPM (should come with)
• Install local dev dependencies: npm install while current directory is this repo

Development server

Run npm start to start a development server on port 8000 with auto reload + tests.

Testing

Run npm test to run tests once or npm run test:watch to continually run tests.

Release

• Bump the version in package.json (once the module hits 1.0 this will become automatic)

npm run release

License

MIT

Changelog

0.8.0 (2016-07-02)

Features

• use ComponentFactoryResolver for creating the popover (99af89f)
• mwlConfirm: renamed the selector of the mwlConfirm directive (54a013c)
• mwlFocus: rename focusOn to mwlFocus (5e3cbe7)
• mwlFocus: rename the mwlFocus directive selector to be camelcased (724ea47)

BREAKING CHANGES

• mwlConfirm: the CSS selector of the directive has changed from mwl-confirm to mwlConfirm
• You must now add a precompile: [ConfirmPopover], to any components metadata that uses the confirm directive like so:

import {Component} from '@angular/core';
import {Confirm, ConfirmOptions, ConfirmPopover, Position} from 'angular2-bootstrap-confirm';
@Component({
  selector: 'my-component',
  directives: [
    Confirm
  ],
  precompile: [
    ConfirmPopover
  ],
  ...
})
class MyComponent {
}

• mwlFocus: focusOn has been removed in favour of binding directly to the mwlFocus selector. Only relevant if using a custom template.

Before:

mwlFocus [focusOn]="condition"

After

[mwlFocus]="condition"

• mwlFocus: the mwlFocus selector has changed from mwl-focus to mwlFocus. Only relevant if using a custom template.

<a name="0.7.0"></a>