Package index

Getting started

The page, its theme, and the scripts and styles a page needs.

el_page(): Element Plus Page Wrapper with Theme Support
el_theme(): Element Plus's look, as a Bootstrap theme
use_element(): Element Plus for a page of your own
el_locales(): Collapse Handler Dependency Languages Element Plus can use for its built-in text
element_plus_dependency(): Element Plus Dependency
el_locale_dependency(): Element Plus Locale Dependency
el_layout_css_dependency(): Element Plus Layout CSS Dependency
el_feedback_dependency(): Feedback Handler Dependency
el_config_provider() update_el_config_provider(): Element Plus Config Provider

Basic

As in Element Plus’s documentation.

el_button() update_el_button(): Element Plus Button with Vue Instance
el_button_group() update_el_button_group(): Element Plus Button Group
el_container(): Element Plus Container
el_header(): Element Plus Header
el_aside(): Element Plus Aside
el_main(): Element Plus Main
el_footer(): Element Plus Footer
el_icon(): Element Plus icon
el_row(): Element Plus Layout Row
el_col(): Element Plus Layout Column
el_link() update_el_link(): Element Plus Link
el_text() update_el_text(): Element Plus Text
el_scrollbar() update_el_scrollbar(): Element Plus Scrollbar
el_space() update_el_space(): Element Plus Space
el_splitter() update_el_splitter(): Element Plus Splitter
el_splitter_panel() update_el_splitter_panel(): Element Plus Splitter Panel

Form

Each reports to the server as input$<id>, on load as well as on change.

el_autocomplete() update_el_autocomplete(): Element Plus Autocomplete
el_cascader() update_el_cascader(): Element Plus Cascader
el_cascader_panel() update_el_cascader_panel(): Element Plus Cascader Panel
df_to_cascader_options(): Convert a data.frame with custom value/label columns to Element-UI Cascader options list
el_checkbox() update_el_checkbox(): Element Plus Checkbox
el_checkbox_group() update_el_checkbox_group(): Element Plus Checkbox Group
el_color_picker() update_el_color_picker(): Element Plus Color Picker
el_color_picker_panel() update_el_color_picker_panel(): Element Plus Color Picker Panel
el_date_picker() update_el_date_picker(): Element Plus Date Picker Component
el_date_picker_panel() update_el_date_picker_panel(): Element Plus Date Picker Panel
el_form() update_el_form(): Element Plus Form
el_form_field(): Declare a form field
el_form_item(): Several form fields under one label
el_rule(): Declare a validation rule
el_form_validate(): Validate an Element Plus Form from the server
el_form_reset(): Reset an Element Plus Form
el_form_clear_validate(): Clear an Element Plus Form's validation messages
el_input() update_el_input(): Element Plus Input with Vue Instance
el_input_number() update_el_input_number(): Element Plus Input Number
el_input_otp() update_el_input_otp(): Element Plus Input OTP
el_input_tag() update_el_input_tag(): Element Plus Input Tag
el_mention() update_el_mention(): Element Plus Mention
el_radio_group() update_el_radio_group(): Element Plus Radio Group Component
el_rate() update_el_rate(): Element Plus Rate (Star Rating)
el_select() update_el_select(): Element Plus Select Component
el_option() el_option_group(): A choice of a select, a radio group, a checkbox group
el_select_v2() update_el_select_v2(): Element Plus Virtualized Select
el_slider() update_el_slider(): Element Plus Slider Component
el_switch() update_el_switch(): Element Plus Switch
el_time_picker() el_time_select() update_el_time_picker() update_el_time_select(): Element Plus Time Picker
el_transfer() update_el_transfer(): Element Plus Transfer
el_tree_select() update_el_tree_select(): Element Plus Tree Select
el_upload() update_el_upload(): Element Plus Upload
el_upload_clear(): Clear an Element Plus Upload's file list

Data

