pagination: Bootstrap 4 pagination widget

In bs4Dash: A 'Bootstrap 4' Version of 'shinydashboard'

Bootstrap 4 pagination widget

Description

See https://getbootstrap.com/docs/4.0/components/pagination/.

Insert inside pagination.

Usage

pagination(
  ...,
  id = NULL,
  selected = NULL,
  align = c("center", "left", "right"),
  size = c("md", "sm", "lg"),
  previousBtn = "«",
  nextBtn = "»",
  .list = NULL
)

paginationItem(title, ..., value = title, icon = NULL, disabled = FALSE)

updatePagination(
  id,
  selected = NULL,
  disabled = NULL,
  session = shiny::getDefaultReactiveDomain()
)

Arguments

...	Slot for paginationItem.
id	Unique widget id. For programmatic update. See updatePagination.
selected	Which element to select at start.
align	Alignment.
size	Buttons size.
previousBtn	Previous button text.
nextBtn	Next button text.
.list	Programmatically generated paginationItem.
title	Display title for tab
value	The value that should be sent when tabsetPanel reports that this tab is selected. If omitted and tabsetPanel has an id, then the title will be used.
icon	Optional icon to appear on the tab. This attribute is only valid when using a tabPanel within a navbarPage().
disabled	Whether to disable the item. Default to FALSE.
session	Shiny session object.

Value

An HTML pagination container

An HTML tag.

Send a message from R to JS so as to update the pagination widget on the client.

Examples

if (interactive()) {
 library(shiny)
 library(bs4Dash)

 shinyApp(
   ui = dashboardPage(
    header = dashboardHeader(), 
    sidebar = dashboardSidebar(),
    body = dashboardBody(
     pagination(
       paginationItem("page1", box(title = "This is a box!")),
       paginationItem("page2", "This is page 2", disabled = TRUE),
       paginationItem("page3", "This is page 3", disabled = TRUE),
       paginationItem(
         "page4",
         sliderInput(
           "obs",
           "Number of observations:",
           min = 0,
           max = 1000,
           value = 500
         ),
         plotOutput("distPlot"),
         icon = icon("cog")
       )
     )
    )
   ),
   server = function(input, output, session) {
     output$distPlot <- renderPlot({
       hist(rnorm(input$obs))
     })
   }
 )
}
if (interactive()) {
 library(shiny)
 library(bs4Dash)

 shinyApp(
   ui = dashboardPage(
    header = dashboardHeader(), 
    sidebar = dashboardSidebar(),
    body = dashboardBody(
     fluidRow(
       actionButton("update", "Select page 4", class = "mx-2"),
       actionButton("disable", "Disable page 1", class = "mx-2"),
       actionButton("enable", "Enable page 1", class = "mx-2"),
       textOutput("selected_page")
     ),
     br(),
     pagination(
       id = "mypagination",
       paginationItem("page1", box(title = "This is a box!")),
       paginationItem("page2", "This is page 2", disabled = TRUE),
       paginationItem("page3", "This is page 3"),
       paginationItem(
         "page4",
         sliderInput(
           "obs",
           "Number of observations:",
           min = 0,
           max = 1000,
           value = 500
         ),
         plotOutput("distPlot"),
         icon = icon("cog")
       )
     )
    )
   ),
   server = function(input, output, session) {
    
     observeEvent(input$update,{
       updatePagination("mypagination", selected = "page4")
     })
    
     observeEvent(input$disable,{
       updatePagination("mypagination", disabled = "page1")
     })
    
     observeEvent(input$enable,{
       updatePagination("mypagination", selected = "page1")
     })
    
     output$selected_page <- renderText({
       sprintf("Currently selected page: %s", input$mypagination)
     })
    
     output$distPlot <- renderPlot({
       hist(rnorm(input$obs))
     })
   }
 )
}

bs4Dash documentation built on Sept. 11, 2024, 8:46 p.m.