babel-plugin-inferno
v1.0.0-beta2
Turn JSX into Inferno virtual DOM
0/weekUpdated 1 months agoMPL-2.0
Published by lukeed
npm install babel-plugin-inferno
InfernoJS Babel Plugin
> Plugin for babel 6+ to enable JSX for Inferno
This plugin transforms JSX code in your projects to Inferno compatible virtual DOM.
It is recommended to use this plugin for compiling JSX for inferno. It is different to other JSX plugins, because it outputs highly optimized inferno specific createVNode calls. This plugin also checks children shape during compilation stage to reduce overhead from runtime application.
How to install
``bash`
npm i --save-dev babel-plugin-inferno
How to use
Add the plugin to your package.json and update the plugin section in your .babelrc file. Or if your Babel settings are located inside the package.json - update the plugin section there.
It's important that you also include the babel-plugin-syntax-jsxplugin.
Example on a .babelrc file that will work with Inferno:
Make sure inferno plugin is added before babel module transformers
`js`
{
"presets": [ "es2015" ],
"plugins": [["babel-plugin-inferno", {"imports": true}]]
}
Examples
`js
// Render a simple div
Inferno.render(
// Render a div with text
Inferno.render(
Hello world
, container);// Render a div with a boolean attribute
Inferno.render(
`
Fragments
All of the following syntaxes are reserved for createFragment call
`js
<>
Foo
Bar
Foo
Bar
Foo
Bar
`
React.Fragment is also compiled to inferno createFragment call to ease project migration to Inferno https://github.com/infernojs/babel-plugin-inferno/issues/56.
Special flags
This plugin provides few special compile time flags that can be used to optimize an inferno application.
`js
// ChildFlags:
- Children is rendered as pure text
- Children is another vNode (Element or Component)
- Children is always array without keys
- Children is array of vNodes having unique keys
- This attribute is used for defining children shpae runtime. See inferno-vnode-flags (ChildFlags) for possibe values
// Functional flags
`
Flag called
has been removed in v4, and is replaced by $HasVNodeChildrenOptions
Change in v4:
#### Imports (boolean)
babel-plugin-inferno will automatically import the required methods from inferno library.
There is no need to import inferno in every single JSX file. Only import the inferno specific code required by the application.
example:
js
import {render} from 'inferno'; // Just import what you need, (render in this case)// The plugin will automatically import, createVNode
render(
1, document.getElementById('root'));
`You need to have support for ES6 modules for this to work. If you are using legacy build system or outdated version of webpack, you can revert this change by using
js
{
"presets": [ "es2015" ],
"plugins": [["inferno", {
"imports": false
}]]
}
`
#### Pragma
Each method that is used from inferno can be replaced by custom name.
pragma ` (string) defaults to createVNode.` pragmaCreateComponentVNode ` (string) defaults to createComponentVNode.
` pragmaNormalizeProps ` (string) defaults to normalizeProps.
` pragmaTextVNode ` (string) defaults to createTextVNode.` pragmaFragmentVNode ` (string) defaults to createFragment.
`js
{
"presets": [ "es2015" ],
"plugins": [["inferno", {
"imports": true,
"pragma": "",
"pragmaCreateComponentVNode": "",
"pragmaNormalizeProps": "",
"pragmaTextVNode": ""
}]]
}
`$3
You can verify
is used by looking at the compiled output.
This plugin does not generate calls to createElement or h, but instead it uses low level InfernoJS API
createVNode, createComponentVNode, createFragment etc. If you see your JSX being transpiled into createElement` callsits good indication that your babel configuration is not correct.