svelte-copy

Svelte Copy

Works with Svelte 3 & 4!

Ever wanted to copy something to clipboard? Say hello to Svelte Copy ✨

Demo

Installing

npm install svelte-copy -D

Using

Let's make a button that when you click it copies Hello World to the clipboard:

<script>
    import { copy } from 'svelte-copy';
</script>

<button use:copy={'Hello World'}>
    Click me!
</button>

Events

There are some custom events you can use on elements that have the copy action:

• on:svelte-copy This will fire when text is copied, you have access to the copied text if needed with event.detail:

  <button
      use:copy={'Hello from alert'}
      on:svelte-copy={(event) => alert(event.detail)}>
      Click to cause alert on copy
  </button>
  

• on:svelte-copy:error This event will fire if there is an error in copying to clipboard, you have access to the error with event.detail:

  <button
      use:copy={'Some text'}
      on:svelte-copy:error="{(event) =>
          alert(`There was an error: ${event.detail.message}`)}">
      Click to cause alert on copy
  </button>
  

Custom Triggers

By default, copy action is fired on click event. You can change this behavior by passing an object with the name or names of the events that you want to trigger the copy action.

<button
    use:copy={{ text: 'Hello' , events: ['touchstart', 'mouseenter']}}
    on:svelte-copy={(event) => alert(event.detail)}>
    Move cursor over button or touch button to cause alert on copy
</button>

Copy Text

We also include a helper called copyText if you want to use the logic of this package without the action. Make sure you only call this in the browser!

<script>
    import { copyText } from 'svelte-copy';
</script>

<button on:click={() => copyText('Hello World!')}>
    Copy something
</button>

Support

• Join the discord
  
• Create a issue on the github