From 9b0a6e6e7dca3cf9adb6f1c603b5cfefa7decc99 Mon Sep 17 00:00:00 2001 From: Adrian Gruntkowski Date: Mon, 20 Nov 2023 11:31:56 +0100 Subject: [PATCH] Improve LiveView flash messages (#3523) * Cancel existing flash timer before setting a new one * Abstract flash logic across live views * Render flash messages one after another --- lib/plausible_web/live/flash.ex | 109 +++++++++++++----- lib/plausible_web/live/funnel_settings.ex | 13 +-- lib/plausible_web/live/goal_settings.ex | 12 +- .../live/plugins/api/settings.ex | 11 +- lib/plausible_web/live/props_settings.ex | 15 +-- lib/plausible_web/live/sites.ex | 14 +-- 6 files changed, 100 insertions(+), 74 deletions(-) diff --git a/lib/plausible_web/live/flash.ex b/lib/plausible_web/live/flash.ex index 384399011..60a0c72a5 100644 --- a/lib/plausible_web/live/flash.ex +++ b/lib/plausible_web/live/flash.ex @@ -2,15 +2,55 @@ defmodule PlausibleWeb.Live.Flash do @moduledoc """ Flash component for LiveViews - works also when embedded within dead views """ - use Phoenix.LiveComponent + + use Phoenix.Component alias Phoenix.LiveView.JS alias Phoenix.Flash - def render(assigns) do + @flash_timer_assigns %{ + success: :clear_flash_success, + error: :clear_flash_error + } + + @flash_timer_timeout_ms 5000 + + defmacro __using__(_opts) do + quote do + import PlausibleWeb.Live.Flash, only: [put_live_flash: 3, flash_messages: 1] + + def handle_info({:clear_live_flash, key}, socket) do + {:noreply, Phoenix.LiveView.clear_flash(socket, key)} + end + end + end + + def put_live_flash(socket, key, message) when key in [:success, :error] do + timer_key = Map.fetch!(@flash_timer_assigns, key) + + if flash_timer = socket.assigns[timer_key] do + Process.cancel_timer(flash_timer) + end + + flash_timer = + Process.send_after( + self(), + {:clear_live_flash, key}, + @flash_timer_timeout_ms + ) + + socket + |> Phoenix.LiveView.put_flash(key, message) + |> assign(timer_key, flash_timer) + end + + def flash_messages(assigns) do ~H"""
-
- <.flash :if={Flash.get(@flash, :success)}> +
+ <.flash :if={Flash.get(@flash, :success)} key="success"> <:icon> <.icon_success /> @@ -21,7 +61,7 @@ defmodule PlausibleWeb.Live.Flash do <%= Flash.get(@flash, :success) %> - <.flash :if={Flash.get(@flash, :error)}> + <.flash :if={Flash.get(@flash, :error)} key="error"> <:icon> <.icon_error /> @@ -32,15 +72,14 @@ defmodule PlausibleWeb.Live.Flash do <%= Flash.get(@flash, :error) %> -
-