jsx-xml
TypeScript icon, indicating that this package has built-in type declarations

0.2.3 • Public • Published

jsx-xml

Generate xml string from jsx

Build Status codecov

install

Add jsx-xml packages

yarn add jsx-xml 

or

npm install jsx-xml --save 

You need to add the babel-plugin-transform-react-jsx package if not already installed.

usage

/** @jsx JSXXML */
import {render, JSXXML} from 'jsx-xml'
 
const xml = render(<test x="3">1 + {2} = {3}</test>) // jsx input
console.log(xml) // xml output: <?xml version="1.0"?><test x="3">1 + 2 = 3</test> 

API

You can import the following functions from the jsx-xml package:

import {render, JSXXML, CData, Comment, Fragment, Raw} from 'jsx-xml'

render

render(jsx, options) converts jsx (JSXXML output) to xml string.

options:

My favorite options is:

const options = {createOptions: {headless: true}, endOptions: {pretty: true}}

JSXXML

JSXXML(type, attr, ...children) is a jsx pragma.

  • type: string or function

If type is a string, it will be considered and used as an xml tag. In case the jsx tag is in lowercase, it will be considered as a string in compile time. (e.g. <test />)

If type is a function, the output of the JSXXML function will equal that of type when called with parameters attr and children.

If you need a non-lowercase xml tag, you can create a variable named Capitalized and use it in your jsx script.

Examples:

The JSX code:

/** @jsx JSXXML */
 
const Banner = ({color, size, children}) => { /* ... */ };
 
<Banner color="blue" size={2}>
  Click Star
</Banner>

compiles into:

/** @jsx JSXXML */
 
const Banner = ({ color, size, children }) => {/* ... */};
 
JSXXML(
  Banner,
  { color: "blue", size: 2 },
  "Click Star"
);

You can also use the self-closing form of the tag if there are no children:

/** @jsx JSXXML */
 
<user username="Bob" />

compiles into:

/** @jsx JSXXML */
 
JSXXML("user", { username: "Bob" });

CData

This tag allows you to add cdata to your xml output.

/** @jsx JSXXML */
import { render, JSXXML, CData } from 'jsx-xml'
 
const xml = render(<test x="3"><CData>this is an example {'cdata'}</CData></test>, options)

output:

<test x="3">
  <![CDATA[this is an example cdata]]>
</test>

Comment

This tag allows you to add comments to your xml output.

/** @jsx JSXXML */
import { render, JSXXML, Comment } from 'jsx-xml'
 
const xml = render(<test><Comment>1 + {2} = {3}</Comment></test>, options)

output

<test>
  <!-- 1 + 2 = 3 -->
</test>

Fragment

This tag allows you to return more than one element. Fragment is useful in functions.

import { render, JSXXML, Fragment } from 'jsx-xml'
 
const Items = () => <Fragment>
  <item value="1" />
  <item value="2" />
</Fragment>
 
const xml = render(<items>
  <Items />
</items>, options)

output:

<items>
  <item value="1"/>
  <item value="2"/>
</items>

Raw

This tag allows you to add data to your xml without escaping.

/** @jsx JSXXML */
import { render, JSXXML, Raw } from 'jsx-xml'
 
const data = 'this text contain < and > and & and ;'
const xml = render(<items>
  <x>{data}</x>
  <y><Raw>{data}</Raw></y>
</items>, options)

output:

<items>
  <x>this text contain &lt; and &gt; and &amp; and ;</x>
  <y>this text contain < and > and & and ;</y>
</items>

How to config babel for jsx-xml

You can include /** @jsx JSXXML */ at the first line of your file or pass it as pragma param to the transform-react-jsx plugin present in .babelrc:

{
  "plugins": [
    [
      "transform-react-jsx",
      {
        "pragma": "JSXXML"
      }
    ]
  ]
}

You can also use babel-plugin-jsx-pragmatic to avoid importing JSXXML in every page.

{
  "plugins": [
  [
    "jsx-pragmatic",
      {
        "module": "jsx-xml",
        "import": "JSXXML",
        "export": "JSXXML"
      }
    ]
  ]
}

Readme

Keywords

none

Package Sidebar

Install

npm i jsx-xml

Weekly Downloads

118

Version

0.2.3

License

MIT

Unpacked Size

33.2 kB

Total Files

16

Last publish

Collaborators

  • smmoosavi