Skip to content

Latest commit

 

History

History
62 lines (41 loc) · 3.27 KB

README.md

File metadata and controls

62 lines (41 loc) · 3.27 KB
Raw

What is this?

This boilerplate has everything needed in order to use JSX with vanilla js:

  • a basic, unoptimized dom function for element creation
  • a webpack setup to easily allow modular code.

An example:

<App darkMode={false}>
  <div click={()=>{alert("hooray"!)}}>
    Hello Vanilla JSX!
  <div>
</App>

Note: Everything is untested, hooray! Issues appreciated.


Getting Started

  1. npm install
  2. npm run hot-dev-server - this will fire up webpack build on watch mode, and webpack-dev-server.
  3. All important code is in the 'dom' folder under src - most important is dom.js which is the function that babel substitutes for jsx.

JSX: end your filename with `.jsx` instead of `.js`, and webpack (using [string-replace-loader](https://www.npmjs.com/package/string-replace-loader)) will auto-insert the import necessary for writing jsx. You can also do this yourself, but why bother.

Custom components: supported out of the box using the React-like props object API (inluding children).


Caveats and Features

Events: I used the addEventListener event-type strings ("click", not "onClick") described here - an inline set of these is generated in src/dom/utils/eventTypes and checked against when a function prop on a native HTML object (i.e. div etc.) is detected - if the propname is unrecognized an error is thrown.

so <div click={()=>{}}/> is legal, whereas <div handler={()=>{}}/> will throw, because the event type "handler" is not recognized.

Styling: I added in a styled components wrapper that uses emotion and a very simple usage of the proxy API. So that's neat. If you don't like the bloat - you should uninstall emotion and just delete styled.js from the dom folder.

I wrote this wrapper to basically match the styled-components API, which I like. So for example:

  • styled.button or styled["button"] or styled("button") should all work.
  • styled(CustomComponent) should work for custom components.

Fragments are not supported.

Browser support: When I am not being payed for code I like to not be in constant pain. so I freely used Proxy, fromEntries, entries, spread etc. I didn't wan't to include babel and polyfill desicions in order to prevent bloat.

Event Listener Cleanup: the JSX dom function I wrote adds a cleanup function on elements with event listeners or children - i.e. el.cleanup = ()=>{...} - this function, when invoked, first removes all event listeners from the element registered initially, then recursively calls itself on all children passed initially. Adding a function to native objects might be a terrible idea, if you have an alternative I'd love to hear about it. I'm also not entirely sure it's necessary. Example:

const app = <App/>;
app.remove()

Source maps and other webpack config: By default the config mode is set to production, with no sourcemap. Play around with it.