interactive, collaborative html elements with a single data attribute
See the codeinteractive, collaborative HTML elements with a single data attribute
playhtml is a fast, small (~300KB), library-agnostic, and expressive library for magically creating collaborative interactive HTML elements that persist their state across sessions. It aims to be infrastructure for creating lived-in, alive internet spaces filled with traces of past visitors and the life of present visitors.
<div id="couch" can-move style="font-size: 80px">๐</div>
That's it. The couch is draggable for everyone on the page, and its position persists across sessions.
https://github.com/spencerc99/playhtml/assets/14796580/00e84e15-2c1c-4b4b-8e15-2af22f39db7a
playhtml is in beta and actively developed. Join the Discord to get help and show what you've built.
Vanilla HTML โ drop in from a CDN, no build step:
<script type="module">
import { playhtml } from "https://unpkg.com/playhtml";
playhtml.init();
</script>
<img can-toggle id="lamp" src="lamp.png" />
React:
npm install playhtml @playhtml/react
import { PlayProvider, CanToggleElement } from "@playhtml/react";
<PlayProvider>
<CanToggleElement>
<img id="lamp" src="lamp.png" />
</CanToggleElement>
</PlayProvider>;
See getting started for both paths in depth. React users should also read the React API reference.
Built-in capabilities โ drop these attributes on any element:
| Attribute | What it does |
|---|---|
can-move | Drag anywhere; position persists and syncs |
can-toggle | Click to flip an on/off state |
can-spin | Rotate by dragging |
can-grow | Click to scale up, alt-click to scale down |
can-duplicate | Click to clone a target element |
can-mirror | Auto-sync attributes, children, and form state (experimental) |
can-hover | Sync hover state across users |
can-play | Fully custom capability with your own logic |
Each has a live demo and full docs in the capabilities reference.
Beyond capabilities:
setupPlayElement and selector-id for runtime-added nodesplayhtml works well with coding assistants.
Claude Code users โ install the plugin for a skill that auto-activates when you ask Claude to build playhtml elements:
claude plugin marketplace add spencerc99/playhtml
claude plugin install playhtml@playhtml
Any other LLM (ChatGPT, Copilot, Cursor, ...) โ copy the prompt template from the building with AI guide into your conversation.
website/ and packages/react/examples/All data is currently stored by a PartyKit instance under my account and is not encrypted. Anyone with the room name can access the data. Custom persistence options (your own storage backend) are on the roadmap.
See CONTRIBUTING.md. Contributions for new built-in capabilities are especially welcome โ the same can-play API powers all of them.
If you enjoy using this, please consider sponsoring the project. This helps fund the hosting costs for the syncing and persistence services and keeps the library maintained over time.
This repository uses two licenses:
packages/ (the playhtml library, React bindings, shared types, extension-types package). See LICENSE.website/, extension/, tools/, apps/docs/), which contain Spencer's personal art, product copy, visualizations, and exhibition work. See LICENSE-ART.The library is free to use, modify, and embed commercially. The art, experiments, and extension UI are visible as receipts of authorship but may not be copied commercially or redistributed as derivatives.
TypeScript
85.4%
SCSS
5.6%
JavaScript
3.4%
HTML
2.8%
CSS
1.3%
MDX
1.2%
interactive, collaborative html elements with a single data attribute
See the codeinteractive, collaborative HTML elements with a single data attribute
playhtml is a fast, small (~300KB), library-agnostic, and expressive library for magically creating collaborative interactive HTML elements that persist their state across sessions. It aims to be infrastructure for creating lived-in, alive internet spaces filled with traces of past visitors and the life of present visitors.
<div id="couch" can-move style="font-size: 80px">๐</div>
That's it. The couch is draggable for everyone on the page, and its position persists across sessions.
https://github.com/spencerc99/playhtml/assets/14796580/00e84e15-2c1c-4b4b-8e15-2af22f39db7a
playhtml is in beta and actively developed. Join the Discord to get help and show what you've built.
Vanilla HTML โ drop in from a CDN, no build step:
<script type="module">
import { playhtml } from "https://unpkg.com/playhtml";
playhtml.init();
</script>
<img can-toggle id="lamp" src="lamp.png" />
React:
npm install playhtml @playhtml/react
import { PlayProvider, CanToggleElement } from "@playhtml/react";
<PlayProvider>
<CanToggleElement>
<img id="lamp" src="lamp.png" />
</CanToggleElement>
</PlayProvider>;
See getting started for both paths in depth. React users should also read the React API reference.
Built-in capabilities โ drop these attributes on any element:
| Attribute | What it does |
|---|---|
can-move | Drag anywhere; position persists and syncs |
can-toggle | Click to flip an on/off state |
can-spin | Rotate by dragging |
can-grow | Click to scale up, alt-click to scale down |
can-duplicate | Click to clone a target element |
can-mirror | Auto-sync attributes, children, and form state (experimental) |
can-hover | Sync hover state across users |
can-play | Fully custom capability with your own logic |
Each has a live demo and full docs in the capabilities reference.
Beyond capabilities:
setupPlayElement and selector-id for runtime-added nodesplayhtml works well with coding assistants.
Claude Code users โ install the plugin for a skill that auto-activates when you ask Claude to build playhtml elements:
claude plugin marketplace add spencerc99/playhtml
claude plugin install playhtml@playhtml
Any other LLM (ChatGPT, Copilot, Cursor, ...) โ copy the prompt template from the building with AI guide into your conversation.
website/ and packages/react/examples/All data is currently stored by a PartyKit instance under my account and is not encrypted. Anyone with the room name can access the data. Custom persistence options (your own storage backend) are on the roadmap.
See CONTRIBUTING.md. Contributions for new built-in capabilities are especially welcome โ the same can-play API powers all of them.
If you enjoy using this, please consider sponsoring the project. This helps fund the hosting costs for the syncing and persistence services and keeps the library maintained over time.
This repository uses two licenses:
packages/ (the playhtml library, React bindings, shared types, extension-types package). See LICENSE.website/, extension/, tools/, apps/docs/), which contain Spencer's personal art, product copy, visualizations, and exhibition work. See LICENSE-ART.The library is free to use, modify, and embed commercially. The art, experiments, and extension UI are visible as receipts of authorship but may not be copied commercially or redistributed as derivatives.
TypeScript
85.4%
SCSS
5.6%
JavaScript
3.4%
HTML
2.8%
CSS
1.3%
MDX
1.2%