As of v3, ScandiPWA supports frontend plugins - reusable extensions that once created can be used in any project utilizing ScandiPWA v3. These can be used to modify the functionality of almost any part of ScandiPWA.
Is a valid M2 package.
All of its M2-related directories must be located in its root, otherwise these contents are not going to be recognized by M2. The
scandipwa directory, if present, should be nested into an
src directory in the extension's root.
If it contains any frontend functionality - the
src/scandipwa directory with corresponding contents should be present.
If it contains any node dependencies - there must be a
package.json file with all of the dependencies neighboring the
Should follow the guidelines described in the plugin development guide
Should have a definitive installation and configuration guide in
README.md or a reference to one (either within the archive or online).
Implement an extension!
Create an empty
app directory and a
code directory inside of it.
Place your extension (M2 module) inside of the
code directory mentioned above.
Archive your extension - call the archive
<vendor>--<name> <version> for ScandiPWA <supported version(s)>. All the letters in the archive name are going to get converted to the lowercase by the marketplace.
See that your extension is installable following the guide beneath.
Follow the guide on the marketplace to create an account and submit your extension. All the other details regarding this process can be found there.
Download the desired extension from the marketplace
Unzip it, see the
app/code/<vendor>/<extension> like file structure inside.
app folder you unpacked from the extension with the
app directory of your Magento 2 instance.
magento se:up command so that the module is registered in the Magento. Check whether your module is installed properly with
Go to the
app/design/frontend/<vendor>/<theme> - your ScandiPWA installation directory. There, add
"<name>": "app/code/<vendor>/<theme>" to the
"extensions" block of the
Follow any additional instructions provided in the
Recompile the theme, flush caches if necessary.