Skip to contents

Adds a modal definition to your content collection. Use markdown links with .modal-link class to trigger the modal.

Usage

add_modal(
  content_collection,
  modal_id,
  title = NULL,
  modal_content = NULL,
  image = NULL,
  ...
)

Arguments

content_collection

A content_collection or viz_collection to add modal to

modal_id

Unique ID for this modal (used in markdown link)

title

Modal title (optional)

modal_content

Text content - can be plain text, HTML, or data.frame

image

Optional image URL or path

...

Additional content (data.frames will be converted to tables)

Value

Updated content_collection with modal added

Examples

if (FALSE) { # \dontrun{
# Pipeable syntax (RECOMMENDED)
content <- create_content() %>%
  add_text("## Results") %>%
  add_text("[View details](#details){.modal-link}") %>%
  add_modal(
    modal_id = "details",
    title = "Full Results",
    modal_content = "Detailed analysis here..."
  )

# With image
content <- create_viz() %>%
  add_viz(type = "column", x_var = "x", y_var = "y") %>%
  add_modal(
    modal_id = "chart-details",
    title = "Chart Details",
    image = "chart.png",
    modal_content = "This chart shows..."
  )

# With data.frame (auto-converts to table)
content <- create_content() %>%
  add_text("[View data](#data){.modal-link}") %>%
  add_modal(
    modal_id = "data",
    title = "Raw Data",
    modal_content = head(mtcars, 10)
  )
} # }