Lit.PaginationView (Lit v0.1.2) View Source

Phoenix.View to render pagination controls for Lit-generated index templates.

Link to this section Summary

Functions

__phoenix_recompile__?()

Returns true whenever the list of templates changes in the filesystem.

The resource name, as an atom, for this view

__templates__()

Returns the template root alongside all templates.

next_link(conn, current_page, num_pages, sort_opts \\ nil)

Generates a "Next >" link to the next page of results. The link is only returned if there is another page.

prev_link(conn, current_page, sort_opts \\ nil)

Generates a "< Prev" link to the previous page of results. The link is only returned if there is a previous page.

render(template, assigns \\ %{})

Renders the given template locally.

template_not_found(template, assigns)

Callback invoked when no template is found. By default it raises but can be customized to render a particular template.

Link to this section Functions

__phoenix_recompile__?()

Returns true whenever the list of templates changes in the filesystem.

resource()

The resource name, as an atom, for this view

templates()

Returns the template root alongside all templates.

next_link(conn, current_page, num_pages, sort_opts \\ nil)

Generates a "Next >" link to the next page of results. The link is only returned if there is another page.

Examples

iex> next_link(%Plug.Conn{params: %{}}, 1, 2) |> safe_to_string()
"<a href=\"?page=2\">Next &gt;</a>"

iex> next_link(%Plug.Conn{}, 2, 2)
nil

prev_link(conn, current_page, sort_opts \\ nil)

Generates a "< Prev" link to the previous page of results. The link is only returned if there is a previous page.

Examples

iex> prev_link(%Plug.Conn{params: %{}}, 2) |> safe_to_string()
"<a href=\"?page=1\">&lt; Prev</a>"

If the current page is 1, returns nil:

iex> prev_link(%Plug.Conn{params: %{}}, 1)
nil

render(template, assigns \\ %{})

Renders the given template locally.

template_not_found(template, assigns)

Specs

template_not_found(Phoenix.Template.name(), map()) :: no_return()

Callback invoked when no template is found. By default it raises but can be customized to render a particular template.