Search code examples
google-chromegoogle-chrome-extensiongoogle-chrome-devtools

Chrome extensions: Use the "background.service_worker" key instead manifest_version 3


When trying to install a chrome extension using manifest_version 3, I am unable to install as I keep getting the error:

The "background.scripts" key cannot be used with manifest_version 3. Use the "background.service_worker" key instead

or

The "background.persistent" key cannot be used with manifest_version 3. Use the "background.service_worker" key instead.


Solution

  • Manifest V3 no longer supports background pages. Instead it now supports a new feature called service workers.

    The key background in your manifest.json can no longer contain the field persistent, and also update the value from scripts to service_worker. Service worker cannot contain an array but can only contain a single string value.

    Eg:

    {
      "name": "Test",
      "description" : "Test Chrome Extension",
      "version": "1.0",
      "manifest_version": 3,
      "background": {
        "service_worker": "background.js"
      }
    }
    

    Ref: Manifest V3 Migration Checklist