Element Plus's el-tour-step, for el_tour(steps =).
Usage
el_tour_step(
target = NULL,
title = NULL,
description = NULL,
header = NULL,
show_arrow = NULL,
placement = NULL,
content_style = NULL,
mask = NULL,
type = NULL,
next_button_props = NULL,
prev_button_props = NULL,
scroll_into_view_options = NULL,
show_close = NULL,
close_icon = NULL
)Arguments
- target
The element the step points at, as a CSS selector.
NULLshows the step in the middle of the screen.- title, description
The step's title and text.
- header
Markup in place of the title.
- show_arrow
Whether to show the arrow.
- placement
Where the card goes, relative to the target:
"top","bottom"(Element's default),"left","right", each also with"-start"or"-end".- content_style
Style of the content, a list of CSS properties.
- mask
Whether to mask the page, or the mask's
list(style =, color =).- type
"default"or"primary": the card's colours.The Next and Previous buttons' properties:
list(children = "Go on").- scroll_into_view_options
Whether to scroll the target into view, or the options for
scrollIntoView().- show_close
Whether to show a close button.
- close_icon
The close button's icon, by name.
Binding
No argument follows v_bind(): a step is drawn by el_tour() from R.
Examples
el_tour(
"tour",
steps = list(
el_tour_step("#upload", "Upload File", "Put your files here."),
el_tour_step(title = "Done", description = "That is all.")
)
)
#> <div id="tour" data-shiny-vue style="display: contents">
#> <script type="text/x-template" data-shiny-vue-template><div id="tour_container" style="display: contents">
#> <el-tour v-bind="$optional('tour')" v-model="open" v-model:current="current" @close="handleClose" @change="svEmitChange" @finish="svEmitFinish">
#> <el-tour-step :target=""#upload"" :title=""Upload File"" :description=""Put your files here.""></el-tour-step>
#> <el-tour-step :title=""Done"" :description=""That is all.""></el-tour-step>
#> </el-tour>
#> </div></script>
#> <script type="application/json" data-shiny-vue-options>{"options":{"data":{"open":false,"current":0,"showArrow":null,"placement":null,"contentStyle":null,"mask":null,"gap":null,"type":null,"scrollIntoViewOptions":null,"zIndex":null,"showClose":null,"closeIcon":null,"closeOnPressEscape":null,"targetAreaClickable":null,"appendTo":null},"methods":{"svEmitChange":"function() { window.shinyVue.emit('tour', 'change', arguments); }","svEmitFinish":"function() { window.shinyVue.emit('tour', 'finish', arguments); }","handleClose":"function(step) { window.Shiny && Shiny.setInputValue && Shiny.setInputValue('tour_close', step, {priority: 'event'}); }"},"watch":{"open":"function(v) { }"}},"input":"open","rate":null,"type":null,"use":["shinyElement.plugin"],"optional":{"tour":{"show-arrow":"showArrow","placement":"placement","content-style":"contentStyle","mask":"mask","gap":"gap","type":"type","scroll-into-view-options":"scrollIntoViewOptions","z-index":"zIndex","show-close":"showClose","close-icon":"closeIcon","close-on-press-escape":"closeOnPressEscape","target-area-clickable":"targetAreaClickable","append-to":"appendTo"}},"evals":["options.methods.svEmitChange","options.methods.svEmitFinish","options.methods.handleClose","options.watch.open"]}</script>
#> </div>