0.0.3 โ€ข Published 6 months ago

nerve-ending v0.0.3

Weekly downloads
-
License
MIT
Repository
github
Last release
6 months ago

Nerve Ending

Nerve Ending is a lightweight JavaScript micro-library that provides a set of functions for creating and manipulating DOM elements declaratively. It is particularly suitable for building cross-framework UI components and feature enhancement libraries outside the business development of modern web frameworks (such as React, Vue, Svelte, and Alpine), which can significantly improve code readability and maintainability.

Features

  • ๐Ÿ”— Chainable API for intuitive DOM creation
  • ๐ŸŽฏ Type-safe element construction
  • ๐Ÿงน Automatic cleanup of event listeners
  • ๐Ÿชถ Lightweight with zero dependencies
  • ๐ŸŽจ Natural, declarative syntax
  • ๐Ÿ”„ Easy element composition

Installation

npm install nerve-ending

Why Nerve Ending?

Traditional DOM manipulation can be verbose and hard to read. Nerve Ending transforms this:

const main = document.createElement('main');
main.className = 'container';
const heading = document.createElement('h1');
heading.className = 'title';
heading.onclick = () => console.log('clicked');
heading.textContent = 'My first app';
main.appendChild(heading);

Into this:

const { element } = main({ class: 'container' })(
  h1({ class: 'title', onclick: () => console.log('clicked') })(
    'My first app'
  )
);

Core Concepts

Nerve Ending introduces a fluent interface for DOM manipulation that follows a natural mental model: 1. Select the element type 2. Define its properties 3. Add its children 4. Get back a manageable element reference

Usage

import { main, h1, button, span } from 'Nerve Ending';

// Create a simple component
const { element, cleanup } = main({ class: "app" })(
  h1({ class: "title" })(
    span("Welcome to "),
    span({ class: "highlight" })("Nerve Ending")
  ),
  button({ 
    onclick: () => alert('Hello!'),
    class: "greeting-btn"
  })("Say Hello")
);

// Add to DOM
document.body.appendChild(element);

// Cleanup when done
// cleanup();

Key Benefits

  1. Declarative Syntax: Write DOM structures that mirror their visual hierarchy
  2. Memory Safety: Automatic cleanup of event listeners prevents memory leaks
  3. Type Safety: When used with TypeScript, provides full type inference
  4. Composability: Easily combine and nest elements
  5. Developer Experience: Intuitive API reduces cognitive load

License

MIT ยฉ Layerhub

0.0.3

6 months ago