Packages
corex
0.1.0-rc.0
0.1.2
0.1.1
0.1.0
0.1.0-rc.1
0.1.0-rc.0
0.1.0-beta.5
0.1.0-beta.4
0.1.0-beta.3
0.1.0-beta.2
0.1.0-beta.1
0.1.0-alpha.33
0.1.0-alpha.32
0.1.0-alpha.31
0.1.0-alpha.30
0.1.0-alpha.29
0.1.0-alpha.28
0.1.0-alpha.27
0.1.0-alpha.26
0.1.0-alpha.25
0.1.0-alpha.24
0.1.0-alpha.23
0.1.0-alpha.22
0.1.0-alpha.21
0.1.0-alpha.20
0.1.0-alpha.19
0.1.0-alpha.18
0.1.0-alpha.17
0.1.0-alpha.16
0.1.0-alpha.15
0.1.0-alpha.14
0.1.0-alpha.13
0.1.0-alpha.12
0.1.0-alpha.11
0.1.0-alpha.10
0.1.0-alpha.9
0.1.0-alpha.8
0.1.0-alpha.7
0.1.0-alpha.6
0.1.0-alpha.5
0.1.0-alpha.4
0.1.0-alpha.3
0.1.0-alpha.2
0.1.0-alpha.1
Accessible and unstyled UI components library written in Elixir and TypeScript that integrates Zag.js state machines into the Phoenix Framework.
Current section
Files
Jump to
Current section
Files
lib/corex/flash.ex
defmodule Corex.Flash do
@moduledoc """
Configuration for Phoenix flash messages rendered as Zag toasts.
Used by [`Corex.Toast.toast_group/1`](Corex.Toast.html#toast_group/1) via the
`flash_info` and `flash_error` attributes. When `flash={@flash}` is set on the
layout toaster, `:info` and `:error` entries from `Phoenix.Flash` become toasts
with titles and durations from these structs (or equivalent maps).
If you omit `flash_info` / `flash_error`, [`Corex.Toast.Translation`](Corex.Toast.Translation.html)
supplies default titles and a 5000 ms duration.
## Example
<.toast_group
id="layout-toast"
class="toast"
flash={@flash}
flash_info={%Corex.Flash.Info{title: "Saved", type: :success, duration: 5000}}
flash_error={%Corex.Flash.Error{title: "Problem", type: :error, duration: :infinity}}
>
<:loading>
<.heroicon name="hero-arrow-path" />
</:loading>
<:close>
<.heroicon name="hero-x-mark" />
</:close>
</.toast_group>
Plain maps with the same keys (`:title`, `:type`, `:duration`) are also accepted.
"""
defmodule Info do
@moduledoc """
Defaults for Phoenix `:info` flashes shown by [`toast_group/1`](Corex.Toast.html#toast_group/1).
| Field | Type | Role |
| ----- | ---- | ---- |
| `title` | `String.t()` | Toast title; body text comes from the flash message |
| `type` | `:info` \\| `:success` \\| `:error` | Zag toast type / styling |
| `duration` | `integer()` \\| `:infinity` | Visible time in ms, or no auto-dismiss |
## Example
<.toast_group
id="layout-toast"
class="toast"
flash={@flash}
flash_info={%Corex.Flash.Info{title: "Success", type: :success, duration: 5000}}
>
<:loading>
<.heroicon name="hero-arrow-path" />
</:loading>
<:close>
<.heroicon name="hero-x-mark" />
</:close>
</.toast_group>
"""
defstruct [:title, :type, :duration]
@type t :: %__MODULE__{
title: String.t(),
type: :info | :success | :error,
duration: integer() | :infinity
}
end
defmodule Error do
@moduledoc """
Defaults for Phoenix `:error` flashes shown by [`toast_group/1`](Corex.Toast.html#toast_group/1).
| Field | Type | Role |
| ----- | ---- | ---- |
| `title` | `String.t()` | Toast title; body text comes from the flash message |
| `type` | `:info` \\| `:success` \\| `:error` | Zag toast type / styling |
| `duration` | `integer()` \\| `:infinity` | Visible time in ms, or no auto-dismiss |
## Example
<.toast_group
id="layout-toast"
class="toast"
flash={@flash}
flash_error={%Corex.Flash.Error{title: "Error", type: :error, duration: :infinity}}
>
<:loading>
<.heroicon name="hero-arrow-path" />
</:loading>
<:close>
<.heroicon name="hero-x-mark" />
</:close>
</.toast_group>
"""
defstruct [:title, :type, :duration]
@type t :: %__MODULE__{
title: String.t(),
type: :info | :success | :error,
duration: integer() | :infinity
}
end
end