@github/clipboard-copy-element
    TypeScript icon, indicating that this package has built-in type declarations

    1.1.2 • Public • Published

    <clipboard-copy> element

    Copy element text content or input values to the clipboard.

    Installation

    $ npm install --save @github/clipboard-copy-element
    

    Usage

    import '@github/clipboard-copy-element'
    <clipboard-copy for="blob-path" class="btn btn-sm BtnGroup-item">
      Copy path
    </clipboard-copy>
    <div id="blob-path">src/index.js</div>

    Data sources

    Attribute

    <clipboard-copy value="src/index.js">Copy</clipboard-copy>

    Element content

    <clipboard-copy for="blob-path">Copy</clipboard-copy>
    <div id="blob-path">src/index.js</div>

    Form input

    <clipboard-copy for="blob-path">Copy</clipboard-copy>
    <input id="blob-path" value="src/index.js">

    Hyperlink href

    <clipboard-copy for="blob-path">Copy full URL</clipboard-copy>
    <a id="blob-path" href="/path/to#my-blob">Link text will not be copied</a>

    Events

    After copying to the clipboard, a clipboard-copy event is dispatched from the <clipboard-copy> element:

    document.addEventListener('clipboard-copy', function(event) {
      const button = event.target
      button.classList.add('highlight')
    })

    Browser support

    Browsers without native custom element support require a polyfill.

    • Chrome
    • Firefox
    • Safari
    • Microsoft Edge

    Development

    npm install
    npm test
    

    License

    Distributed under the MIT license. See LICENSE for details.

    Keywords

    Install

    npm i @github/clipboard-copy-element

    DownloadsWeekly Downloads

    7,605

    Version

    1.1.2

    License

    MIT

    Unpacked Size

    12.2 kB

    Total Files

    8

    Last publish

    Collaborators

    • jfuchs
    • githubbot
    • manuelpuyol
    • jonrohan
    • broccolini
    • mislav
    • mdo
    • primer-css
    • keithamus
    • mschoening
    • koddsson
    • emilybrick
    • lgarron
    • colebemis
    • smockle
    • simurai
    • khiga8
    • dustin.greif
    • srt32