@ngx-misc/dropzone-overlay
TypeScript icon, indicating that this package has built-in type declarations

0.0.1 • Public • Published

dropzone-overlay

Directive that will listen for drag & drop events on Window object, render custom overlay and provide and set associated FormControl instance value with dropped files.

This library was generated with Nx.

Installation

npm install @ngx-misc/dropzone-overlay

Usage

Import the module:

import { ReactiveFormsModule } from '@angular/forms';
import { DropzoneOverlayModule } from '@ngx-misc/dropzone-overlay';

@NgModule({
  imports: [
    ReactiveFormsModule,
    DropzoneOverlayModule
  ]
})

In component template:

<input
  [ngmDropzoneOverlay]="customDropzoneComponent"
  [formControl]="fileControl"
  [accept]="accept"
  [multiple]="true"
  type="file"
/>

Where:

  • customDropzoneComponent is a component class that will be rendered in full screen overlay while files are dragged over the window,
  • fileControl is a FormControl in host component,
  • accept is a string of acceptable file types,
  • multiple is a boolean for multiple file selection.

Because <input[type=file]> can be cumbersome to style, you can hide it and use <button> element for interaction, like so:

<button (click)="fileInput.click()">Upload</button>

<input
  #fileInput
  [ngmDropzoneOverlay]="customDropzoneComponent"
  [formControl]="fileControl"
  [accept]="accept"
  [multiple]="true"
  type="file"
  [hidden]="true"
/>

Running unit tests

Run nx test dropzone-overlay to execute the unit tests.

Dependencies (1)

Dev Dependencies (0)

    Package Sidebar

    Install

    npm i @ngx-misc/dropzone-overlay

    Weekly Downloads

    1

    Version

    0.0.1

    License

    none

    Unpacked Size

    58.6 kB

    Total Files

    14

    Last publish

    Collaborators

    • im.pankratov