CxJS uses React (or a React compatible library like Preact) for DOM manipulation and offers many high-level, UI related, features on top of it.
There are many examples and learning materials available:
This is a monolith repository used to develop main npm packages, documentation, widget gallery and fiddle. It uses yarn workspaces, so please use
yarn to install packages and run the applications.
$ yarn install
CxJS is available as an NPM package -
cx, which includes
compiled code, source code and TypeScript definitions.
cx package, you'll need other packages such as
You'll also need to configure Babel and webpack.
The quickest way to setup a new project is to use CLI:
md my-app cd my-app npm init -y npm install cx-cli --global cx scaffold npm start
Alternatively, you can download the files from one of the CodeSandbox template projects:
Once you create a new project, you may want to try our ready-to-use themes:
Install a theme using
npm install cx-theme-frost
my-app/app/index.scss and replace
@import "~cx/src/variables"; @import "~cx/src/index";
@import "~theme-package-name/src/variables"; @import "~theme-package-name/src/index";
Please read theme documentation to learn how to enable theme specific features.
Alternatively, start by forking one of the available boilerplate projects:
CxJS Hacker News is a Progressive Web App focused on startup performance. The application is based on Preact and uses webpack plugins to enable preloading, inline CSS and JS, configure service workers and achieve other performance gains.
Worldoscope uses CxJS to visualize data available from the World Bank website. Google Firebase is used to store report definitions, authentication and hosting.
Cx Starter Kit is full blown admin and dashboard application template with many sample pages.
CxJS based TODO app featuring a dark theme, keyboard navigation, markdown support, custom CSS and much more.
CxJS is is free for up to two developers per company. Commercial use requires a license. Additional free commercial licenses are available for startups and open-source contributors upon request. Please refer to the website for more information.