{"maintainers":[{"name":"anonymous","email":"tim.beyer@gmail.com"}],"dist-tags":{"latest":"0.7.0"},"author":{"name":"Tim Beyer"},"description":"Converts html into a vtree","readme":"html-to-vdom [![Build Status](https://travis-ci.org/TimBeyer/html-to-vdom.svg?branch=master)](https://travis-ci.org/TimBeyer/html-to-vdom) [![Coverage Status](https://coveralls.io/repos/TimBeyer/html-to-vdom/badge.svg?branch=master&service=github)](https://coveralls.io/github/TimBeyer/html-to-vdom?branch=master)\n============\n\nAbout\n-----\n\nThis is yet another library to convert HTML into a [vtree](https://github.com/Matt-Esch/vtree).\nIt's used in conjunction with [virtual-dom](https://github.com/Matt-Esch/virtual-dom) to convert template based views into `virtual-dom` views.\n\nNote\n----\n\nAs of v0.7.0, HTML attribute parsing has been improved by using [React's list of attributes and properties](https://github.com/facebook/react/blob/c265504fe2fdeadf0e5358879a3c141628b37a23/src/renderers/dom/shared/HTMLDOMPropertyConfig.js) to decide what to set on the VNode. This means that you should experience better compatibility and full support for HTML5. Custom attributes are also no longer lower cased automatically. Inline SVG is not yet supported, but will be worked on for the next version.\n\nAs of v0.6.0, converting sibling nodes without an enclosing parent tag returns an array of type `VNode` instead of throwing an error\n\nAs of v0.5.1, `html-to-vdom` no longer supports browsers without a full ES5 implementation.\n\nAs of v0.3.0, the VNode and VText classes need to be passed in during library initialization from the `virtual-dom` module you are using. \nThis is to reduce incompatibilties you might have due to depending on a different version of `virtual-dom` than the one this library would use. \n\nUsage\n-----\n\n```javascript\nvar VNode = require('virtual-dom/vnode/vnode');\nvar VText = require('virtual-dom/vnode/vtext');\n\nvar convertHTML = require('html-to-vdom')({\n VNode: VNode,\n VText: VText\n});\n\nvar html = '
Foobar
';\n\nvar vtree = convertHTML(html);\nvar createElement = require('virtual-dom/create-element');\nvar el = createElement(vTree);\ndocument.body.appendChild(el);\n```\n\n#### Specifying a key\nIn order for `virtual-dom` to detect moves it needs a key. To specify your own custom method of finding a key pass in a method that takes the current tag and returns the key.\n\n```javascript\nvar convertHTML = require('html-to-vdom')({\n VNode: VNode,\n VText: VText\n});\n\nconvertHTML({\n getVNodeKey: function (attributes) {\n return attributes.id;\n }\n}, '
');\n```\n\nIf you have a single key method you can also pass the options first, allowing you to create a single bound method for all key lookups:\n\n```javascript\nvar convertHTMLWithKey = convertHTML.bind(null, {\n getVNodeKey: function (attributes) {\n return attributes.id;\n } \n});\n\nconvertHTMLWithKey('
');\n```\n\nCredits\n-------\n\nThanks to: \n* [@nkzawa](https://github.com/nkzawa) for making me aware of attribute lowercasing problems and submitting a PR to fix it\n* [@mattferrin](https://github.com/mattferrin) for noticing that promises could be removed from the API and contributing a PR to do so\n* [@tiagorg](https://github.com/tiagorg) for contributing a PR for style attribute parsing\n* [@dariusriggins](https://github.com/dariusriggins) for adding VNode key support\n* [@jsyang](https://github.com/jsyang) for removing the `lodash` dependency for a leaner build and [improved performance](http://jsperf.com/html-to-vdom-lodash-vs-native)\n* [@bregenspan](https://github.com/bregenspan) for making the dataset conversion standards-compliant\n* [@jesseditson](https://github.com/jesseditson) for adding `