Packages

backpex

0.16.0
0.19.6 0.19.5 0.19.4 0.19.3 0.19.2 0.19.1 0.19.0 0.18.3 0.18.2 0.18.1 0.18.0 0.17.4 0.17.3 0.17.2 0.17.1 0.17.0 0.16.3 0.16.2 0.16.1 0.16.0 0.15.3 0.15.2 0.15.1 0.15.0 0.14.0 0.13.0 0.12.0 0.11.0 0.10.0 0.9.1 0.9.0 0.8.2 0.8.1 0.8.0 0.7.1 0.7.0 0.6.0 0.5.1 0.5.0 0.4.0 0.3.2 0.3.1 0.3.0 0.2.0 0.1.1

Highly customizable administration panel for Phoenix LiveView applications.

HexDocs

Current section

Files

Jump to
Readme
45 Versions
15 Dependencies
Dependants
Files
Activity
backpex lib backpex metric.ex
Raw

lib/backpex/metric.ex 

defmodule Backpex.Metric do

  @moduledoc ~S"""

  Behaviour implemented by all metrics.



  Metrics are info boxes for your resources displaying key indicators prominently on the index view in your application.

  An example could be to show the current total of all orders received today. You may create your own metrics by

  implementing this behaviour.

  """



  @doc """

  Used to render the metric as a heex template on the index views.

  """

  @callback render(assigns :: map()) :: %Phoenix.LiveView.Rendered{}

  @callback query(query :: Ecto.Queryable.t(), select :: any(), repo :: Ecto.Repo.t()) ::

              Ecto.Schema.t() | term() | nil

  @callback format(data :: any(), format :: any()) :: term()



  @doc """

  Determine if metrics are visible for given live_resource.

  """

  def metrics_visible?(%{} = visibility, resource) when is_atom(resource) do

    metrics_visible?(visibility, Atom.to_string(resource))

  end



  def metrics_visible?(%{} = visibility, resource) do

    Map.get(visibility, resource, true)

  end

end