Skip to main content
ChannelBindJS
=============

Activates elements for inline editing and live updating from a django-channels
backend. This script looks for expected class names and data attributes and
adds events and attributes to connect them.

The aim of this script is to be small and easy to use rather than being
high-performance of highly featured. Compatibility is for modern browsers.

Any html element containing a representation of a django model can be activated
by adding classes to it and its enclosed field values.

On the container:
- class="live"
- data-model="appname.modelname"
- data-id="1" // primay key

On each field:
- class="field" // to enable live udpates
- class="editable" // to enable inline editing
- data-field="fieldname"

This object depends on the channels.WebSocketBinding and should be initialised
with the binding url of the demultiplexer set up in channels routing.

Include the script:

```html

<script src="/static/channels/js/websocketbridge.js"></script>
<script src="/static/channelbindjs/activate.js"</script>
<script>Activation.init('/binding/');</script>
</body>
```

And to make a model receive live updates and have inline editing:

```html
<div class="live" data-model="appname.modelname" data-id="1" data-stream="demultiplexer-stream">
<header>
<div class="field editable" data-field="title">Rendered content of title field</div>
</header>
<div class="field editable" data-field="description">Rendered description</div>
</div>
```

Links
-----

[Channels data binding documentation](https://channels.readthedocs.io/en/stable/binding.html)

Release files for channelbindjs 0.1.0

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for channelbindjs 0.1.0
File Size Uploaded
channelbindjs-0.1.0.tar.gz 4.5 kB Details

Release files / channelbindjs-0.1.0.tar.gz

Download URL channelbindjs-0.1.0.tar.gz
Size 4.5 kB
Tags Source
SHA-256 checksum
How to use checksums
6b70b6fe6c9dc20c97112bd67097de51f6751389c48221a9a7f877780e95877d
BLAKE2b-256 checksum
How to use checksums
816b484ac0f3ec3d23b6005fcc2864d7e5a5d180f3bc246d62a71f2c9f218310
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No

Release history Release notifications | RSS feed

This release

0.1.0 This release

1 release file

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page