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

First Post!

kokolegorille

kokolegorille

It depends… some will use css framework that does include some JS, with maybe dependency on jQuery, like Bootstrap.

But many would like to drop jQuery dependency, in favor of vanilla JS.

But if You want to code your own JS, then again You have the choice of bundling it into webpack, or not. You also have the option to copy those files by putting them into assets/static, and reference them in template.

You can also bundle it with webpack, but good knowledge of the tool is required :slight_smile:

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

nobody
Hi! In PHP: $_SERVER[‘SERVER_ADDR’] - in Elixir? Searched the docs for ip address and the web, no good results. Thanks!
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
hariharasudhan94
Lets say I have map like this fetching from my database %{"_id" =&gt; #BSON.ObjectId&lt;58eb1a7a9ad169198c3dXXXX&gt;, "email" =&gt; ...
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
Brian
What is the proper way to load a module from a file in to IEX? In the python world, doing something like this pretty standard: from ....
New
lanycrost
Hi everyone! I need implement if…else if…else condition from my elixir code, and anymore of this control flow structures not work proper...
New
freewebwithme
Using vs code and installed ElixirLS: support and debugger. And I got an error popped up on start up says Failed to run ‘elixir’ comma...
New

Other popular topics Top

nobody
Hi! In PHP: $_SERVER[‘SERVER_ADDR’] - in Elixir? Searched the docs for ip address and the web, no good results. Thanks!
New
vonH
When I run the Plug and I recompile I wind up having to use Ctrl C to quit iex and start again. Witht the help of rlwrap I can use the cu...
New
dokuzbir
I want to highlight html closing tags when i click a html tag. That works in .html files but doesnt work for html.eex templates. How can...
New
SoCreat
i’m a new one to elixir which editor can i use vs code? or atom? Thanks! :smiley:
New
sergio
Kind of like when jquery came out, it was super necessary. Existing drag and drop libraries have a bunch of baggage to support old browse...
New
AstonJ
Posting this to see if we can make things easier for people to get into Neovim. If you use Neovim and have a favourite distro please let ...
New

We're in Beta

About us Mission Statement