Title: Create FAQ Page
Version: 0.1.1
Description: Create Frequently Asked Questions page for Shiny application.
Suggests: knitr, rmarkdown
VignetteBuilder: knitr
License: MIT + file LICENSE
Imports: htmlwidgets, jsonlite
Encoding: UTF-8
LazyData: true
RoxygenNote: 7.1.1
NeedsCompilation: no
Packaged: 2021-01-24 17:54:15 UTC; jienamclellan
Author: Jiena McLellan ORCID iD [aut, cre], Michael Condouris ORCID iD [ctb], Alex Lais [ctb], Jason Forrest [ctb], Gunvansh Khanna [ctb]
Maintainer: Jiena McLellan <jienagu90@gmail.com>
Repository: CRAN
Date/Publication: 2021-01-24 18:10:02 UTC

FAQ page

Description

Create FAQ page

Usage

faq(
  data,
  width = NULL,
  height = NULL,
  elementId = NULL,
  faqtitle = "Frequently Asked Questions",
  expand_all_button_text = "+ Expand All",
  collapse_all_button_text = "- Collapse All",
  content_background_color = "white"
)

Arguments

data

df with question and answer columns

width

width of this widget

height

height of this widget

elementId

ellement ID of this widget

faqtitle

title for this widgets

expand_all_button_text

text on expand all button

collapse_all_button_text

text on collapse all button

content_background_color

background color for answers

Examples

df <- data.frame(
question = c("Question1", "Question2", "Question3"),
answer = c("answer for question1",
           "question2 answer",
           "answer3")
)
faq::faq(data = df, elementId = "faq", faqtitle = "Frequently Asked Questions")

Shiny bindings for faq

Description

Output and render functions for using faq within Shiny applications and interactive Rmd documents.

Usage

faqOutput(outputId, width = "100%", height = "100%")

renderFaq(expr, env = parent.frame(), quoted = FALSE)

Arguments

outputId

output variable to read from

width

width of the widget

height

height of the widget

expr

An expression that generates a faq

env

The environment in which to evaluate expr.

quoted

Is expr a quoted expression (with quote())? This is useful if you want to save an expression in a variable.