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

tmbb
I’ve published the first version of my Makeup library. It’s a syntax highlighter for Elixir in the spirit of Pygments, Currently it highl...
New
ityonemo
Currently just starting out on a new mini-project - getting zig NIFs to run in elixir. https://github.com/ityonemo/zigler The idea here...
New
Crowdhailer
The latest release of Ace (0.10.0) includes serving content over HTTP/2. I have started writing a webserver to teach my self more about...
New
josevalim
EDIT: since Ecto 3.0 final version is out, this post was amended to use the final versions in the instructions below. Hi everyone, We a...
New
grych
Hi folks, Few months ago I have announced the proof-of-concept of the library to manipulate the browsers DOM objects directly from Elixi...
639 52774 488
New
aditya7iyengar
Rummage.Ecto and Rummage.Phoenix provide ways to perform Searching, Sorting and Pagination over Ecto queries and Phoenix collections. Fo...
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
versilov
Could not wait for the missing Elixir ML libraries to appear, so, I wrote one myself, taking https://github.com/sdwolfz/exlearn as a foun...
New
michalmuskala
Hello everybody. I have just released Jason - a new JSON library. You might be wondering, why do we need a new library? The primary foc...
New
woylie
Flop is an Elixir library that applies filtering, ordering and pagination parameters to your Ecto queries. offset-based pagination with...
New

Other popular topics Top

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
shahryarjb
Hello, I have map which I want to convert it to string like this: the map: %{last_name: "tavakkoli", name: "shahryar"} the string I ne...
New
fireproofsocks
Forgive me if this is obvious, but how does one delete a database record WITHOUT selecting it first? Ecto.Repo — Ecto v3.14.0 has exampl...
New
msaraiva
Surface is an experimental library built on top of Phoenix LiveView and its new LiveComponent API that aims to provide a more declarative...
564 43806 214
New
jay1
Why is it that the mnesia database isn’t the most preferred database for use in Elixir/Phoenix?
New
joeerl
Hello again - after a longish gap I’ve decided I really must dig into Elixir and see what’s been happening here - so I have a few questio...
New
ashish173
I am using Ecto timestamps with postgres, I can see the timestamps() use the :naive_dateime but for my use case I wanted to store the ti...
New
joaquinalcerro
Hi there, I am working with Ecto-Postgresql and I need to call all of the records from a specific table but the table has 40,000 records...
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

We're in Beta

About us Mission Statement