campfire

a cozy web framework

Campfire is a collection of small utilities to make developing with vanilla JS easy.

It is kept lightweight on purpose, aiming to provide the bare minimum necessary to make development easier.

Features

• Fluent builder API: Create and configure DOM elements with a chainable, intuitive API
• Reactive data stores: Implement reactive data and elements with Campfire's store APIs
• Templating Helpers: Simple utilities for HTML templating and content rendering
• Minimal footprint: 5kb compressed
• TypeScript support: First-class TypeScript integration with type inference
• Composable elements: Preserve reactive children across re-renders
• DOM Helpers: Streamlined APIs for DOM manipulation and event handling

Building

$ npm run build
Copy

Then you can use dist/campfire.min.js and dist/campfire.d.ts.

Usage

You can use it directly in a JS file intended for the browser, either from esm.sh or unpkg, or self-host it:

import cf from "https://esm.sh/campfire.js";
Copy

or install it with npm (npm i campfire.js) and use it in your existing workflow.

All the methods and classes are also exported, so you can do named imports as usual:

import { ListStore, nu } from "https://esm.sh/campfire.js";
Copy

Quick reference

The API reference can be found here.

Contributing

Fork the repo and make a pull request, or open an issue on the issues page.

Donate

If you like using Campfire, you can donate to Campfire development using one of the means listed here.

Acknowledgements

Icon made by Those Icons from Flaticon

The unescape function and unit tests for it and escape are derived from lodash under the terms of the MIT License. Code in lodash is a copyright of JS Foundation and other contributors https://js.foundation/. Lodash itself is based on Underscore.js, copyright Jeremy Ashkenas, DocumentCloud and Investigative Reporters & Editors http://underscorejs.org/

Docs for Campfire are built with TypeDoc.

The Campfire website uses the toml and Marked.js libraries under the MIT License to display its content.

Syntax highlighting on the Campfire website is achieved with macrolight. macrolight is a fork of microlight by asvd and is used under the MIT License.

The Campfire playground uses the Ace editor as an embedded editor. The Ace editor is a copyright of Ajax.org B.V. and is used under the 3-clause BSD license.