@callback click(
  t(),
  Pages.http_method(),
  Pages.text_filter() | nil,
  HtmlQuery.Css.selector()
) ::
  Pages.result() | no_return()

Click an element within a page. Implementation for Pages.click/4.

@callback handle_redirect(t()) :: Pages.result()

Wait for a server-issued redirect. Implementation for Pages.handle_redirect/1.

@callback open_browser(t()) :: t()

Attempt to open the current page in a web browser.

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

Render a change. Implementation for Pages.render_change/3.

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

Render a hook event. Implementation for Pages.render_hook/3.

@callback render_upload(t(), Pages.live_view_upload(), binary(), integer()) ::
  Pages.result()

Render a file upload. Implementation for Pages.render_upload/4.

@callback rerender(t()) :: Pages.result()

Re-renders the page. Implementation for Pages.rerender/1.

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

Submit a form targeted by the given selector. Implementation for Pages.submit_form/2.

@callback submit_form(
  t(),
  HtmlQuery.Css.selector(),
  attrs :: Pages.attrs_t(),
  hidden_attrs :: Pages.attrs_t()
) :: Pages.result()

Submit a form targeted by the given selector. Implementation for Pages.submit_form/3.

@callback submit_form(
  t(),
  HtmlQuery.Css.selector(),
  schema :: atom(),
  attrs :: Pages.attrs_t(),
  hidden_attrs :: Pages.attrs_t()
) :: Pages.result()

Fills in a form with the attributes and submits it. Implementation for Pages.submit_form/5.

@callback update_form(
  t(),
  HtmlQuery.Css.selector(),
  attrs :: Pages.attrs_t(),
  opts :: Keyword.t()
) :: Pages.result()

Fills in a form with the attributes without submitting it. Implementation for Pages.update_form/4.

When interactive with forms backed by multiple changesets, or forms not backed by any changesets, one may choose to pass custon nested maps or keywords matching the structure of the params to be received in a controller or live view.

@callback update_form(
  t(),
  HtmlQuery.Css.selector(),
  schema :: atom(),
  attrs :: Pages.attrs_t(),
  opts :: Keyword.t()
) :: Pages.result()

Fills in a form with the attributes without submitting it. Implementation for Pages.update_form/5.

When updating a form built using Phoenix.Component.to_form/2 with the :as option, one may use the name prefix of the form as the :schema atom.

@callback visit(t(), Path.t()) :: Pages.result()

Navigate directly to a page. Implementation for Pages.visit/2.

@callback with_child_component(t(), child_id :: binary(), (t() -> term())) :: t()

Target a child component for actions. Implementation for Pages.with_child_component/3.