tnederlof

tnederlof

Adding a Bit of Javascript to Phoenix Template

I have had some good success with using pure Phoenix template/html so far however I have a layout that uses a dropdown menu and I need to use a bit of javascript to accomplish some of the click, show, hide, etc events. Most of the guides I have seen are adding entire frameworks to handle the frontend etc. What would be a simpler option if I want to add some javascript to a navbar.html.eex saved in my layout folder which is then rendered in app.html.eex

Most Liked

cunningryan

cunningryan

Another newer option for this sort of thing is Alpine.JS. The default Phoenix project setup makes it easy to install/drop this into your app.js, then Alpine is built for “sprinkling” into any templating language and adding more of a “reactive” style of programming using your existing DOM nodes.

dorgan

dorgan

You also have Stimulus.js, or the web platform’s Custom elements if you don’t want any framework/dependency.

Stimulus leverages data-attributes to add behavior to your document.
Custom elements let you define your own <dropdown-tag>, or extend a built-in element resulting in <div is="my-dropdown">. As you’ll see in the following examples, you do not need to use ShadowDom with all it’s issues to use custom elements.

With Stimulus your markup would look like:

<div data-controller="dropdown">
  <button data-action="click->dropdown#toggle">Click me!</button>
  <div data-target="dropdown.content" class="hidden">Dropdown Content!</div>
</div>

And your controller:

import { Application, Controller } from "stimulus";

class Dropdown extends Controller {
  static targets = ["content"]

  toggle() {
    this.contentTarget.classList.toggle("hidden");
  }
}

const app = Application.start();
app.register("dropdown", Dropdown);

With custom elements, your markup would look like this:

<x-dropdown>
  <button dropdown-trigger>Click me!</button>
  <div dropdown-content class="hidden">Dropdown content!</div>
</x-dropdown>

And the js

class XDropdown extends HTMLElement {
  connectedCallback() {
    this.trigger = this.querySelector("[dropdown-trigger]");
    this.content = this.querySelector("[dropdown-content]");

    this.trigger.addEventListener("click", this);
  }

  handleEvent(event) {
    if(event.type === "click" && event.currentTarget === this.trigger) {
      this.content.classList.toggle("hidden");
    }
  }
}

customElements.define('x-dropdown', XDropdown);

For more info in handleEvent, see this post.

Or with built-in extends:

<div is="x-dropdown">
  <!-- ... -->
</div>
class XDropdown extends HTMLDivElement {
  // ...
}

customElements.define('x-dropdown', XDropdown , { extends: 'div' });

I’m currently using both Stimulus and custom elements via WebReflection/heresy for some non trivial js parts, and I can recommend both.

tnederlof

tnederlof

Thank you for all of the great suggestions and options. I was able to get really far quickly with Alpine, especially since I come from a Vue background. I will definitely explore other options as I move forward.

Where Next?

Popular in Questions Top

skosch
To my knowledge, put_in, Map.update etc. all have the one limitation of not automatically creating intermediate keys when needed (for exa...
New
pmjoe
I have a relationship of love and hate with Elixir. Lots of things are just absolutely right, but there are some things that are kind of ...
New
jononomo
I am trying to figure out how Mix knows whether the environment is test, dev, or prod – where is this set? Thanks.
New
Emily
I have VueJS GUIs with the project generated using Webpack. I have Elixir modules that will need to be used by the VueJS GUIs. I forese...
New
LegitStack
I’m trying to make a websocket server in Phoenix or raw Elixir. I heard about gun, I think I could use cowboy, but since I’m not that sma...
New
dblack
I’ve got an issue with an app and I’ve no idea of how to troubleshoot it. I’m hoping someone here might have seen something similar. I p...
New
nsuchy
Hi. I’ve noticed that Windows Powershell has it’s own IEX command and you cannot access Elixir’s IEX due to the conflict. This isn’t a cr...
New
shijith.k
I am trying to start a new phoenix project with elixir 1.9, but mix phx.new does not work. It says that ** (Mix) The task "phx.new" could...
New
jononomo
For some reason my phoenix channels are working for me in my local dev environment, but as soon as I deploy via Docker, I get a 403 error...
New
vonH
In asking this question I am more interested about the expressiveness of the language itself and less concerned about the availability of...
New

Other popular topics Top

JakeBecker
TL;DR: I’ve just released an implementation of Microsoft’s IDE-independent Language Server Protocol for Elixir. It adds language support ...
1144 53690 245
New
stefanchrobot
What’s the safe way to decode a JSON string into a struct? I want to avoid calling String.to_atom. Jason.decode can give me a map with st...
New
electic
Hi, I am new to Elixir. I am trying to use the DateTime component to insert a date into MySQL however the there seems to be no way to fo...
New
ovidiubadita
Hey all, I discovered Elixir and I love it. I always wanted to learn a functional programming and I intended to go for Haskell, but afte...
New
johnnyicon
Hi all, I’ve just started learning Elixir and Phoenix Framework, so please pardon my n00bness at this stage. I’m trying to use Postgres...
New
stefanluptak
Hello everybody, usually, I use a 29" ultra-wide monitor for VSCode which can easily accomodate explorer (files panel) + file with code ...
New
gausby
I asked this very same question on twitter and got some interesting feedback, but I thought it would be a good question to ask here as we...
1207 39297 209
New
saif
Hello everyone, Long time lurker first time poster here. I’ve recently begun working on Elixir full-time again! :raised_hands: It’s been...
New
marick
I had some trouble figuring out how to make many-to-many associations work. Once I got it working, I wrote a blog post. Because I’m a nov...
New
openscript
Hello! Sorry for this astonishing simple question, but I’m really stuck. I try to set up the intellij-elixir plugin, but I don’t know ho...
New

We're in Beta

About us Mission Statement