Scrivener.HTML.Parse (scrivener_html_semi v3.1.1) View Source

Link to this section Summary

Functions

add_last(list, last, total_pages)

defaults()

Return default options.

get_distance(range)

get_page_range(page_number, total_pages, range, left_distance, right_distance)

parse(page, options \\ [])

Returns the raw data in order to generate the proper HTML for pagination.

Link to this section Functions

add_last(list, last, total_pages)

defaults()

Return default options.

get_distance(range)

get_page_range(page_number, total_pages, range, left_distance, right_distance)

parse(page, options \\ [])

Returns the raw data in order to generate the proper HTML for pagination.

Default options

Default options are supplied as following:

[range: 5, prev: "PREV", next: "NEXT", first?: true, last?: true, ellipsis: {:safe, "&hellip;"}]

:range declares how many pages are shown. It should be an integer greater than or equal to 3.
:prev and :next declares text for previous and next buttons. Generally, they are string. Falsy values will remove them from output.
:first? and last? declares whether to show first / last page and corresponding ellipsis.
:ellipsis declares the text shown as ellipsis.

Return value

Return value is a list of tuples.

Examples

iex> parse(%Scrivener.Page{total_pages: 10, page_number: 5}, [])
[
  {:prev, 4, "PREV"},
  {1, 1},
  {:ellipsis, {:safe, "&hellip;"}},
  {4, 4},
  {5, 5},
  {6, 6},
  {:ellipsis, {:safe, "&hellip;"}},
  {10, 10},
  {:next, 6, "NEXT"}
]