BartOtten

BartOtten

Phoenix Live Favicon - Favicon manipulation for Phoenix Live

Phoenix Live Favicon

Favicon manipulation for Phoenix Live


Example

A lib enabling dynamic favicons in Phoenix Live View applications.

To show…

  • …a message counter
  • …the result of a CI/CD job
  • …a summary of all monitor statuses
  • …a spinner while uploading a file

Using a dynamic favicon allows users to view a status without having the page in front.

Basic Operations

  • set or remove any attribute
  • add a class name or remove a class name
  • toggle a class

Special Operations

In addition to these basic operations this library includes some special operations to help with common use cases.

Reset a favicon to its initial value
The initial attribute values of favicons are preserved on the first load of the website and can be restored using reset/0. This is in particular useful to erase all previous changes when a user visits a new page by including reset/0 in the on_mount hook.

Set the value of a placeholder (mimicking Phoenix’s assign)
Common use cases are:

  • Changing the path of favicons when multiple sizes are defined
  • Changing a dynamic value within an SVG favicon

Create and restore snapshots
By creating a snapshot of the favicon after multiple operations, you can restore the favicons’ attributes by only sending the snapshots’ name over the wire.

Documentation

Visit the documentation of Phx.Live.Favicon module for the full list of operations.

Guides and Example

See the Guides page for common use cases. The Example App demonstrates various use cases and includes a ‘debug frame’ which shows the HTML of favicon head elements in real time.

Example App Preview

To start this example:

  • Run git clone https://github.com/BartOtten/phoenix_live_favicon_example
  • Go inside the folder with cd phoenix_live_favicon_example
  • Install dependencies with mix deps.get
  • Start Phoenix endpoint with mix phx.server or inside IEx with iex -S mix phx.server

Links

Hex
Hexdocs
Github
Changelog
Search forum for tag

Most Liked

BartOtten

BartOtten

I knew it could be done, but did not build it yet: a message counter using SVG! Now I have a working version in the Example App (not published yet). Let’s say it’s better not to mix PNG and SVG favicons as browsers are not fond of switching from one type to another.

Phoenix Live Favicon - Message Counter

BartOtten

BartOtten

Will do as soon as I find out how I can do it for free :wink: I already use one instance for Phoenix Localized Routes

While creating the message counter example, I found some inconveniences in using the lib and needing to mix in ‘raw’ Live Head. So…..

version 0.2.0-rc.0

A new version has been released as RC on Hex; it powers the updated example page which hopefully will be online soon, so you can all come up with fancier gifs of ‘animated’ favicons!

Features

Create and restore snapshots

The new operations snap and restore make it possible to store the result of many operations under a chosen name and restore it at a later time by only sending the snapshot name over the wire.

  • snap - Takes a snapshot of all attribute values.
  • restore - Applies a snapshot to selected elements

In the Live Favicon Example application it is used to send all changes required to switch between an dynamic SVG counter and static PNG message-icon once, and toggle the state between them; creating a flashing notification. As it also makes a snapshot of the state before the favicon begins to flash, the icon on the page can be restored to it’s value as soon as the user had read the unread messages.

Use multiple placeholders

You can now use multiple custom named placeholders, instead of only one {dynamic} per attribute.

Fixes

  • Unstable order of change execution when using multiple queries / libs.

BREAKING

  • the attribute value of dynamic is now used as name for the target placeholder. As a result, it is not possible anymore to target a specific attribute. Migration is as easy as using different names per attribute when necessary.

TESTERS NEEDED!

This is quite a major release as a lot of logic was rewritten in the underlying lib. However, for most there won’t be breaking changes so the upgrade should be safe.

Please upgrade to the RC version and let me know if you experience any issues (or better: how many issues it solves!)

{:phoenix_live_favicon, "~> 0.2.0-rc.0"}

See also: the diff of Example App and especially how it uses the new snapshots and custom dynamic placeholders.

BartOtten

BartOtten

Release 0.2.0 (changelog)

Changes
No fundamental changes to rc.0 so the post above is accurate. The example app has been updated to use the new 0.2.0.

Better documentation
The README has seen some work too and a few GUIDES were added.

Migration guide
As this is a breaking release due set_dynamic being redefined, you should update your mix.exs file to include:

 {:phoenix_live_favicon, "~> 0.2.0"}

When using set_dynamic from 0.1.x you can rewrite them to
set_dynamic("dynamic", value). Notice it targets a specific placeholder instead of an attribute. When you used multiple {dynamics} on different attributes, you should rename every dynamic placeholder to be unique. See the docs of set_dynamic/3

Where Next?

Popular in Announcing Top

sasajuric
I’d like to announce a small library called boundaries. This is an experimental project which explores the idea of enforcing boundaries ...
New
josevalim
Yes, yet another parser combinator library! Most of the parser combinators in the ecosystem are either compile-time, often using AST tra...
159 19483 141
New
bradley
I’ve been working with Claude Code extensively and absolutely love it. However, I’ve come across the challenge of managing configuration ...
New
Eiji
ExApi is a library that I’m developing now and hope release soon This library will allow to: list all apis list all api implementation...
New
blatyo
The best overview for how things are tied together is this presentation. Modules and functions are pretty well documented at this point, ...
New
nikokozak
Hello all, I’ve been working on Svonix - a library for quickly integrating Svelte components into Phoenix views. It’s a much-needed succ...
New
ahamez
Hi everyone, I’ve been working on this protobuf library for 3 years. We use it in the company I work for, EasyMile, to communicate with ...
New
cjen07
parameterized pipe in elixir: |n> edit: negative index in |n> and mixed usage with |> are supported example: use ParamPipe ...
New
Jskalc
Hi! Today, after a couple weeks of development I’ve released v0.1 of LiveVue. It’s a seamless integration of Vue and Phoenix LiveView, i...
New
marcuslankenau
I feel kind of stuck with the absence of a proper xml library for Elixir. Currently I use SweetXML which was ok for me more or less to pa...
New

Other popular topics Top

axelson
This post is a wiki (feel free to hit the edit button near the bottom right of this post to add your own changes!) This post collects co...
239 48475 226
New
malloryerik
Hi, this is for people who, like me, have had some friction using .html.heex templates in VSCode. The solution seems to be, in a hyphena...
New
9mm
I am constructing a JSON object (map) and I need to conditionally set a field. I’m trying to write proper elixir-way code… and I’m at a l...
New
New
marius95
Hello everyone, I try to use an Javascript Event Handler in my root.html.leex file. Therefore I created a function in the app.js file: ...
New
Patoshizzle
After calling mix ecto.create I get this error: 17:00:32.162 [error] GenServer #PID<0.412.0> terminating ** (Postgrex.Error) FATAL...
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
Qqwy
Update: How to use the Blogs & Podcasts section You can post links to your blog posts or podcasts either in one of the Official Blog...
3271 127536 1222
New
JakeBecker
TL;DR: I’ve just released an implementation of Microsoft’s IDE-independent Language Server Protocol for Elixir. It adds language support ...
1144 54250 245
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

We're in Beta

About us Mission Statement