A scroll area with Element's own thin scrollbars.
Usage
el_scrollbar(
...,
id = NULL,
height = NULL,
max_height = NULL,
native = NULL,
wrap_style = NULL,
wrap_class = NULL,
view_style = NULL,
view_class = NULL,
noresize = NULL,
tag = NULL,
always = NULL,
min_size = NULL,
role = NULL,
aria_label = NULL,
aria_orientation = NULL,
tabindex = NULL,
distance = NULL,
width = NULL,
slots = NULL,
events = NULL,
on = NULL
)
update_el_scrollbar(
session = shiny::getDefaultReactiveDomain(),
id,
height = NULL,
max_height = NULL,
native = NULL,
wrap_style = NULL,
wrap_class = NULL,
view_style = NULL,
view_class = NULL,
noresize = NULL,
always = NULL,
min_size = NULL,
aria_label = NULL,
tabindex = NULL,
distance = NULL,
tag = NULL,
role = NULL,
aria_orientation = NULL
)Arguments
- ...
Its content: any Shiny UI. Components of this package are folded into this one's Vue instance, as
el_button_group()folds its buttons.- id
Component ID. Auto-generated if
NULL.- height
Height of scrollbar. Element Plus's
height(string / number).- max_height
Max height of scrollbar. Element Plus's
max-height(string / number).- native
Whether to use the native scrollbar style. Element Plus's
native(boolean).- wrap_style
Style of wrap container. Element Plus's
wrap-style(string / CSSProperties | CSSProperties[] | string[]).- wrap_class
Class of wrap container. Element Plus's
wrap-class(string).- view_style
Style of view. Element Plus's
view-style(string / CSSProperties | CSSProperties[] | string[]).- view_class
Class of view. Element Plus's
view-class(string).- noresize
Do not respond to container size changes, if the container size does not change, it is better to set it to optimize performance. Element Plus's
noresize(boolean).- tag
Element tag of the view. Element Plus's
tag(string).- always
Always show scrollbar. Element Plus's
always(boolean).- min_size
Minimum size of scrollbar. Element Plus's
min-size(number).- role
Role of view. Element Plus's
role(string).- aria_label
Aria-label of view. Element Plus's
aria-label(string).- aria_orientation
Aria-orientation of view. Element Plus's
aria-orientation('horizontal' | 'vertical').- tabindex
Tabindex of wrap container. Element Plus's
tabindex(number / string).- distance
Trigger end-reached event distance(px). Element Plus's
distance(number).- width
Component width, as a CSS unit.
- slots
Named list of Element slot contents. A scoped slot is written with
template().- events
Element's events to report besides those reported unasked, by name:
events = "node_drop"reportsinput$<id>_node_drop. The component's are listed under "Shiny inputs", and byel_events(); a name it does not have is an error.- on
Handlers of your own, for an event not reported or to send something else: a named list of
JS()functions, one per event – Element's, or a DOM event with Vue's modifiers ("keyup.enter"). Each is called withreportand the event's arguments;report(name, value)setsinput$<id>_<name>. Seeel_widget().- session
Shiny session; the current one by default, as for
shiny::updateTextInput().
Shiny inputs
| Input | Reported | Value |
input$<id>_scroll | events = "scroll" | list(scrollLeft, scrollTop), at most every 200 ms |
input$<id>_end_reached | unasked | triggers when the end of a scroll is triggered |
The same list as el_events("el_scrollbar"), which says how an event's arguments travel.
Element methods
Callable with call_el(): handleScroll(), scrollTo(), setScrollTop(), setScrollLeft(), update().
Updating from the server
update_el_scrollbar() changes the component from the server: every argument of
el_scrollbar() that can change once it is drawn, under the same name. One left
NULL stays as it is; NA returns it to Element's default.
update_el_scrollbar() is called for its side effect and returns NULL invisibly.
Examples
el_scrollbar(height = "200px", lapply(1:20, function(i) shiny::tags$p(i)))
#> <div id="el_scrollbar_22079745-4483-4d49-a4d5-4fd639c0ae0c" data-shiny-vue style="display: contents">
#> <script type="text/x-template" data-shiny-vue-template><div id="el_scrollbar_22079745-4483-4d49-a4d5-4fd639c0ae0c_container" style="display: contents">
#> <el-scrollbar v-bind="$optional('scrollbar')" @end-reached="svEmitEndReached">
#> <p>1</p>
#> <p>2</p>
#> <p>3</p>
#> <p>4</p>
#> <p>5</p>
#> <p>6</p>
#> <p>7</p>
#> <p>8</p>
#> <p>9</p>
#> <p>10</p>
#> <p>11</p>
#> <p>12</p>
#> <p>13</p>
#> <p>14</p>
#> <p>15</p>
#> <p>16</p>
#> <p>17</p>
#> <p>18</p>
#> <p>19</p>
#> <p>20</p>
#> </el-scrollbar>
#> </div></script>
#> <script type="application/json" data-shiny-vue-options>{"options":{"data":{"height":"200px","maxHeight":null,"native":null,"wrapStyle":null,"wrapClass":null,"viewStyle":null,"viewClass":null,"noresize":null,"tag":null,"always":null,"minSize":null,"role":null,"ariaLabel":null,"ariaOrientation":null,"tabindex":null,"distance":null},"methods":{"svEmitEndReached":"function() { window.shinyVue.emit('el_scrollbar_22079745-4483-4d49-a4d5-4fd639c0ae0c', 'end_reached', arguments); }"}},"input":null,"rate":null,"type":null,"use":["shinyElement.plugin"],"optional":{"scrollbar":{"height":"height","max-height":"maxHeight","native":"native","wrap-style":"wrapStyle","wrap-class":"wrapClass","view-style":"viewStyle","view-class":"viewClass","noresize":"noresize","tag":"tag","always":"always","min-size":"minSize","role":"role","aria-label":"ariaLabel","aria-orientation":"ariaOrientation","tabindex":"tabindex","distance":"distance"}},"generated":true,"evals":["options.methods.svEmitEndReached"]}</script>
#> </div>