Module preference
To preference a module - to take-over another NPM or virtual module. To take-over means to completely replace an implementation, the original module will not be available.
To preference a module, set the
scandipwa.preference
field of package.json
equal to the desired module name.This is very dangerous to preference a real NPM module, like in example
react
or redux
. While you can do this, this feature is meant for virtual module preference.Create ScandiPWA App introduces the concept of "virtual module".
Virtual module - a non-existing module, referenced in the code. It provides an abstraction layer, which allows to swap the implementation.
Virtual modules are useful for UI elements, where different libraries could be used as an implementation, or for an API endpoints, where the application is relying on data format, not the source of the data.
To create a virtual module, define the reference to a non existing module, and implement a preference in your extension to it. To ensure that it does not exist, use
@virtual-module/<name>
name for it.