Components

Clipboard

GitHub

A Stimulus controller to copy text to clipboard.

Installation

  1. Install the package

    $ yarn add @stimulus-components/clipboard

  2. Register the controller in your application

    app/javascript/controllers/index.js
    import { Application } from '@hotwired/stimulus'
import Clipboard from '@stimulus-components/clipboard'

const application = Application.start()
application.register('clipboard', Clipboard)

Example

Clipboard

Usage

app/views/index.html
<div data-controller="clipboard" data-clipboard-success-content-value="Copied!">
  <input type="text" value="Click the button to copy me!" data-clipboard-target="source" />

  <button type="button" data-action="clipboard#copy" data-clipboard-target="button">Copy to clipboard</button>
</div>

Configuration

AttributeDefaultDescriptionOptional
data-clipboard-success-content-value''Text to display on button.✅
data-clipboard-success-duration-value2000Duration in ms to display the success content on button.✅

data-clipboard-target="button" attribute is optional if you don't want to change the text of the button.

Extending Controller

You can use inheritance to extend the functionality of any Stimulus component:

app/javascript/controllers/clipboard_controller.js
import Clipboard from "@stimulus-components/clipboard"

export default class extends Clipboard {
  connect() {
    super.connect()
    console.log("Do what you want here.")
  }

  // Function to override on copy.
  copy() {}

  // Function to override when to input is copied.
  copied() {
    //
  }
}

This controller will automatically have access to targets defined in the parent class.

If you override the connect, disconnect or any other methods from the parent, you'll want to call super.method() to make sure the parent functionality is executed.

Sponsors

Stimulus Component is an MIT licensed open source project and completely free to use. However, the amount of effort needed to maintain and develop new features for the project is not sustainable without proper financial backing. You can support Stimulus Components development on GitHub Sponsors. 🙏

Contributing

Do not hesitate to contribute to the project by adapting or adding features ! Bug reports or pull requests are welcome.

Don't forget to drop a 🌟 on GitHub to support the project.

License

This project is released under the MIT license.