R/wa_animation.R

In shiny.webawesome: 'shiny' Bindings for 'Web Awesome' Components

# Generated by tools/generate_components.R. Do not edit by hand.
# nolint start: object_usage_linter.

#' Create a `wa-animation` component
#'
#' Generated wrapper for the Web Awesome `wa-animation` component.
#' Generated from Web Awesome metadata.
#'
#' @param ... Child content for the component's default slot.
#' @param id Optional DOM id attribute for HTML, CSS, and JS targeting.
#' @param class Optional CSS class string.
#' @param style Optional inline CSS style string.
#' @param name String. Default: `none`. The name of the built-in animation
#' to use. For custom animations, use the `keyframes` prop.
#' @param delay Number. Default: `0`. The number of milliseconds to delay
#' the start of the animation.
#' @param dir String. Optional Web Awesome attribute.
#' @param direction Default: `'normal'`. Determines the direction of
#' playback as well as the behavior when reaching the end of an iteration.
#' Learn more
#' @param duration Number. Default: `1000`. The number of milliseconds
#' each iteration of the animation takes to complete.
#' @param easing String. Default: `linear`. The easing function to use for
#' the animation. This can be a Web Awesome easing function or a custom
#' easing function such as `cubic-bezier(0, 1, .76, 1.14)`.
#' @param end_delay Number. Default: `0`. The number of milliseconds to
#' delay after the active period of an animation sequence.
#' @param fill Default: `'auto'`. Sets how the animation applies styles to
#' its target before and after its execution.
#' @param iteration_start Number. Default: `0`. The offset at which to
#' start the animation, usually between 0 (start) and 1 (end).
#' @param iterations Number. Default: `Infinity`. The number of iterations
#' to run before the animation completes. Defaults to `Infinity`, which
#' loops.
#' @param lang String. Optional Web Awesome attribute.
#' @param play Boolean. Default: `FALSE`. Plays the animation. When
#' omitted, the animation will be paused. This attribute will be
#' automatically removed when the animation finishes or gets canceled.
#' @param playback_rate Number. Default: `1`. Sets the animation's
#' playback rate. The default is `1`, which plays the animation at a
#' normal speed. Setting this to `2`, for example, will double the
#' animation's speed. A negative value can be used to reverse the
#' animation. This value can be changed without causing the animation to
#' restart.
#'
#' @section Shiny Bindings:
#' None.
#'
#' @return An HTML tag for the component.
#'
#' @export
wa_animation <- function(
  ...,
  id = NULL,
  class = NULL,
  style = NULL,
  name = NULL,
  delay = NULL,
  dir = NULL,
  direction = NULL,
  duration = NULL,
  easing = NULL,
  end_delay = NULL,
  fill = NULL,
  iteration_start = NULL,
  iterations = NULL,
  lang = NULL,
  play = NULL,
  playback_rate = NULL
) {
  children <- list(...)

  attrs <- .wa_normalize_attrs(
    list(
      "id" = id,
      "class" = class,
      "style" = style,
      "name" = name,
      "delay" = delay,
      "dir" = dir,
      "direction" = direction,
      "duration" = duration,
      "easing" = easing,
      "end-delay" = end_delay,
      "fill" = fill,
      "iteration-start" = iteration_start,
      "iterations" = iterations,
      "lang" = lang,
      "play" = play,
      "playback-rate" = playback_rate
    ),
    boolean_names = c("play"),
    boolean_arg_names = c("play" = "play")
  )

  do.call(
    .wa_component,
    c(
      list("wa-animation", .attrs = attrs),
      children
    )
  )
}
# nolint end