R/design-spacing.R

In nteetor/dull: A Reactive Web Framework Built on 'shiny'

#' Padding
#'
#' The `padding` utility changes the inner spacing of a tag element. The padding
#' of a tag element is the space between the tag element's border and its
#' content or child elements. All arguments default to `NULL`, in which case
#' they are ignored.
#'
#' @inheritParams affix
#'
#' @param all,top,right,bottom,left A [responsive] argument. One of `0:5` or
#'   `"auto"` specifying padding for one or more sides of the tag element. 0
#'   removes all inner space and 5 adds the most space.
#'
#' @keywords internal
#'
#' @export
#'
#' @examples
#'
#' div() %>% padding(2)
#' # ->
#' div() %>% cascadess::padding_all(2)
#'
padding <- function(x, all = NULL, top = NULL, right = NULL, bottom = NULL,
                    left = NULL) {
  lifecycle::deprecate_warn(
    "0.3.0",
    "padding()",
    "cascadess::padding_all()"
  )

  UseMethod("padding", x)
}

#' @export
padding.yonder_style_pronoun <- function(x, all = NULL, top = NULL,
                                         right = NULL, bottom = NULL,
                                         left = NULL) {
  NextMethod("padding", x)
}

#' @export
padding.rlang_box_splice <- function(x, all = NULL, top = NULL, right = NULL,
                                     bottom = NULL, left = NULL) {
  NextMethod("padding", unbox(x))
}

#' @export
padding.shiny.tag <- function(x, all = NULL, top = NULL, right = NULL,
                              bottom = NULL, left = NULL) {
  tag_class_add(x, c(
    padding_all(all),
    padding_top(top),
    padding_right(right),
    padding_bottom(bottom),
    padding_left(left)
  ))
}

#' @export
padding.default <- function(x, all = NULL, top = NULL, right = NULL,
                            bottom = NULL, left = NULL) {
  tag_class_add(x, c(
    padding_all(all),
    padding_top(top),
    padding_right(right),
    padding_bottom(bottom),
    padding_left(left)
  ))
}

padding_top <- function(top) {
  if (is.null(top)) {
    return(NULL)
  }

  top <- resp_construct(top, c(0:5, "auto"))

  sprintf("p%s", resp_classes(top, "t"))
}

padding_right <- function(right) {
  if (is.null(right)) {
    return(NULL)
  }

  right <- resp_construct(right, c(0:5, "auto"))

  sprintf("p%s", resp_classes(right, "r"))
}

padding_bottom <- function(bottom) {
  if (is.null(bottom)) {
    return(NULL)
  }

  bottom <- resp_construct(bottom, c(0:5, "auto"))

  sprintf("p%s", resp_classes(bottom, "b"))
}

padding_left <- function(left) {
  if (is.null(left)) {
    return(NULL)
  }

  left <- resp_construct(left, c(0:5, "auto"))

  sprintf("p%s", resp_classes(left, "l"))
}

padding_all <- function(all) {
  if (is.null(all)) {
    return(NULL)
  }

  all <- resp_construct(all, c(0:5, "auto"))

  resp_classes(all, "p")
}

#' Margins
#'
#' The `margin` utilty changes the outer spacing of a tag element. The margin of
#' a tag element is the space outside and around the tag element, its border,
#' and its content. All arguments default to `NULL`, in which case they are
#' ignored.
#'
#' @inheritParams affix
#'
#' @param all,top,right,bottom,left A [responsive] argument. One of `-5:5` or
#'   `"auto"` specifying a margin for one or more sides of the tag element. 0
#'   removes all outer space, 5 adds the most space, and negative values will
#'   consume space pulling the element in that direction.
#'
#' @keywords internal
#'
#' @export
#'
#' @examples
#'
#' div() %>% margin(2)
#' # ->
#' div() %>% cascadess::margin_all(2)
#'
margin <- function(x, all = NULL, top = NULL, right = NULL, bottom = NULL,
                   left = NULL) {
  lifecycle::deprecate_warn(
    "0.3.0",
    "margin()",
    "cascadess::margin_all()"
  )

  UseMethod("margin", x)
}

#' @export
margin.yonder_style_pronoun <- function(x, all = NULL, top = NULL,
                                        right = NULL, bottom = NULL,
                                        left = NULL) {
  NextMethod("margin", x)
}

#' @export
margin.rlang_box_splice <- function(x, all = NULL, top = NULL, right = NULL,
                                    bottom = NULL, left = NULL) {
  NextMethod("margin", unbox(x))
}

#' @export
margin.shiny.tag <- function(x, all = NULL, top = NULL, right = NULL,
                             bottom = NULL, left = NULL) {
  tag_class_add(x, c(
    margin_all(all),
    margin_top(top),
    margin_right(right),
    margin_bottom(bottom),
    margin_left(left)
  ))
}

#' @export
margin.default <- function(x, all = NULL, top = NULL, right = NULL,
                           bottom = NULL, left = NULL) {
  tag_class_add(x, c(
    margin_all(all),
    margin_top(top),
    margin_right(right),
    margin_bottom(bottom),
    margin_left(left)
  ))
}

margin_top <- function(top) {
  if (is.null(top)) {
    return(NULL)
  }

  top <- lapply(top, margin_negative)
  top <- resp_construct(top, c(0:5, "auto", "n1", "n2", "n3", "n4", "n5"))

  sprintf("m%s", resp_classes(top, "t"))
}

margin_right <- function(right) {
  if (is.null(right)) {
    return(NULL)
  }

  right <- lapply(right, margin_negative)
  right <- resp_construct(right, c(0:5, "auto", "n1", "n2", "n3", "n4", "n5"))

  sprintf("m%s", resp_classes(right, "r"))
}

margin_bottom <- function(bottom) {
  if (is.null(bottom)) {
    return(NULL)
  }

  bottom <- lapply(bottom, margin_negative)
  bottom <- resp_construct(bottom, c(0:5, "auto", "n1", "n2", "n3", "n4", "n5"))

  sprintf("m%s", resp_classes(bottom, "b"))
}

margin_left <- function(left) {
  if (is.null(left)) {
    return(NULL)
  }

  left <- lapply(left, margin_negative)
  left <- resp_construct(left, c(0:5, "auto", "n1", "n2", "n3", "n4", "n5"))

  sprintf("m%s", resp_classes(left, "l"))
}

margin_all <- function(all) {
  if (is.null(all)) {
    return(NULL)
  }

  all <- lapply(all, margin_negative)
  all <- resp_construct(all, c(0:5, "auto", "n1", "n2", "n3", "n4", "n5"))

  resp_classes(all, "m")
}

margin_negative <- function(x) {
  if (x < 0) {
    paste0("n", abs(x))
  } else {
    x
  }
}