https://github.com/compactjs/clipboard
Copy to clipboard.
https://github.com/compactjs/clipboard
clipboard copy javascript
Last synced: 3 months ago
JSON representation
Copy to clipboard.
- Host: GitHub
- URL: https://github.com/compactjs/clipboard
- Owner: CompactJS
- License: mit
- Created: 2020-04-07T16:53:04.000Z (about 5 years ago)
- Default Branch: main
- Last Pushed: 2023-03-04T10:50:38.000Z (about 2 years ago)
- Last Synced: 2025-02-16T02:34:25.569Z (3 months ago)
- Topics: clipboard, copy, javascript
- Language: HTML
- Homepage: https://compactjs.github.io/clipboard/
- Size: 1.53 MB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 7
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
@compactjs/clipboard
Copy to clipboard.
·
Homepage
·
View Demo
·
Report Bug / Request Feature
·
## Table of Contents
- [Installation](#Install)
- [Usage](#usage)
- [Test](#run-tests)
- [Contact](#contact)
- [Contributing](#Contributing)
- [License](#license)
## Install
### NPM:
```sh
npm install @compactjs/clipboard
```
### CDN:
```html
```
## Usage
### As module:
```javascript
import { clipboard } from '@compactjs/clipboard';
```
API:
```typescript
/**
* 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:
```javascript
document
.getElementById('copy-string')
.addEventListener('click', () =>
clipboard('This text is going to be copied.')
);
```
Have a look at the [example](https://github.com/CompactJS/clipboard/blob/main/example/index.html).
Or checkout the [demo](https://compactjs.github.io/clipboard).
## Run tests
```sh
npm run test
```
## Contact
👤 **Timo Bechtel**
- Website: https://timobechtel.com
- Twitter: [@TimoBechtel](https://twitter.com/TimoBechtel)
- GitHub: [@TimoBechtel](https://github.com/TimoBechtel)
## 🤝 Contributing
Contributions, issues and feature requests are welcome!
1. Check [issues](https://github.com/CompactJS/clipboard/issues)
1. Fork the Project
1. Create your Feature Branch (`git checkout -b feat/AmazingFeature`)
1. Test your changes `npm run test`
1. Commit your Changes (`git commit -m 'feat: add amazingFeature'`)
1. Push to the Branch (`git push origin feat/AmazingFeature`)
1. Open a Pull Request
### Commit messages
This project uses semantic-release for automated release versions. So commits in this project follow the [Conventional Commits](https://www.conventionalcommits.org/en/v1.0.0-beta.2/) guidelines. I recommend using [commitizen](https://github.com/commitizen/cz-cli) for automated commit messages.
## Show your support
Give a ⭐️ if this project helped you!
## 📝 License
Distributed under the [MIT](https://github.com/CompactJS/clipboard/blob/main/LICENSE) License.
---
_This README was generated with ❤️ by [readme-md-generator](https://github.com/kefranabg/readme-md-generator)_