You can now use the Wix JavaScript SDK instead of Velo APIs for most functionality when developing sites or building apps with Blocks. This marks the beginning of a gradual transition from using Velo APIs to using the next generation SDK.
You are encouraged to start using the SDK in all new and ongoing development projects. To learn how to migrate existing Velo code to the SDK, see Migrate from Velo to the SDK.
Wix has chosen to invest its future efforts in the Wix JavaScript SDK for the following reasons:
- Industry standards: The SDK follows current industry standards for web development, such as the use of npm modules. This lowers the barrier to entry for professional web developers.
- Stability: The use of npm modules allows us to provide a better versioning experience. Once you have your code working with a specific version of a module, you can be sure that your code will always continue to work with that version. This also puts you in control of when and where you want to use updated modules.
- Cross-Wix alignment: The SDK is already used by Wix App and Wix Headless developers when building their projects. It is also used internally by Wix's own developers. Now that site developers will use the SDK as well, Wix can increase the efficiency of the rollout process for new functionality and documentation. This alignment also means that site developers will have an easier time creating apps and headless projects, should they choose to do so.
At the current stage in the process of transitioning from Velo APIs to the SDK:
- All Velo APIs will continue to work as usual.
- The SDK will receive all new functionality updates.
- The Velo API will continue to receive updates to the
$w and $widget APIs.
- All other Velo APIs will not receive any more updates.
- Some functionality in the Velo API is not yet supported in the SDK.
- Some documentation in the Develop Websites portal, including tutorials and code examples, still use Velo APIs for the time being.
- The Website Dev Assistant still uses Velo APIs in its responses.
- This reference has been restructured to indicate which API modules are currently transitioning to the SDK.
In future stages of the transition process:
- All Velo functionality will be supported in the SDK.
- The documentation in this portal will use the SDK in tutorials and code examples.
- The Website Dev Assistant will use the SDK in its responses.
- Velo APIs will be deprecated.
The transition to the SDK is a gradual process. At this stage, not all Velo APIs have SDK equivalents that can be used in the context of site development or app creation with Blocks. The Velo API reference has been restructured to reflect this and now consists of the following sections:
- Velo-Only APIs: These Velo APIs do not have equivalents in the SDK. If you want to use the functionality of these APIs, you need to continue to use the existing Velo APIs.
- APIs: These Velo APIs already have corresponding SDK versions. If you want to use the functionality of these APIs, we recommend that you use their SDK equivalents.
- Events & Service Plugins: Most of these Velo APIs have SDK counterparts. However, the SDK counterparts don't currently support site development or app creation with Blocks. Included in this section are APIs for backend event handlers, service plugins, data hooks, and routers. If you want to use the functionality of these APIs for these purposes, you should continue using the existing Velo APIs.