npm package: @sudodevnull/datastar
Description: [https://data-star.dev](https://data-star.dev)
Latest version: 0.19.9

# Datastar

[https://data-star.dev](https://data-star.dev)

[![Star History Chart](https://api.star-history.com/svg?repos=delaneyj/datastar&type=Date)](https://star-history.com/#delaneyj/datastar&Date)

Typescript library for making [hypermedia](https://hypermedia.systems/) systems using little to no Javascript code. The Typescript may be important to the datastar dev but its just a normal JS file to the browser. The goal is to make it easy to create realtime web apps with as little Javascript as possible. This is done by using HTML attributes to define the behavior of the page. This is similar to [Alpine.js](https://alpinejs.dev/) + [HTMX](https://htmx.org/) but with a few key differences.

It's just normal [HTML data attributes](https://developer.mozilla.org/en-US/docs/Learn/HTML/Howto/Use_data_attributes) that get watched by plugins and build up a context object. The current plugins work off of signals to make everything reactive and allow _very_ fast interactions in very little code.

![Size](https://img.shields.io/bundlephobia/minzip/%40sudodevnull%2Fdatastar)

## Community

Has it's on Discord server. Feel free to join and ask questions. [![](https://dcbadge.vercel.app/api/server/bnRNgZjgPh)](https://discord.gg/bnRNgZjgPh)

## Features

### Pros

- Built with reactive applications in mind, not just pages.
- 💯 strict Typescript with full tree shaking support
- 📦 0 dependencies
- The best parts of [Alpine.js](https://alpinejs.dev/) and [HTMX](https://htmx.org/) but created in a unique way to allow for a more declarative approach
- 💯 HTML compliant
- [Fine grain reactivity](https://dev.to/modderme123/super-charging-fine-grained-reactive-performance-47ph)
- Using [Vite](https://vitejs.dev/) for development and [Rollup](https://rollupjs.org/guide/en/) for production builds.
- **Everything** is an plugin so you can add and remove features as needed
- [HOWL](https://htmx.org/essays/hypermedia-on-whatever-youd-like/) stack ready with Go specific tooling coming soon
- Even with **all** plugins its very small (see badge above)
- Faster than Alpine.js [VDOM](https://vuejs.org/guide/extras/rendering-mechanism.html) reactivity and HTMX needs [Hyperscript](https://hyperscript.org/reference/) or Alpine to work on most real world projects
- [DHH would hate it](https://news.ycombinator.com/item?id=37405565)

### Cons

- **No progressive enhancement**, you need Javascript enabled. Datastar is for making realtime web apps like dashboards, admin panels, etc. If you need progressive enhancement use [Alpine-Ajax](https://alpine-ajax.js.org/) or [HTMX](https://htmx.org/) and stick to just `<a/>` and `<form/>` tags. Scripting is a first class citizen in hypermedia systems.
- Modern browsers only (no IE11 support)
- Have to use custom attributes (data-\*) so slightly more verbose but spec compliant always
- Have to use SSE if you use the defaults. It's a little more code upfront but allows for faster updates and less code.
- [No book](https://hypermedia.systems/), but most of hypermedia concepts will port directly over.

### Why not just use Vue/React/Svelte?

[HTMX Essays](https://htmx.org/essays/) are a great place to start.

### Why not just use HTMX+Alpine?

I think HTMX is great and I will continue to recommend it for splashes of contents. In general Datastar is geared towards more complex reactive applications, especially in a realtime context.

## Building

The library itself can be built with https://pnpm.io/ by doing a `pnpm i` and `pnpm build` in the `packages/library` folder.

To run the examples website you will need the following:

- [Go](https://go.dev/)
- [Taskfile](https://taskfile.dev/)
- [Git-LFS](https://git-lfs.com/)

Start with a `git lfs checkout` in the datastar root folder then run `task tools` followed by `task -w hot`.