Search code examples
javascriptgoogle-chrome-extensioncopy-paste

Copy to clipboard in chrome extension V3


I am developing a chrome extension V3. I want to copy content to clipboard in my JS file.
The manifest.json as below,

    "background" :{
        "service_worker" :"eventPage.js"
    },
    "permissions" : [
        "contextMenus",
        "clipboardWrite"      
    ]

I have try 2 solution for copy feature.

Solution 1:

    const el = document.createElement('textarea');
    el.value = str;
    el.setAttribute('readonly', '');
    el.style.position = 'absolute';
    el.style.left = '-9999px';
    document.body.appendChild(el);
    el.select();
    document.execCommand('copy');
    document.body.removeChild(el);
  

The result:

Error in event handler: ReferenceError: document is not defined at copyToClipboard 

Solution 2:

navigator.clipboard.writeText(str);

The result:

Error in event handler: TypeError: Cannot read properties of undefined (reading 'writeText')

The chrome extension is run as a service worker. So it seems I can't access DOM document and have no grant of writeText. Does anyone have another suggestion?

Thanks.


Solution

  • I'll follow the excellent suggestion wOxxOm gave you, elaborating it in a concrete example. What you want to do is have a ContentScript.js that runs on any active tab with a web page, since you can't access the DOM from the backGround.js, and then send a message to this script, from where you would copy to the clipboard.

    manifest.json

        "background" :{
            "service_worker" :"eventPage.js"
        },
        "permissions" : [
            "contextMenus",
            "clipboardWrite"      
        ],
       "content_scripts": [ // this is what you need to add
          {
             "matches": [
                "<all_urls>"
             ],
             "js": ["content.js"]
          }
       ],
    

    From the background.js, you would send a message, that will be handled in the ContentScript.js

    background.js

    chrome.tabs.query({active: true, currentWindow: true}, function(tabs) {
        chrome.tabs.sendMessage(tabs[0].id, 
            {
                message: "copyText",
                textToCopy: "some text" 
            }, function(response) {})
    })
    

    In the contentScript.js, you would catch the message and copy it to the clipboard.

    content.js

    chrome.runtime.onMessage.addListener( // this is the message listener
        function(request, sender, sendResponse) {
            if (request.message === "copyText")
                copyToTheClipboard(request.textToCopy);
        }
    );
    
    async function copyToTheClipboard(textToCopy){
        const el = document.createElement('textarea');
        el.value = textToCopy;
        el.setAttribute('readonly', '');
        el.style.position = 'absolute';
        el.style.left = '-9999px';
        document.body.appendChild(el);
        el.select();
        document.execCommand('copy');
        document.body.removeChild(el);
    }