angular-confirmation-capture

A singleton, global Angular service to programmatically show a confirmation box to capture an user's consent.

Table of contents

• Installation
• Available APIs
  • ConfirmationCaptureService
  • ConfirmationCaptureConfiguration
  • Theme
• Example Usage
  • Code example
  • Result

Installation

• npm

  npm i -S @babybeet/angular-confirmation-capture
  

• pnpm

  pnpm i -S @babybeet/angular-confirmation-capture
  

• yarn

  yarn add @babybeet/angular-confirmation-capture
  

Available APIs

ConfirmationCaptureService

A singleton service to programmatically show a confirmation box to capture an user's consent.

class ConfirmationCaptureService {
  /**
   * Set the default theme that will be used for all confirmation captures created in the future.
   *
   * @param theme The new theme to be used as the default.
   */
  static setDefaultTheme(theme: Theme): void;

  /**
   * Set the default label for the cancel button. Default is `Cancel`.
   */
  static setDefaultCancelButtonLabel(label: string): void;

  /**
   * Set the default label for the confirm button. Default is `Confirm`.
   */
  static setDefaultConfirmButtonLabel(label: string): void;

  /**
   * Open a confirmation capture using the provided configuration. Return a promise that
   * resolves to `true` if confirm button is clicked, `false` otherwise.
   *
   * @param confirmationCaptureConfiguration The confirmation capture configuration object.
   */
  open(confirmationCaptureConfiguration: ConfirmationCaptureConfiguration): Promise<boolean>;
}

ConfirmationCaptureConfiguration

The configuration object for the confirmation capture to be created.

interface ConfirmationCaptureConfiguration {
  /**
   * The optional label for the cancel button. Default is `Cancel`.
   */
  cancelButtonLabel?: string;

  /**
   * The optional class name to add for this confirmation capture.
   */
  className?: string;

  /**
   * The optional label for the confirm button. Default is `Confirm`.
   */
  confirmButtonLabel?: string;

  /**
   * The required confirmation capture's content to show. HTML is supported.
   */
  content: string;

  /**
   * Whether or not the confirmation capture can be closed by clicking the backdrop.
   */
  dismissible?: boolean;

  /**
   * The optional theme for the floating box. Default is `light`.
   */
  theme?: Theme;
}

Theme

type Theme = 'dark' | 'light';

Example Usage

Code example

// Import the service into your class to start using it
import { ConfirmationCaptureService } from '@babybeet/angular-confirmation-capture';
import { NotificationService } from '@babybeet/angular-notification';

@Component({
  selector: 'test-component',
  template: `
    <button
      type="button"
      (click)="openConfirmationCapture()">
      Click me
    </button>
  `
})
export class TestComponent {
  constructor(
    private readonly confirmationCaptureService: ConfirmationCaptureService,
    private readonly notificationService: NotificationService
  ) {}

  openConfirmationCapture() {
    this.confirmationCaptureService
      .open({
        content: 'Do you want to proceed?'
      })
      .then(confirmed => {
        if (confirmed) {
          this.notificationService.open({
            content: 'You clicked confirmed'
          });
        } else {
          this.notificationService.open({
            content: 'You clicked cancel'
          });
        }
      });
  }
}

Result

• Dark theme

• Light theme