etiennebacher / prompter

Add tooltips in Shiny apps with hint.css
https://prompter.etiennebacher.com/
Other
41 stars 1 forks source link

prompter

[![Codecov.io test coverage](https://app.codecov.io/gh/etiennebacher/prompter/branch/master/graphs/badge.svg)](https://app.codecov.io/github/etiennebacher/prompter) [![R build status](https://github.com/etiennebacher/prompter/workflows/R-CMD-check/badge.svg)](https://github.com/etiennebacher/prompter/actions) [![CRAN status](https://www.r-pkg.org/badges/version/prompter)](https://CRAN.R-project.org/package=prompter) [![Website](https://img.shields.io/badge/Website-Visit-blue)](https://prompter.etiennebacher.com/#/)

The goal of {prompter} is to easily create tooltips on many HTML elements in Shiny apps. This is the adaptation of hint.css in R.

Installation

You can install the CRAN version:

install.packages("prompter")

Or install the development version:

# install.packages("devtools")
devtools::install_github("etiennebacher/prompter")

Demo

library(prompter)
library(shiny)
library(ggplot2)
library(magrittr)

ui <- fluidPage(

  # Load the dependencies
  use_prompt(),

  column(
    3, 
    # Put the element inside add_prompt()...
    add_prompt(
      actionButton("plot", "click"), 
      position = "bottom", message = "this is a button"
    )
  ),
  column(
    9,
    # ... or use magrittr's pipe
    plotOutput("plot") %>% 
       add_prompt(
         message = "this is a plot, and I add some text to show the size of the box.",
         position = "left", type = "error", 
         size = "medium", rounded = TRUE
       )
  )
)

server <- function(input, output, session) {

  output$plot <- renderPlot(ggplot(mtcars, aes(wt, mpg))+ geom_point())

}

shinyApp(ui, server)

Here's the output of this code:

Code of Conduct

Please note that the prompter project is released with a Contributor Code of Conduct. By contributing to this project, you agree to abide by its terms.

Acknowledgements

Kushagra Gour for the original hint.css library.