el_avatar() update_el_avatar(): Element Plus Avatar
el_avatar_group() update_el_avatar_group(): Element Plus Avatar Group
el_badge() update_el_badge(): Element Plus Badge
el_calendar() update_el_calendar(): Element Plus Calendar
el_card(): Element Plus Card
el_carousel() update_el_carousel(): Element Plus Carousel
el_carousel_item(): A slide of el_carousel()
el_collapse() update_el_collapse(): Element Plus Collapse / Accordion
el_collapse_item(): A panel of el_collapse()
el_descriptions() update_el_descriptions(): Element Plus Descriptions
el_descriptions_item(): A field of el_descriptions()
el_empty() update_el_empty(): Element Plus Empty
el_image() update_el_image(): Element Plus Image
el_image_viewer() update_el_image_viewer(): Element Plus Image Viewer
el_infinite_scroll() update_el_infinite_scroll(): Element Plus Infinite Scroll
el_pagination() update_el_pagination(): Element Plus Pagination Component
el_progress() update_el_progress(): Element Plus Progress Component
el_result() update_el_result(): Element Plus Result
el_skeleton() update_el_skeleton(): Element Plus Skeleton
el_skeleton_item(): A placeholder shape of el_skeleton()'s template
el_table() update_el_table(): Element Plus Table Component
el_table_output() render_el_table(): An Element Plus table as a Shiny output
el_table_data(): The data a table shows
el_calendar_output() render_el_calendar(): A calendar as a Shiny output
el_calendar_events(): The events a calendar shows
el_table_column(): A column of el_table()
el_table_v2() update_el_table_v2(): Element Plus Virtualized Table
el_table_v2_column(): A column of el_table_v2()
el_tag() update_el_tag(): Element Plus Tag
el_check_tag() update_el_check_tag(): Element Plus Check Tag
el_timeline() update_el_timeline(): Element Plus Timeline
el_timeline_item(): An entry of el_timeline()
el_tour() update_el_tour(): Element Plus Tour
el_tour_step(): A step of el_tour()
el_tree() update_el_tree(): Element Plus Tree
df_to_tree_data(): Build tree data from a data frame
el_tree_v2() update_el_tree_v2(): Element Plus Virtualized Tree
el_statistic() el_countdown() update_el_statistic() update_el_countdown(): Element Plus Statistic
el_segmented() update_el_segmented(): Element Plus Segmented

el_affix() update_el_affix(): Element Plus Affix
el_anchor() update_el_anchor(): Element Plus Anchor
el_anchor_link(): A link of el_anchor()
el_backtop() update_el_backtop(): Element Plus Back to Top
el_breadcrumb() update_el_breadcrumb(): Element Plus Breadcrumb
el_breadcrumb_item(): A step of el_breadcrumb()
el_dropdown() update_el_dropdown(): Element Plus Dropdown Menu
el_dropdown_item(): An entry of el_dropdown()'s menu
el_menu() update_el_menu(): Element Plus Menu
el_menu_item() el_sub_menu() el_menu_item_group(): Items of el_menu(): an entry, a submenu, a group
el_page_header() update_el_page_header(): Element Plus Page Header
el_steps() update_el_steps(): Element Plus Steps Component
el_step(): A step of el_steps()
el_tabs() update_el_tabs(): Element Plus Tabs
el_tab_pane(): A tab of el_tabs()
insert_el_tab() remove_el_tab(): Add or remove a tab from the server

Feedback

Messages, notifications, message boxes and loading masks are called from the server.

el_alert() update_el_alert(): Element Plus Alert
el_dialog() update_el_dialog(): Element Plus Dialog
el_drawer() update_el_drawer(): Element Plus Drawer
el_loading(): Element Plus Loading Mask
el_loading_close(): Close a loading mask
el_message(): Show Element Plus Message
el_message_close() el_notification_close(): Close a message or a notification
el_message_box(): Element Plus Message Box
el_notification(): Show Element Plus Notification
el_popconfirm() update_el_popconfirm(): Element Plus Confirmation Bubble
el_popover() update_el_popover(): Element Plus Popover
el_tooltip() update_el_tooltip(): Element Plus Tooltip

Others

el_divider(): Element Plus Divider
el_watermark() update_el_watermark(): Element Plus Watermark

From the server

Element Plus’s methods, the objects they need, the events a component reports, and the data a component asks the server for.

call_el(): Call a method of an Element component
el_on(): Report a component's event to the server
el_table_row() el_upload_file() el_tree_node(): Name a table row, an uploaded file or a tree node for a method
el_load_children(): Answer a component that asked the server for data

Vue components of your own

The layer the Element components are built on, usable on its own: Vue’s options written in R, a component as a Shiny input, an output that keeps the user’s state across renders, shared state, and the server’s way in.

vue_app(): A Vue component, as Shiny UI
vue_component(): A Vue child component, for a template to use
vue_store(): State shared by Vue components: a store
vue_output() render_vue(): A Vue output that keeps the user's state across renders
render_vue_data() vue_data_output(): Data for a component, from the server
update_vue(): Set fields of a Vue component from the server
call_vue(): Call a method of a Vue component from the server
vue_answer(): Answer a Vue component that asked the server

Escape hatches

For anything the wrappers do not cover: build an Element component the way this package builds its own, or write raw Element Plus tags.

el_widget(): Assemble a component: host, Vue instance, Shiny input binding
JS(): Mark a string as JavaScript
el: Element Plus tags, for markup inside a component
template(): Generate a <template> tag for Vue/Element Plus slot usage