This is the 5th post of series in which we are going to explore the usage of React with JSPM.
You could find links to all parts of series below:
- React and ES6 - Part 1, Introduction into ES6 and React
- React and ES6 - Part 2, React Classes and ES7 Property Initializers
- React and ES6 - Part 3, Binding to methods of React class (ES7 included)
- React and ES6 - Part 4, React Mixins when using ES6 and React
- React and ES6 - Part 5, React and ES6 Workflow with JSPM
- React and ES6 - Part 6, React and ES6 Workflow with Webpack
The code corresponding to this article is available at GitHub.
Update from 18.06.2016: Fixed the JSPM version because of the problem found by Mahdi (refer to a comments below the article). Thanks!
What is JSPM?
What if we don’t want to mess with all that and want to start coding in 15 minutes? We just want to have a tool which will allow this.
- It allows you to install dependencies from different registries - npm or github.
- JSPM has ES6+ support out of the box.
- You are able to load CSS / images / fonts / other formats of files without additional hassle. That is possible with a help of plugins (described later in this article).
- JSPM makes it easy to prepare your files for production use.
In this post, we will re-create project from previous posts, but using JSPM.
I would also recommend you to go through JSPM wiki.
Initial setup our JSPM + React project
First of all run this command:
install -g email@example.com
update from 18.06.2016 we have to fixate the version because of some further problems with newer version of JSPM. Please refer to Mahdi in a comments below the article.
This will install JSPM as a global npm module. After that, it would be possible to use
jspm command from any place in your system.
Next, go to your project directory and run
jspm init and provide default answers for all prompts.
The output in your terminal should look like this:
You will have to wait while JSPM is doing its own magic.
It will download all the initial dependencies needed (like babel etc.) and place them to the folder named
(I advise you to add this folder in .gitignore).
jspm_packages folder is used by JSPM for storing and managing packages like jQuery / React / AngularJS etc. which you eventually would use inside your project.
Looks like already familiar
bower_components , isn’t it?
But there is a big difference in the case of
jspm_packages folder. It is used by JSPM to store dependencies from multiple sources (from Github / npm / bower).
What’s even nicer - inside your code you are able to treat all the dependencies as identical not dependable whether it’s coming from npm or Github repository.
Install needed dependencies
Next thing that will be produced after running
jspm init is a file named
First of all,
config.js provides configuration for versions of dependencies we install.
Additionally, you are able to rename your packages to the name you like the most.
Let’s understand what I mean by all that. Run this command:
If you’ll take a look at
config.js now you should see excerpt like below:
Now it’s possible to use this module inside the code by its name
Let’s say we don’t like this name and would like to reference it as
jsx inside our code.
Run following commands:
Our plugin will be now referenced as
jsx and you could include it into your code by
(though we don’t need to do that as this package is JSPM plugin).
By the way, the package we’ve just installed will be needed for our project (JSPM doesn’t support loading of JSX files by default).
So don’t delete
jspm-loader-jsx package :)
Let’s install other packages we are going to use:
We haven’t used
github: prefix here because JSPM has the registry of commonly used packages.
It’s located here and you could always add a package to the list by opening a new PR.
If you want to dive deeper I recommend reading this JSPM wiki article.
config.js find key named
babelOptions and replace it with following lines:
This is needed to make Babel (which is one of default JSPM packages installed into
jspm_packages) support all the experimental features like class properties.
Finishing project structure
Now it’s time to code something. I won’t copy their source code as it’s very similar to what we’ve written in previous parts of series.
Create a file named
app.jsx with content copied from this location.
Next, create file
cartItem.jsx and copy it from here.
I hope that you are already familiar with contents of that files. It should be like so if you’ve read previous posts from this series.
Grab the contents of
Following is the interesting part for us:
On the first line, we include SystemJS, on the second one we include
config.js that is created by JSPM.
System.import('app.jsx!'); (*) we load entry point script
app.jsx which then loads everything else.
We are basically done. Now open
index.html in your browser. You should see image like below:
(*) Notice the
! sign in
Additional features of JSPM
What we’ve covered in this article is not all the features of JSPM.
Below are notable features I would like to highlight:
JSPM supports different formats of modules. So it’s absolutely legal to load some require.js module along with ES6 class in the same file.
Read more info about module loaders available in JSPM.
Loading of text files, CSS, and other assets via JSPM
For example, run this command:
Building for production
You could concatenate & minify your source code with JSPM without using additional tools.
Run the following command from application directory:
And you will have single minified file with all modules / dependencies included.