Giter Club home page Giter Club logo

hijinks's Introduction

Hijinks

Hijinks is a tiny DOM builder utility inspired by HyperScript. Relentlessly simple, it weighs in at less than 0.3kb gzipped. Despite its small size, you'll find it to be quite flexible and familiar if you've ever used React or similar libraries. None of this comes at the expense of compatibility, as it still supports legacy browsers like Internet Explorer.

Installation

Install via NPM:

npm install hijinks

Usage

<div id="target"></div>
<script type="module">
	import { h } from 'https://unpkg.com/hijinks';
	const target = document.getElementById('target');
	const element = h('span', { className: 'greeting' }, 'Hello World!');
	target.appendChild(element);
</script>

You can even create elements with JSX syntax if you so desire. Assuming you're using the Babel JSX transform plugin, define Hijinks as the import source for the automatic runtime.

.babelrc:

{
	"plugins": [
		[
			"@babel/plugin-transform-react-jsx",
			{
				"runtime": "automatic",
				"importSource": "hijinks"
			}
		]
	]
}

app.jsx:

const target = document.getElementById('target');
const element = <span className="greeting">Hello World!</span>;
target.appendChild(element);

API

createElement (h)

The hijinks module exports createElement (aliased as h) as a named export:

export function createElement(
	tag: string | Component,
	attributes?: Attributes | null,
	...children: Node | string | Array<Node | string> | HTMLCollection
): Node;

tag

The tag name of the element to create, or a function ("component") which receives attributes including children and is expected to return an HTMLElement.

attributes

An optional object of attributes and HTMLElement properties to assign to the created element. Any properties not known to the HTMLElement interface are assigned as attributes.

children

The remainder of arguments can consist of one (or array of) HTMLElement or strings to be appended as children to the created DOM node. Of course, since the Hijinks itself returns an HTMLElement, it's expected that you can easily compose together trees of elements.

Fragment

Fragment is also available and behaves similarly to React fragments, returning a DocumentFragment.

import { h, Fragment } from 'hijinks';
const fragment = <>Example</>;
// Or: const fragment = h(Fragment, null, 'Example');

License

Copyright (c) 2017-2021 Andrew Duthie

Released under the MIT License.

hijinks's People

Contributors

aduth avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar

hijinks's Issues

Size vs. performance

Compiling a list of possible size optimizations that could come at the cost of performance:

  1. Detect if attributes is an object (jsperf)

image

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.