Qqwy

Qqwy

TypeCheck Core Team

Development on Phoenix LiveView is of course in full swing. However, here are a couple of features I currently miss and proposals to add them to Phoenix LiveView.

Mouse Events

Currently, LiveView supports phx-click which triggers whenever there is a JavaScript click event.
In multiple projects I have encountered cases with a large need for other types of interaction. Specifically, custom form elements frequently require things to happen on mousedown, when dragging, or when doubleclicking.

I propose that the following events are added to LiveView (whose behaviour is similar to phx-click in that the same extra information is sent, as well as the phx-value-*s that are set on that particular element):

  • phx-mousedown
  • phx-mousemove
  • phx-mouseup
  • phx-dblclick

Supporting other click-like events

I believe above list covers the most common interactions. Of course, there exist many more mouse-related (as well as more general touch-related) events.
On top of above list of events, I therefore propose that it should be made easier to hook into the existing code that sends a phx-click-like event to the server.

Reason:

If someone were to create custom JavaScript for such an event right now, the would not only be re-inventing the logic that LiveView itself uses. The bigger issue is that their logic will not share the updates/changes to the code LiveView itself has, forever lagging behind with the implementation.
To be more precise, the following is very difficult (already right now) to accurately reproduce in a custom JS hook:

  • The new event should include all phx-value-*s using the same naming conventions/conversions as a normal (built-in) event.
  • The new event should include the same meta information with the request.
  • The new event should adhere to supplied phx-debounce and phx-throttle settings.
  • The new event should trigger on the correctly specified phx-target.
  • This list will grow and change with future features being added to LiveView.

Proposal

Some standardized way to add a new type of click-like event to a Phoenix LiveView instance would be a solution, such as adding a configuration field that accepts a list of event-names or alternatively an object of event name keys with callback function values, where the callback function is able to do things before an event is dispatched and can yield to the event dispatching logic at some point (either by using ES6 features or by e.g. just passing in the function that can do the work as argument to the callback function so it can call it whenever it likes).

First Post!

Qqwy

Qqwy OP

TypeCheck Core Team

By the way, this proposal is tangentially related to this issue.

Most Liked

samaaron

samaaron

OK, for those looking to work with mouse down events, here’s the things I had to learn/do:

  1. Create the HTML element in the call to render with an id and phx-hook attributes,
  2. Modify my app.js to work with the hook and specifically handle the element’s mouse down event
  3. Add a new event handler in my LiveView component to receive the event.

Let’s look at each in turn…

1. Creating the HTML element

Somewhere in your render you need to have a HTML element you’d like to listen to events on. I’m using a button here. Your element needs to have a unique ID (this can be anything but is typically hyphen-separated such as "lovely-button") and also a phx-hook attribute which can also be anything but is typically CamelCase such as YoButton:

<button id="lovely-button" phx-hook="YoButton">yo button!</button>

2. Handling the JS event

Now we have our HTML element, we need to add the appropriate javascript event handler. This will be called when the button is clicked and will then tell the server via the pushEvent function.

First we need to edit our app.js to include a Hooks object which includes an internal YoButton object (this needs to be named similarly to the phx-hook attribute above).

LiveView gives us a mounted callback to use which is called when all the server and client initialisation is completed, so we know things are ready to go.

Inside this callback, we can add our event handler which listens for 'mousedown' events and then uses pushEvent to tell the server:

let Hooks = {}

Hooks.YoButton = {
  mounted(){
    this.el.addEventListener('mousedown', e => {
     this.pushEvent("mouseymouse");
    });
  }
}

We also need to teach our liveSocket about the Hooks:

let liveSocket = new LiveSocket("/live", Socket, {
  hooks: Hooks,
  params: {_csrf_token: csrfToken},
  ....

3. Receiving the event on the server

This is probably the easiest bit. In our LiveView component we just need a new handler function:

def handle_event("mouseymouse", _params, socket) do
   # do something interesting!
  {:noreply, socket}
end

I hope that this helps someone trying to do something similar :slight_smile:

Anko

Anko

came here after reading this post by John Carmack https://twitter.com/ID_AA_Carmack/status/1787850053912064005

basically he advocates for mouse down making interfaces a lot snappier. I have tried it and it does really seem to work… Maybe it’s worth reviving this conversation?

kartheek

kartheek

LiveView is evolving similar to Java Server Faces. Java Server Faces is more component oriented specification of server side rendering of views. Oracle ADF Faces is JSF based framework which had extensive support for building rich client applications.

ADF Faces has 2 types of events server-side and client-side - client side events were meant to be handled on browser side and server side events which will be sent to server for handling on it on server side. Table - 6-1, 6-2, 6-3, 6-4 have different events generated by ADF Faces.

Leaving this here for reference and prior art.

Last Post!

samaaron

samaaron

Totally agreed. My use-case is music apps and in that context it’s ludicrous for mouse-off being the trigger rather than mouse-on. Imagine a cymbal that make a noise when the drumstick left it or a clarinet that sounded when you stopped blowing :slight_smile:

Of course, with practice you could compensate for the latency just like organ scholars do - but it’s not natural and definitely way less fun.

Where Next? Top

Trending in Discussions Top

wmnnd
Hey folks, I wanted to share with you a project I’ve been working on for a while: It’s an Open Source (AGPLv3) newsletter tool. Think Ma...
New
axelson
Hi there! :wave: @frigidcode and I (but mostly him) have been running an Elixir Book club, we’re almost done with Designing Elixir Syste...
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
sntran
In my third year of college, around 2010, I found Erlang. A few years later, I found Elixir. I liked the ideas at once: many small proces...
New
Ganna
Hi everyone, I have 8 years of production experience with Erlang/OTP and I’m just starting to get to know Elixir. What would you learn f...
New
johnkirkham
A note on form. Joe Armstrong, co-creator of the Erlang programming language, died in April 2019. What follows is a work of narrative non...
New
gtcode
I’ve been tinkering with Lynx (by José) via hold_ledger. I used AI to write the code, a separate specification, the tests, and the Lean p...
New

Other Trending Topics Top

dominicletz
Hey there, I haven’t seen a list of useful Elixir specific skills for the popular AI tools yet so I’m starting one here with my first. ...
New
mudasobwa
I fully migrated to my own harness from Anthropic/Gemini and I think it’s time to share it. Welcome DSH, the DeepSeek Harness, fully writ...
New
KristerV
Hey. Is there anyone here who creates agents in their apps? Not talking about using agents, but creating them. I’m finding it pretty diff...
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
webofbits
With AI doing more of the implementation work, I’ve been wondering how much coding I should deliberately keep doing myself. My main conc...
#ai
New
OndrejValenta
(I just needed to vent somewhere and LinkedIn is full of hope, or hype, I’m not sure which exactly) AI dream has many faces, but general...
New

We're in Beta

About us Mission Statement

Options

Thread Display Mode




Thread Preview

Skip Thread Previews