add_oc: Create a BS5 off canvas menu

View source: R/add_oc.R

add_ocR Documentation

Create a BS5 off canvas menu

Description

Create a BS5 off canvas menu

Usage

add_oc(
  id = NULL,
  body = NULL,
  position = c("top", "bottom", "start", "end"),
  scroll = FALSE,
  backdrop = TRUE,
  header = TRUE,
  title = NULL,
  close_btn = TRUE,
  class_btn = NULL,
  class_oc = NULL,
  class_header = NULL,
  class_body = NULL
)

Arguments

id

id of the off canvas menu

body

HTML body of the off canvas menu

position

position of the off-canvas (top, bottom, start or end)

scroll

allow body scrolling (TRUE or FALSE)

backdrop

allow body backdrop (TRUE or FALSE)

header

Has the off canvas a header ? (TRUE or FALSE)

title

HTML title of the off canvas menu

close_btn

close button in the header ? (TRUE or FALSE)

class_btn

Additional HTML class for the close button

class_oc

Additional HTML class for the off canvas

class_header

Additional HTML class for the off canvas title

class_body

Additional HTML class for the off canvas body

Value

a BS5 off canvas menu

Examples

add_oc(
id = "id_oc",
header = TRUE,
title = "Title !",
body ="Body !",
position = "end",
class_header = "bg-primary",
class_body = "bg-light",
class_btn = "btn-success",
class_oc ="border border-primary",
scroll = TRUE,
backdrop = TRUE,
close_btn = TRUE
)

mhanf/multiplyR documentation built on May 17, 2022, 7:41 a.m.