R/accordion-item.R

In calcite: Bindings to the Calcite Design System 'JavaScript' Component Library

#' Create a Calcite Accordion Item Component
#'
#' Creates an individual accordion item that can be used within a calcite-accordion.
#' Accordion items can be expanded and collapsed to show or hide content.
#'
#' @param ... Child content for the accordion item (default slot)
#' @param id Component ID (required for Shiny reactivity)
#' @param heading Heading text for the accordion item
#' @param description Description text displayed in the header
#' @param expanded Whether the item is currently expanded (default: FALSE)
#' @param heading_level Semantic heading level (1-6) for accessibility
#' @param icon_start Icon to display at the start of the header
#' @param icon_end Icon to display at the end of the header
#' @param icon_flip_rtl Flip icons in RTL languages: "start", "end", or "both"
#' @param actions_start Content for the actions-start slot
#' @param actions_end Content for the actions-end slot
#' @param content_start Content for the content-start slot
#' @param content_end Content for the content-end slot
#'
#' @details
#' ## Shiny Integration
#'
#' The accordion item emits events when it's expanded or collapsed.
#'
#' **Available properties in `input$id`:**
#' - `$expanded` - Whether the item is currently expanded
#' - `$heading` - The heading text
#' - `$description` - The description text
#' - Other component properties
#'
#' **Basic usage:**
#' ```r
#' calcite_accordion_item(
#'   id = "item1",
#'   heading = "Watercraft",
#'   description = "Yachts, boats, and dinghies",
#'   icon_start = "embark",
#'   # Item content...
#' )
#'
#' # In server
#' observeEvent(input$item1$expanded, {
#'   if (input$item1$expanded) {
#'     message("Item was expanded")
#'   } else {
#'     message("Item was collapsed")
#'   }
#' })
#' ```
#'
#' @export
#' @return An object of class `calcite_component`
#' @references [Official Documentation](https://developers.arcgis.com/calcite-design-system/components/accordion-item/)
#' @examples
#' # Basic accordion item
#' calcite_accordion_item(
#'   id = "watercraft",
#'   heading = "Watercraft",
#'   description = "Yachts, boats, and dinghies",
#'   icon_start = "embark",
#'   "Content goes here..."
#' )
calcite_accordion_item <- function(
  ...,
  id = NULL,
  heading = NULL,
  description = NULL,
  expanded = NULL,
  heading_level = NULL,
  icon_start = NULL,
  icon_end = NULL,
  icon_flip_rtl = NULL,
  actions_start = NULL,
  actions_end = NULL,
  content_start = NULL,
  content_end = NULL
) {
  # Validate icon_flip_rtl if provided
  if (!is.null(icon_flip_rtl)) {
    icon_flip_rtl <- rlang::arg_match(icon_flip_rtl, c("start", "end", "both"))
  }

  # Validate heading_level if provided
  if (!is.null(heading_level)) {
    heading_level <- rlang::arg_match(
      as.character(heading_level),
      as.character(1:6)
    )
  }

  # Build attributes list
  attribs <- compact(list(
    id = id,
    heading = heading,
    description = description,
    expanded = expanded,
    `heading-level` = heading_level,
    `icon-start` = icon_start,
    `icon-end` = icon_end,
    `icon-flip-rtl` = icon_flip_rtl
  ))

  # Combine with dots (child content)
  extra_attribs <- rlang::dots_list(...)
  all_attribs <- c(
    attribs,
    extra_attribs[!names(extra_attribs) %in% names(attribs)]
  )

  # Collect all slot content
  slot_content <- c(
    add_slot(actions_start, "actions-start"),
    add_slot(actions_end, "actions-end"),
    add_slot(content_start, "content-start"),
    add_slot(content_end, "content-end")
  )

  # Remove NULLs
  slot_content <- Filter(Negate(is.null), slot_content)

  # Custom binding for accordion-item
  accordion_item_binding <- htmltools::htmlDependency(
    name = "calcite-accordion-item-binding",
    version = calcite_version(),
    src = c(file = system.file("www", package = "calcite")),
    script = "calcite-accordion-item.js"
  )

  res <- htmltools::tag(
    "calcite-accordion-item",
    c(
      all_attribs,
      slot_content,
      list(calcite_dependency(), accordion_item_binding)
    )
  )

  class(res) <- c("calcite_component", class(res))
  res
}