@spec clear_connect_params(Pages.Driver.t()) :: result()

Clears out any params set via Phoenix.LiveViewTest.put_connect_params/2

@spec click(Pages.Driver.t(), http_method(), text_filter(), HtmlQuery.Css.selector()) ::
  result()

Simulates clicking on an element at selector with title title. Set the method param to :post to click on a link that has data-method=post.

@spec get_context(Pages.Driver.t(), atom()) :: any()

Returns value from page's context. The context is a map that can be used to store test-specific information. See also put_context/3.

@spec handle_redirect(Pages.Driver.t()) :: result()

Handles cases where the server issues a redirect to the client without a synchronous interaction from the user. This may be used to handle redirects issued from Phoenix.LiveView.handle_info/2 callbacks, for instance.

@spec new(Plug.Conn.t(), context_t()) :: result()

Instantiates a new page.

@spec open_browser(Pages.Driver.t()) :: Pages.Driver.t()

Attempt to open the current page in a web browser.

@spec put_context(Pages.Driver.t(), atom(), any()) :: Pages.Driver.t()

Puts value in page's context and returns the page (not the context). The context is a map that can be used to store test-specific information. See also get_context/2.

@spec render_change(Pages.Driver.t(), HtmlQuery.Css.selector(), Enum.t()) :: result()

Render a change to the element at selector with the value value. See Phoenix.LiveViewTest.render_change/2 for a description of the value field.

@spec render_hook(Pages.Driver.t(), binary(), attrs_t(), keyword()) :: result()

Sends a hook event to the live view.

Arguments

Options

See Phoenix.LiveViewTest.render_hook/3 for more information.

@spec render_upload(
  Pages.Driver.t(),
  live_view_upload(),
  entry_name :: binary(),
  percent_complete :: integer()
) :: result()

Performs an upload of a file input and renders the result. See Phoenix.LiveViewTest.file_input/4 for more detailed documentation of the upload argument.

Example

entry = %{name: "file.jpg", content: File.read!("../path/to/file.jpg"), type: "image/jpeg"}
upload = Phoenix.LiveViewTest.file_input(page.live, "#selector", :entry_name, [entry])

page |> Pages.render_upload(upload, "file.jpg")

@spec rerender(Pages.Driver.t()) :: result()

Re-renders the page.

@spec submit_form(Pages.Driver.t(), HtmlQuery.Css.selector()) :: result()

Submits a form without specifying any attributes. This function will submit any values currently set in the form HTML.

@spec submit_form(Pages.Driver.t(), HtmlQuery.Css.selector(), attrs :: attrs_t()) ::
  result()

Fills in a form with attributes and submits it. Hidden parameters can by send by including a fifth enumerable.

Arguments

Schema

This atom determines the key under which attrs will be nested when sent to the server, and corresponds to the atom which an t:Ecto.Changeset.t/0 serializes to, or the value of :as passed to Phoenix.HTML.FormData.to_form/4.

When a schema is passed, the form attrs will be received as nested params under the schema key.

If one wishes to construct the full nested map of attrs, then the schema may be omitted.

Examples

iex> conn = Phoenix.ConnTest.build_conn()
iex> page = Pages.visit(conn, "/live/form")
iex> Pages.submit_form(page, "#form", :foo, value: "rerender")

iex> conn = Phoenix.ConnTest.build_conn()
iex> page = Pages.visit(conn, "/live/form")
iex> Pages.submit_form(page, "#form", foo: [value: "rerender"])

Notes

When used with LiveView, this will trigger phx-submit with the specified attributes, and handles phx-trigger-action if present.

@spec update_form(
  Pages.Driver.t(),
  HtmlQuery.Css.selector(),
  schema :: atom(),
  attrs :: attrs_t(),
  opts :: keyword()
) :: result()

Updates fields in a form with attributes, without submitting the form.

Arguments

Options

Schema

This atom determines the key under which attrs will be nested when sent to the server, and corresponds to the atom which an t:Ecto.Changeset.t/0 serializes to, or the value of :as passed to Phoenix.HTML.FormData.to_form/4.

When a schema is passed, the form attrs will be received as nested params under the schema key.

If one wishes to construct the full nested map of attrs, then the schema may be omitted.

Examples

iex> conn = Phoenix.ConnTest.build_conn()
iex> page = Pages.visit(conn, "/live/form")
iex> Pages.update_form(page, "#form", :my_form, value: "baz")

iex> conn = Phoenix.ConnTest.build_conn()
iex> page = Pages.visit(conn, "/live/form")
iex> Pages.update_form(page, "#form", my_form: [value: "baz"])

Notes

When used with LiveView, this will trigger phx-change with the specified attributes, and handles phx-trigger-action if present.

@spec visit(Pages.Driver.t(), Path.t(), context_t()) :: result()

@spec visit(Plug.Conn.t(), Path.t(), context_t()) :: result()

Visits path.

@spec with_child_component(
  Pages.Driver.t(),
  child_id :: binary(),
  (Pages.Driver.t() -> term())
) ::
  Pages.Driver.t()

Finds a phoenix component with an id matching child_id, and passes it to the given function. This is helpful when a site implements stateful LiveView components, and messages should be directed to a process other than the parent LiveView pid.

Examples

Pages.with_child_component(page, "chat-component", fn child ->
  Pages.submit_form(child,
    [test_role: "new-chat-message"],
    :chat_message,
    contents: "Hi there!")
end)