text_input_page: Text input page

In pmcharrison/psychTestR: Framework for delivering psychological tests via Shiny

Text input page

Description

Creates a page where the participant puts their answer in a text box.

Usage

text_input_page(
  label,
  prompt,
  one_line = TRUE,
  save_answer = TRUE,
  placeholder = NULL,
  button_text = "Next",
  width = "300px",
  height = "100px",
  validate = NULL,
  on_complete = NULL,
  admin_ui = NULL
)

Arguments

label	Label for the current page (character scalar).
prompt	Prompt to display (character scalar or Shiny tag object).
one_line	Whether the answer box only has one line of text.
save_answer	Whether or not to save the answer.
placeholder	Placeholder text for the text box (character scalar).
button_text	Text for the submit button (character scalar).
width	Width of the text box (character scalar, should be valid HTML).
height	Height of the text box (character scalar, should be valid HTML).
validate	Optional validation function. The argument list should include ..., and any of: answer, the participant's most recent answer; state, the participant's state object; input, the current page's Shiny input object; opt, the test's option list as created by test_options(); session, the current Shiny session object. It should return TRUE for a successful validation; for an unsuccessful validation, it should return either FALSE or a character scalar error message. If validation fails then the page will be refreshed, usually to give the user a chance to revise their input.
on_complete	Optional function to execute on leaving the page (after successful validation). The argument list should include ..., and any of: state, the participant's state object; answer, the participant's most recent answer; input, the current page's Shiny input object; session, the current Shiny session object; opt, the test's option list as created by test_options().
admin_ui	Optional UI component for the admin panel.

pmcharrison/psychTestR documentation built on Nov. 10, 2024, 9:03 p.m.