| highlight {cicerone} | R Documentation |
Highlight & Initialise
Description
Initialise and highlight an element.
Usage
highlight(
el,
id,
title = NULL,
description = NULL,
position = NULL,
class = NULL,
show_btns = NULL,
close_btn_text = NULL,
next_btn_text = NULL,
prev_btn_text = NULL,
session = NULL
)
initialise(
id,
animate = TRUE,
opacity = 0.75,
padding = 10,
allow_close = TRUE,
overlay_click_next = FALSE,
done_btn_text = "Done",
close_btn_text = "Close",
stage_background = "#ffffff",
next_btn_text = "Next",
prev_btn_text = "Previous",
show_btns = TRUE,
keyboard_control = TRUE,
session = NULL
)
Arguments
el |
Id of element to be highlighted. |
id |
Unique identifier of cicerone. |
title |
Title on the popover. |
description |
Body of the popover. |
position |
Where to position the popover. See positions section. |
class |
className to wrap this specific step popover in addition to the general className in Driver options. |
show_btns |
Do not show control buttons in footer. |
close_btn_text |
Text on the close button for this step. |
next_btn_text |
Next button text for this step. |
prev_btn_text |
Previous button text for this step. |
session |
A valid Shiny session if |
animate |
Whether to animate or not. |
opacity |
Background opacity (0 means only popovers and without overlay). |
padding |
Distance of element from around the edges. |
allow_close |
Whether the click on overlay should close or not. |
overlay_click_next |
Whether the click on overlay should move next. |
done_btn_text |
Text on the final button. |
stage_background |
Background color for the staged behind highlighted element. |
keyboard_control |
Allow controlling through keyboard (escape to close, arrow keys to move). |
Position
left
right
left-center
left-bottom
top
top-center
top-right
right
right-center
right-bottom
bottom
bottom-center
mid-center