https://github.com/hackingharold/ngx-dropzone
The missing file input component for Angular Material.
https://github.com/hackingharold/ngx-dropzone
angular cdk drag drop dropzone file material ng ngx upload
Last synced: 27 days ago
JSON representation
The missing file input component for Angular Material.
- Host: GitHub
- URL: https://github.com/hackingharold/ngx-dropzone
- Owner: hackingharold
- License: mit
- Created: 2023-03-16T22:16:24.000Z (about 3 years ago)
- Default Branch: main
- Last Pushed: 2025-04-18T11:00:27.000Z (about 1 year ago)
- Last Synced: 2025-04-19T00:37:15.486Z (about 1 year ago)
- Topics: angular, cdk, drag, drop, dropzone, file, material, ng, ngx, upload
- Language: TypeScript
- Homepage:
- Size: 3.33 MB
- Stars: 47
- Watchers: 1
- Forks: 6
- Open Issues: 0
-
Metadata Files:
- Readme: readme.md
- Contributing: .github/CONTRIBUTING
- License: LICENSE
- Code of conduct: .github/CODE_OF_CONDUCT
- Security: .github/SECURITY
Awesome Lists containing this project
- awesome-angular - @hackingharold/ngx-dropzone - The missing file input component for Angular Material. (Third Party Components / Drag and Drop)
- fucking-awesome-angular - @hackingharold/ngx-dropzone - The missing file input component for Angular Material. (Third Party Components / Drag and Drop)
README
# ngx-dropzone
[](https://stackblitz.com/edit/ngx-dropzone-showcase?file=src%2Fmain.ts)
[](https://github.com/hackingharold/ngx-dropzone/blob/HEAD/LICENSE)
[](https://www.npmjs.org/package/@ngx-dropzone/cdk)
[](https://www.npmjs.org/package/@ngx-dropzone/material)
This library provides a reusable dropzone component infrastructure and Material
Design implementation.
Like the Angular Material repo, it uses a monorepo setup for maximum extensibility.
| Package | Description |
| ------------------------ | ------------------------------------------------ |
| `@ngx-dropzone/cdk` | Common dropzone interaction patterns. |
| `@ngx-dropzone/material` | Material Design implementation based on the CDK. |
While the CDK itself is basically headless, the Material implementation relies
on the [Angular Material components](https://github.com/angular/components) to
provide a consistent style integration.
See the [DEMO](https://stackblitz.com/edit/ngx-dropzone-showcase?file=src%2Fmain.ts) for an example.
## Installation
You may only want to install the dropzone CDK to apply your own styling.
```sh
npm install @ngx-dropzone/cdk
```
For the Material Design implementation, install both packages.
```sh
npm install @ngx-dropzone/cdk @ngx-dropzone/material
```
## Versioning
For the versioning, we stay consistent with the major Angular releases.
So Angular (components) 21 will be compatible with `@ngx-dropzone/cdk@21.x.x`.
Please note, that v16 is the first officially supported version.
For older Angular releases, use the libs at your own risk.
## Using CDK Only (Without Material)
If you want to use the dropzone functionality with your own styling, you can use just the CDK package. The CDK exports are **standalone** and ready to use in modern Angular applications without any modules.
### Available CDK Exports
```ts
import {
// Components & Directives
DropzoneComponent, // Standalone component:
FileInputDirective, // Standalone directive: input[fileInput]
// Services
DropzoneService,
AcceptService,
// Validators & Types
FileInputValidators,
FileInputValue, // Type: File | File[] | null
} from '@ngx-dropzone/cdk';
```
### Minimal Example
```ts
// app.component.ts
import { Component, FormControl } from '@angular/core';
import { ReactiveFormsModule } from '@angular/forms';
import {
DropzoneComponent,
FileInputDirective,
FileInputValidators,
FileInputValue
} from '@ngx-dropzone/cdk';
@Component({
selector: 'app-root',
imports: [
ReactiveFormsModule,
DropzoneComponent,
FileInputDirective,
],
template: `
@if (fileCtrl.value) {
{{ getFileCount() }} file(s) selected
}
`,
styles: [`
ngx-dropzone {
display: block;
padding: 40px;
border: 2px dashed #ccc;
border-radius: 8px;
text-align: center;
cursor: pointer;
transition: border-color 0.3s;
}
ngx-dropzone.dragover {
border-color: #2196f3;
background-color: #e3f2fd;
}
ngx-dropzone.disabled {
opacity: 0.5;
cursor: not-allowed;
}
`],
})
export class AppComponent {
fileCtrl = new FormControl(null, [
FileInputValidators.accept('image/*'),
FileInputValidators.maxSize(5 * 1024 * 1024), // 5MB
]);
getFileCount(): number {
const value = this.fileCtrl.value;
return Array.isArray(value) ? value.length : value ? 1 : 0;
}
}
```
The `DropzoneComponent` automatically adds CSS classes for styling:
- `.dragover` - when files are dragged over the dropzone
- `.disabled` - when the file input is disabled
- `.focused` - when the dropzone has focus
- `.ng-valid`, `.ng-invalid`, `.ng-touched`, `.ng-pristine`, `.ng-dirty` - Angular form states
For more details on validation and configuration options, see the sections below.
## Basic usage (Material Design)
This describes how to use the Material dropzone implementation.
If you want to use just the CDK with your own styling, see the "Using CDK Only" section above.
For advanced customization through component extension, see the Extensibility section below.
```ts
// in app.component.ts
import { MatFormField, MatLabel } from '@angular/material/form-field';
import { MatIcon } from '@angular/material/icon';
import { FileInputDirective } from '@ngx-dropzone/cdk';
import { MatDropzone } from '@ngx-dropzone/material';
@Component({
...
imports: [
MatFormField,
MatLabel,
MatIcon,
MatDropzone,
FileInputDirective,
],
...
})
```
Now you can use it in your markup.
```html
Drop anything!
cloud_upload
```
Use the `webkitdirectories` attribute to support uploading folders.
All files from subdirectories will be provided as a flat `File[]`, but with an additional `relativePath` property to keep tree structures.
## Usage with FormControl and validation
The `fileInput` directive on the `` element makes it a valid target
for `[(ngModel)]` and `[formControl]` directives, so you can seamlessly integrate the
file upload into your form.
First, make sure to import the `ReactiveFormsModule`.
Then, you're able to define your form control element (incl. validation).
```ts
// in app.component.ts
import { ReactiveFormsModule } from '@angular/forms';
@Component({
selector: "form-control-dropzone",
imports: [
ReactiveFormsModule,
MatError,
...
],
template: `
Invalid file type
`,
})
class DropzoneWithFormControl {
validators = [FileInputValidators.accept("image/*")];
profileImg = new FormControl(null, this.validators);
}
```
In the example above, you may have noticed two new classes, the `FileInputValidators` and `FileInputValue`.
The `FileInputValue` is just a type alias for `File | File[] | null` being the possible
values for the form control. Please note that a `File[]` is only valid, if the `multiple`
attribute is set on the `` element.
The `FileInputValidators` provides custom validator functions for files.
| Validator | Description |
| ----------------------------- | --------------------------------------------- |
| `FileInputValidators.accept` | Defines accepted file types. |
| `FileInputValidators.minSize` | Sets the required minimum file size in bytes. |
| `FileInputValidators.maxSize` | Sets the maximum allowed file size in bytes. |
## File Previews
In case you want to give a consistent user feedback about the selected
files, we recommend to use the [Material Chips](https://material.angular.io/components/chips/overview).
⚠️ Please note that no other file preview will be provided by this lib,
because people are way too opinionated about their styling and behaviour.
```html
Drop anything!
@if (fileCtrl.value) {
{{ fileCtrl.value.name }}
cancel
}
cloud_upload
```
```ts
export class AppComponent {
fileCtrl = new FormControl();
clear() {
this.fileCtrl.setValue(null);
}
}
```
## Configuration
Now that we have seen the minimal setup, here are some configuration options for the component markup.
### FileInput directive
| Property | Description | Options |
| ---------- | ------------------------------------------------------------------------------------------------ | --------------------------------------------------------------------------------------- |
| `accept` | Defines the accepted file types. | See [here](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/input/file#accept) |
| `mode` | On select, either replace (default) or append the new files. Works only with multiple attribute. | `replace` or `append` |
| `multiple` | Allow multiple files to be selected. | `Boolean` |
| `disabled` | Disables any interaction. | `Boolean` |
### Material dropzone
| Property | Description |
| ------------- | ---------------------------------------------------------------- |
| `required` | Sets the native required property. |
| `placeholder` | The placeholder text has no effect, use `` instead. |
## Development server
Run `npm run start:[cdk|material]` to build and watch for changes on the
library packages.
Run `npm run start:app` for an example app dev server to test changes locally. Navigate to `http://localhost:4200/`. The app will automatically reload if you change any of the source files.
Other available commands are `npm run [build|test|lint]:[cdk|material]`.
## Extensibility
This library provides a ready-to-use Material Design implementation for the dropzone.
However, you might want to apply your own custom styling (or library).
**Note:** For most use cases, you can use `DropzoneComponent` directly with your own CSS as shown in the "Using CDK Only" section above. Only extend `DropzoneComponent` if you need to add custom behavior or encapsulate complex styling in a reusable component.
If you want to create your own dropzone component, you can extend the `DropzoneComponent` from the CDK. See the [Material dropzone](/projects/material/src/lib/mat-dropzone/mat-dropzone.component.ts) as an example.
The basic setup requires you to create a standalone component that extends `DropzoneComponent` and import the required directives.
Use the following skeleton as a starting point. You may always have a look at the
Material reference implementation linked above.
```ts
import { Component } from "@angular/core";
import { AcceptService, DropzoneComponent, DropzoneService, FileInputDirective } from "@ngx-dropzone/cdk";
@Component({
selector: "my-dropzone",
imports: [FileInputDirective, DropzoneComponent],
providers: [DropzoneService, AcceptService],
template: `
`,
styles: [
`
.my-dropzone {
cursor: pointer;
text-align: center;
padding: 40px;
background: platinum;
border: 1px solid black;
}
.dragover > .my-dropzone {
border-width: 2px;
}
`,
],
})
export class MyDropzone extends DropzoneComponent {}
```
## Contributing
### Code of Conduct
Please read our `Code of Conduct` to keep our community open and respectable. 💖
### Want to Help?
Want to report a bug, contribute some code, or improve the documentation? Excellent! Read up on our guidelines for contributing and then check out one of our issues labeled as `help wanted` or `good first issue`.
### Security
If you believe you have found a security vulnerability, we encourage you to responsibly disclose this and not open a public issue. Security issues in this open source project can be safely reported via `hackingharold@mailbox.org`.
### License
This project is MIT-licensed.