소스 검색

Update modifiers documentation

master
Garrick Aden-Buie 7 년 전
부모
커밋
cbc43ac8af
9개의 변경된 파일67개의 추가작업 그리고 26개의 파일을 삭제
  1. +14
    -13
      R/modifiers.R
  2. +8
    -2
      man/bulma_color.Rd
  3. +9
    -2
      man/bulma_helper.Rd
  4. +8
    -2
      man/bulma_modifier.Rd
  5. +7
    -2
      man/bulma_responsive.Rd
  6. +7
    -2
      man/bulma_responsive_alignment.Rd
  7. +6
    -1
      man/bulma_responsive_size.Rd
  8. +7
    -2
      man/bulma_typography.Rd
  9. +1
    -0
      tests/manual/example/bulma-test.Rmd

+ 14
- 13
R/modifiers.R 파일 보기

@@ -10,8 +10,8 @@
#' @return String of modifer classes
#' @examples
#' bulma_modifier(color = "primary", size = "large", state = "outlined")
#' @references https://bulma.io/documentation/modifiers/syntax/
#' @seealso Bulma modifiers
#' @references <https://bulma.io/documentation/modifiers/syntax/>
#' @family Bulma modifiers
#' @return String of modifier classes
#' @export
bulma_modifier <- function(color = NULL, size = NULL, state = NULL) {
@@ -36,6 +36,7 @@ bulma_modifier <- function(color = NULL, size = NULL, state = NULL) {
#'
#' `paddingless` Removes any padding
#' @param other `overlay` Completely covers the first positioned parent
#'
#' `clipped` Adds overflow hidden
#'
#' `radiusless` Removes any radius
@@ -52,8 +53,8 @@ bulma_modifier <- function(color = NULL, size = NULL, state = NULL) {
#' bulma_helper(float = "pulled-left")
#' bulma_helper(spacing = c("marginless", "paddingless"))
#' bulma_helper(other = "clipped", float = "pulled-right")
#' @references https://bulma.io/documentation/modifiers/helpers
#' @seealso Bulma modifiers
#' @references <https://bulma.io/documentation/modifiers/helpers>
#' @family Bulma modifiers
#' @return String of modifier classes
#' @export
bulma_helper <- function(float = NULL, spacing = NULL, other = NULL) {
@@ -78,9 +79,9 @@ bulma_helper <- function(float = NULL, spacing = NULL, other = NULL) {
#' @examples
#' bulma_responsive("flex", "tablet")
#' bulma_responsive("flex", "widescreen", only = TRUE)
#' @references https://bulma.io/documentation/modifiers/responsive-helpers/
#' @references <https://bulma.io/documentation/modifiers/responsive-helpers/>
#' @return A string of helper classes
#' @seealso Bulma modifiers
#' @family Bulma modifiers
#' @export
bulma_responsive <- function(display = NULL, viewport = NULL, only = FALSE) {
display <- validate_value(display, c(
@@ -111,9 +112,9 @@ validate_viewport <- function(viewport, var_name = "viewport") {
#' bulma_color("white", "black")
#' bulma_color("white", "primary")
#'
#' @references https://bulma.io/documentation/modifiers/color-helpers
#' @references <https://bulma.io/documentation/modifiers/color-helpers>
#' @return String of modifer classes
#' @seealso Bulma modifiers
#' @family Bulma modifiers
#' @export
bulma_color <- function(text = NULL, background = NULL) {
text <- validate_color(text, "text")
@@ -146,9 +147,9 @@ validate_color <- function(color, var_name = "text", prefix = paste0(var_name, "
#' bulma_color("white", "black")
#' bulma_color("white", "primary")
#'
#' @references https://bulma.io/documentation/modifiers/typography-helpers/
#' @references <https://bulma.io/documentation/modifiers/typography-helpers/>
#' @return String of modifer classes
#' @seealso Bulma modifiers
#' @family Bulma modifiers
#' @export
bulma_typography <- function(
size = NULL,
@@ -203,7 +204,7 @@ validate_alignment <- function(alignment, var_name = "alignment", prefix = "text
#' bulma_responsive_size(2, "tablet")
#' bulma_responsive_size(viewport = "widescreen")
#' @return String of modifier classes
#' @seealso Bulma modifiers
#' @family Bulma modifiers
#' @export
bulma_responsive_size <- function(size = "1", viewport = "desktop") {
# TODO: Needs to be vectorized, matching size/viewport arguments
@@ -233,8 +234,8 @@ use_bulma_responsive <- function(x, var, varname) {
#' bulma_responsive_alignment("centered", "tablet")
#' bulma_responsive_alignment(viewport = "widescreen")
#' @return String of modifier classes
#' @references https://bulma.io/documentation/modifiers/typography-helpers/#responsive-alignment
#' @seealso Bulma modifiers
#' @references <https://bulma.io/documentation/modifiers/typography-helpers/#responsive-alignment>
#' @family Bulma modifiers
#' @export
bulma_responsive_alignment <- function(alignment = "left", viewport = "desktop") {
# TODO: Needs to be vectorized, matching alignment/viewport arguments

+ 8
- 2
man/bulma_color.Rd 파일 보기

@@ -29,8 +29,14 @@ bulma_color("white", "primary")

}
\references{
https://bulma.io/documentation/modifiers/color-helpers
\url{https://bulma.io/documentation/modifiers/color-helpers}
}
\seealso{
Bulma modifiers
Other Bulma modifiers: \code{\link{bulma_helper}},
\code{\link{bulma_modifier}},
\code{\link{bulma_responsive_alignment}},
\code{\link{bulma_responsive_size}},
\code{\link{bulma_responsive}},
\code{\link{bulma_typography}}
}
\concept{Bulma modifiers}

+ 9
- 2
man/bulma_helper.Rd 파일 보기

@@ -18,6 +18,7 @@ bulma_helper(float = NULL, spacing = NULL, other = NULL)
\code{paddingless} Removes any padding}

\item{other}{\code{overlay} Completely covers the first positioned parent

\code{clipped} Adds overflow hidden

\code{radiusless} Removes any radius
@@ -44,8 +45,14 @@ bulma_helper(spacing = c("marginless", "paddingless"))
bulma_helper(other = "clipped", float = "pulled-right")
}
\references{
https://bulma.io/documentation/modifiers/helpers
\url{https://bulma.io/documentation/modifiers/helpers}
}
\seealso{
Bulma modifiers
Other Bulma modifiers: \code{\link{bulma_color}},
\code{\link{bulma_modifier}},
\code{\link{bulma_responsive_alignment}},
\code{\link{bulma_responsive_size}},
\code{\link{bulma_responsive}},
\code{\link{bulma_typography}}
}
\concept{Bulma modifiers}

+ 8
- 2
man/bulma_modifier.Rd 파일 보기

@@ -25,8 +25,14 @@ Bulma Modifier Classes
bulma_modifier(color = "primary", size = "large", state = "outlined")
}
\references{
https://bulma.io/documentation/modifiers/syntax/
\url{https://bulma.io/documentation/modifiers/syntax/}
}
\seealso{
Bulma modifiers
Other Bulma modifiers: \code{\link{bulma_color}},
\code{\link{bulma_helper}},
\code{\link{bulma_responsive_alignment}},
\code{\link{bulma_responsive_size}},
\code{\link{bulma_responsive}},
\code{\link{bulma_typography}}
}
\concept{Bulma modifiers}

+ 7
- 2
man/bulma_responsive.Rd 파일 보기

@@ -24,8 +24,13 @@ bulma_responsive("flex", "tablet")
bulma_responsive("flex", "widescreen", only = TRUE)
}
\references{
https://bulma.io/documentation/modifiers/responsive-helpers/
\url{https://bulma.io/documentation/modifiers/responsive-helpers/}
}
\seealso{
Bulma modifiers
Other Bulma modifiers: \code{\link{bulma_color}},
\code{\link{bulma_helper}}, \code{\link{bulma_modifier}},
\code{\link{bulma_responsive_alignment}},
\code{\link{bulma_responsive_size}},
\code{\link{bulma_typography}}
}
\concept{Bulma modifiers}

+ 7
- 2
man/bulma_responsive_alignment.Rd 파일 보기

@@ -25,8 +25,13 @@ bulma_responsive_alignment("centered", "tablet")
bulma_responsive_alignment(viewport = "widescreen")
}
\references{
https://bulma.io/documentation/modifiers/typography-helpers/#responsive-alignment
\url{https://bulma.io/documentation/modifiers/typography-helpers/#responsive-alignment}
}
\seealso{
Bulma modifiers
Other Bulma modifiers: \code{\link{bulma_color}},
\code{\link{bulma_helper}}, \code{\link{bulma_modifier}},
\code{\link{bulma_responsive_size}},
\code{\link{bulma_responsive}},
\code{\link{bulma_typography}}
}
\concept{Bulma modifiers}

+ 6
- 1
man/bulma_responsive_size.Rd 파일 보기

@@ -25,5 +25,10 @@ bulma_responsive_size(2, "tablet")
bulma_responsive_size(viewport = "widescreen")
}
\seealso{
Bulma modifiers
Other Bulma modifiers: \code{\link{bulma_color}},
\code{\link{bulma_helper}}, \code{\link{bulma_modifier}},
\code{\link{bulma_responsive_alignment}},
\code{\link{bulma_responsive}},
\code{\link{bulma_typography}}
}
\concept{Bulma modifiers}

+ 7
- 2
man/bulma_typography.Rd 파일 보기

@@ -39,8 +39,13 @@ bulma_color("white", "primary")

}
\references{
https://bulma.io/documentation/modifiers/typography-helpers/
\url{https://bulma.io/documentation/modifiers/typography-helpers/}
}
\seealso{
Bulma modifiers
Other Bulma modifiers: \code{\link{bulma_color}},
\code{\link{bulma_helper}}, \code{\link{bulma_modifier}},
\code{\link{bulma_responsive_alignment}},
\code{\link{bulma_responsive_size}},
\code{\link{bulma_responsive}}
}
\concept{Bulma modifiers}

+ 1
- 0
tests/manual/example/bulma-test.Rmd 파일 보기

@@ -29,6 +29,7 @@ output:
toc: yes
toc_depth: 2
# css: custom.css
rmarkdown::html_document: default
html_document_base:
pandoc_args: ["--template", "/Users/4468739/work/bulmaRmd/inst/bulma/bulma-min.html" ]
md_document: default

Loading…
취소
저장