Documentation

Report Edit

NPM Packages

CxJS includes a number of NPM packages used for different purposes. This article provides an overview of all the packages which link directly to the npm website where you can find detailed information about each package.

General

cx This is the main package of the CxJS framework containing widgets, charts, data-binding and other UI related elements.
cx-cli Command Line Interface used to quickly create new CxJS applications.
cx-redux Enables use of Redux for application state management. See Source Code and Demo Project.
cx-google-maps CxJS wrapper for react-google-maps. See the Demo app and Source Code.

Virtual DOM

Virtual DOM packages connect CxJS with the library used for DOM manipulation.

cx-reactUse React for rendering.
cx-infernoUse Inferno for rendering.
cx-preactUse Preact for rendering.

Themes

Theme packages enable changing the appearance of CxJS applications.

cx-theme-aquamarineAquamarine theme.
cx-theme-darkDark theme.
cx-theme-materialMaterial theme.
cx-theme-frostFrost theme.

Babel

The following are the Babel plugins used for compiling CxJS applications:

babel-plugin-transform-cx-jsxConverts JSX into JS.
babel-plugin-transform-cx-imports Rewrites imports in order to access widgets from the src folder which results in smaller bundles in scenarios when tree-shaking is not work well.
babel-preset-cx-env Adds babel-preset-env and other Babel and Cx plugins required for CxJS applications.
cx-scss-manifest-webpack-plugin Generates the SCSS manifest which imports CSS for widgets that are used in the application. When using this plugin, CSS will not be imported for unused widgets.