NgxCopyToClipboard

Click to copy — a fast, lightweight Angular directive to copy text to the clipboard using the modern Clipboard API.

Why Is Copy to Clipboard Useful?

The ngxCopyToClipboard directive provides a seamless way for users to quickly copy content without the need to manually select or retype it. This is especially useful in forms, code snippets, confirmation flows, and other UI/UX scenarios where content needs to be reused.

Installation

1. Install via NPM

1npm i --save @andreasnicolaou/ngx-copy-to-clipboard

2. Import the Directive Based on Your Angular Version

🟢 For Angular 15+ (Standalone Projects)

You can directly import the directive into any standalone component:

1import { NgxCopyToClipboardDirective } from '@andreasnicolaou/ngx-copy-to-clipboard';
2
3@Component({
4  standalone: true,
5  selector: 'your-component',
6  imports: [NgxCopyToClipboardDirective],
7  templateUrl: './your-component.html',
8})
9export class YourComponent {}

🟠 For Angular <15 or Module-Based Projects

Use the provided NgxCopyToClipboardModule:

1import { NgxCopyToClipboardModule } from '@andreasnicolaou/ngx-copy-to-clipboard';
2
3@NgModule({
4  declarations: [],
5  imports: [NgxCopyToClipboardModule],
6  exports: [],
7})
8export class YourModule {}

💡 Note: If you're using Angular 15+ but prefer NgModule-based architecture, you can also use the module wrapper for compatibility.

✨ Want to Add Toast Notifications?

If you’d like to show toasts or notifications when a user copies content, check out my brand new lightweight library — @andreasnicolaou/toastify. It integrates seamlessly and helps you display stylish, customizable toasts with minimal setup!

API Reference

Name	Type	Description
textToCopy	string	Text value to be copied to the clipboard.
successMessage	string	Optional message emitted on successful copy. Default: 'Successfully copied'.
errorMessage	string	Optional message emitted on copy failure. Default: 'Could not copy'.
onCopyEvent	EventEmitter<string>	Emits successMessage when copying succeeds.
onErrorEvent	EventEmitter<string>	Emits errorMessage when copying fails.

Example Usage

In the component:

1  const val = 'Hello World!';
2
3  public onSuccess(ev: string){
4      console.log(ev);
5  }
6
7    public onError(ev: string){
8      console.log(ev);
9  }
10

In the template:

1<button
2  ngxCopyToClipboard
3  [textToCopy]="val"
4  [successMessage]="'Copied to Clipboard'"
5  [errorMessage]="'Not copied to Clipboard'"
6  (onCopyEvent)="onSuccess($event)"
7  (onErrorEvent)="onError($event)"
8>
9  Copy
10</button>

Contribution

• Having an issue? or looking for support? Open an issue and we will get you the help you need.
• Got a new feature or a bug fix? Fork the repo, make your changes, and submit a pull request.

Support this project

If you find this project useful, please star the repo to let people know that it's reliable. Also, share it with friends and colleagues that might find this useful as well. Thank you :smile: