@compactjs/clipboard
Copy to clipboard.
· Homepage · View Demo · Report Bug / Request Feature ·
Table of Contents
Install
NPM:
npm install @compactjs/clipboard
CDN:
<script src="https://unpkg.com/@compactjs/clipboard/dist/index.umd.js"></script>
Usage
As module:
import { clipboard } from '@compactjs/clipboard';
API:
/**
* Copy text to clipboard.
* @param input Either text to copy or HTMLElement to copy from
*/
function clipboard(
input: string | HTMLTextAreaElement | HTMLInputElement
): void;
Note: A copy to clipboard need to be triggered by user action, like a button press!
Example:
document
.getElementById('copy-string')
.addEventListener('click', () =>
clipboard('This text is going to be copied.')
);
Have a look at the example.
Or checkout the demo.
Run tests
npm run test
Contact
- Website: https://timobechtel.com
- Twitter: @TimoBechtel
- GitHub: @TimoBechtel
🤝 Contributing
Contributions, issues and feature requests are welcome!
- Check issues
- Fork the Project
- Create your Feature Branch (
git checkout -b feat/AmazingFeature
) - Test your changes
npm run test
- Commit your Changes (
git commit -m 'feat: add amazingFeature'
) - Push to the Branch (
git push origin feat/AmazingFeature
) - Open a Pull Request
Commit messages
This project uses semantic-release for automated release versions. So commits in this project follow the Conventional Commits guidelines. I recommend using commitizen for automated commit messages.
Show your support
Give a
📝 License
Distributed under the MIT License.
This README was generated with