Skip to main content
Version: 5.x

Migrating existing SPAs

If you're interested in migrating existing SPAs into a single-spa, you'll need to do three things:

  1. Create a single spa config
  2. Convert your SPA or SPAs to be registered applications
  3. Adjust your HTML file so that your single spa config is the new boss in town. See docs.

Converting SPAs into registered applications

Your existing SPAs, whether they be Angular, React, or something else, probably are not used to unmounting themselves from the DOM. Also, they probably have had the luxury of controlling the entire HTML page themselves, instead of being purely JavaScript applications that don't have sole control over <script> tags and <link> tags. So in order to convert them into single-spa registered applications, they will need to overcome those obstacles while implementing lifecycle functions.

(1) Implementing lifecycle functions

See the registered application lifecycle docs to see what you need to do. The hardest part will almost certainly be the unmount lifecycle, since most SPAs aren't accustomed to going dormant and unmounting themselves from the DOM. When implementing your lifecycle functions, first check out the ecosystem docs before reinventing the wheel yourself. If that doesn't have everything you need, you'll have to make sure that your SPA can clean up its DOM, DOM event listeners (all of them, but especially hashchange and popstate), and memory.

(2) Getting the CSS, fonts, <script> dependencies to work

Since existing SPAs are used to having an index.html file for their css, fonts, third party script-tags, etc., it's likely that you'll have to do some work to make sure all of those keep on working when your SPA becomes an html-less application. It is best to try to put all that you can into the JavaScript bundle, but your escape hatch is to put the things you need into your single spa config.