matthewp

matthewp

I’d like to propose a new Binding API, phx-on-*. This would allow you to bind to any arbitrary event on an element. There are two use-cases that come to mind immediately:

  • There are a lot of DOM events and the number keeps growing, but Phoenix does not support them all. It should not need to support them all! An example of one I miss is a form element’s input event.
  • Custom elements pair great with Phoenix, but custom elements often have their own custom events. There’s currently no way to bind to custom events outside of using a hook.

Proposal

I propose a new binding phx-on-*, with the syntax matching the existing phx-value-*. The * is the event name you want to bind to. Examples:

Form Elements

<input type="text" phx-on-input="do_something">

Custom Elements

<my-dialog phx-on-open="handle_open"></my-dialog>

Event params

For the params I propose the following rules:

  • If the Event is a CustomEvent it will contain a details property. event.details. For CustomEvents that come from places like Custom Elements this is what should be passed to params.
  • If the Event is a Form element, collect the value like you already do for form events.
  • Collect phx-value-* into params like is already done as well.

Showing Posts 1 to 3

chrismccord

chrismccord

Creator of Phoenix

We listen on window, so all the event names would have to be known up front, and the values are encoded differently depending on the type of element (ie form serialization vs clicks), so this proposal would need to take both those into consideration.

matthewp

matthewp OP

Thanks Chris, I think in this case we would want to listen on the element and not the window as by default new CustomEvent does not bubble (see spec here). Is there a particular reason why Phoenix binds to the window that causes a concern?

matthewp

matthewp OP

Ok, looking at the LiveView code I now see why it binds at the window. It takes the strategy of binding to well-known events and then checking if the element contains the phx- attribute when the event occurs. That makes sense from a simplicity standpoint but also makes it harder for Phoenix to scale to adding more events.

Another strategy I use is MutationObservers to be made away when attributes are added/removed from DOM elements and then triggering actions on when they change. I even wrote a convenient library for this.

Here’s an example of how phx-click could be implemented with this library:

class PhxClick {
  connectedCallback() {
    this.ownerElement.addEventListener('click', ev => {
      let value = this.ownerElement.getAttribute('phx-click')
      // Notify the server here...
    })
  }
}

customAttributes.define('phx-click', PhxClick)

I could see going in this direction as being beneficial to LiveView and require less special-casing and provide developers with more flexibility. I’d be happy to help implement something like this for you.

— All posts loaded —

Where Next? Top

Trending in Discussions Top

AstonJ
As the title says, please share what you’ve been up to with Elixir. Whether that’s been learning it, looking into it, making stuff with i...
2977 92995 915
New
AstonJ
The obligatory hello world thread! Who are you and where are you from? :stuck_out_tongue:
4616 55835 594
New
caslu
I want to open this thread for you all to discuss and help those who really like Ash but are still hesitant to use it in a real project. ...
New
arcanemachine
I was working on an Ecto migration and I needed a timestamp. So, for the nth time, I looked up the different data types for timestamps, a...
New
alexslade
Fly’s CEO posted this recently - Turn And Face The Strange · The Fly Blog It says that Fly is going all-in on sprites, which is a worry ...
New
Herve37
We’re evaluating API mocking tools for OpenAPI-based projects and would love to hear what other teams are using. We’re particularly inte...
New
matt-savvy
Is there a word for the ~> symbol used in Version strings? Do you also just call it a Squiggle Arrow™ ?!
New

Other Trending Topics Top

garrison
Hobbes is a low-level distributed database for the Elixir programming language. Hobbes provides a simple, safe, and scalable storage lay...
New
jimsynz
Beam Bots (or just BB for short) is a framework for building fault-tolerant robotics applications in Elixir using familiar OTP patterns. ...
New
mcass19
ExRatatui lets you cook up rich terminal UIs in Elixir, powered by Rust’s ratatui via Rustler NIFs. Build interactive terminal applicatio...
New
netoum
Corex is an accessible, unstyled UI component library for Phoenix that integrates Zag.js state machines using Vanilla JavaScript and Live...
New
Damirados
Hello everyone. After busy few months I am happy to announce v0.1.0 of Emerge &amp; Solve. They are GUI (Emerge) and State management (S...
New
wintermeyer
There are three potential reasons for members of this forum to have a look at https://vutuv.de You are tired or annoyed of LinkedIn. Yo...
New

We're in Beta

About us Mission Statement

Options

Thread Display Mode




Thread Preview

Skip Thread Previews