inshiny: Compact Inline Widgets for 'shiny' Apps

Description

Provides a basic set of compact widgets for 'shiny' apps which occupy less space and can appear inline with surrounding text.

Author(s)

Maintainer: Nick Davies nicholas.davies@lshtm.ac.uk

See Also

Useful links:

• https://github.com/nicholasdavies/inshiny

• https://nicholasdavies.github.io/inshiny/

• Report bugs at https://github.com/nicholasdavies/inshiny/issues

Container for inline widgets

Description

Wrapper for a line (or paragraph) containing a mix of explanatory text and inshiny inline widgets.

Usage

inline(..., class = "mb-1")

Arguments

Value

An HTML element to be included in your Shiny UI definition.

Examples

ui <- bslib::page_fixed(
    shiny::h1("Hello!"),
    inline("My name is ", inline_text("myname", "Sisyphus"), "."),
    inline("Please enter your name carefully.", style = "font-weight:bold")
)

Inline action button

Description

A button widget similar to shiny::actionButton() that can be included in an inline() wrapper.

Usage

inline_button(id, label, icon = NULL, meaning = label, accent = NULL)

Arguments

Value

An inline widget to be included in an inline() wrapper.

See Also

shiny::actionButton for how the button works with your Shiny server.

Examples

ui <- bslib::page_fixed(
    shiny::h1("A wonderful button"),
    inline("To update, please feel free to press the ",
        inline_button("mybutton",
            label = shiny::span(style = "font-style:italic", "button"),
            icon = shiny::icon("play"),
            meaning = "Update button", accent = "success"),
        "."
    )
)

Inline date input with calendar

Description

A date input with a calendar pop-up similar to shiny::dateInput() that can be included in an inline() wrapper.

Usage

inline_date(
  id,
  value = NULL,
  min = NULL,
  max = NULL,
  placeholder = "Enter date",
  meaning = NULL,
  format = "yyyy-mm-dd",
  startview = "month",
  weekstart = 0,
  language = "en",
  autoclose = TRUE,
  datesdisabled = NULL,
  daysofweekdisabled = NULL
)

Arguments

Value

An inline widget to be included in an inline() wrapper.

See Also

shiny::dateInput for how the date input works with your Shiny server.

Examples

ui <- bslib::page_fixed(
    shiny::h1("Select a date"),
    inline("Run simulation starting on ",
        inline_date("start_date", NULL, meaning = "Simulation start date",
            format = "dd/mm/yyyy", daysofweekdisabled = c(0, 6)),
        " (weekdays only)."
    )
)

Inline action link

Description

A link widget similar to shiny::actionLink() that can be included in an inline() wrapper.

Usage

inline_link(id, label, icon = NULL, meaning = label, accent = NULL)

Arguments

Value

An inline widget to be included in an inline() wrapper.

See Also

shiny::actionLink for how the link works with your Shiny server.

Examples

ui <- bslib::page_fixed(
    shiny::h1("Link examples"),
    inline("These are ", inline_link("link1", "some"), " ",
        inline_link("link2", "increasingly", accent = "danger"), " ",
        inline_link("link3", "fancy", accent = c("success", "underline-warning", "offset-2")), " ",
        inline_link("link4", "links", icon = shiny::icon("link"), accent = "info"), "!")
)

Inline number input

Description

A single line numeric input similar to shiny::numericInput() that can be included in an inline() wrapper.

Usage

inline_number(
  id,
  value,
  min = NULL,
  max = NULL,
  step = NULL,
  default = value,
  placeholder = "Enter number",
  meaning = NULL
)

Arguments

Value

An inline widget to be included in an inline() wrapper.

See Also

shiny::numericInput for how the number input works with your Shiny server.

Examples

ui <- bslib::page_fixed(
    shiny::h1("Breakfast app (beta)"),
    inline("Make me an omelette with ",
        inline_number("eggs", 6, min = 2, max = 12, step = 1,
            placeholder = "6 (default)", meaning = "Number of eggs"),
        " eggs.")
)

Inline select list input

Description

A select list input similar to shiny::selectInput() that can be included in an inline() wrapper.

Usage

inline_select(id, choices, selected = NULL, multiple = FALSE, meaning = NULL)

Arguments

Value

An inline widget to be included in an inline() wrapper.

See Also

shiny::selectInput for how the select input works with your Shiny server.

Examples

ui <- bslib::page_fixed(
    shiny::h1("Pet registration form"),
    inline("My ",
        inline_select("species", c("dog", "cat"), meaning = "Pet species"),
        "'s name is ",
        inline_select("name", list("Dog names" = c("Fido", "Rex"),
            "Cat names" = c("Felix", "Boots")), selected = "Rex"),
        ".")
)

Inline slider input

Description

A numeric input with a slider pop-up similar to shiny::sliderInput() that can be included in an inline() wrapper.

Usage

inline_slider(
  id,
  value,
  min,
  max,
  step = NULL,
  default = value,
  placeholder = "Enter number",
  meaning = NULL
)

Arguments

Value

An inline widget to be included in an inline() wrapper.

See Also

shiny::sliderInput for how the slider input works with your Shiny server.

Examples

ui <- bslib::page_fixed(
    shiny::h1("Pep talk"),
    inline("When you go out there tonight, give ",
        inline_slider("amount", 10, 0, 110, step = 1, default = 50,
            placeholder = "Enter a percentage.", meaning = "Percent to give"),
        "%.")
)

Inline on/off switch

Description

An on/off switch widget similar to bslib::input_switch() that can be included in an inline() wrapper.

Usage

inline_switch(id, value, on = "On", off = "Off", meaning = NULL)

Arguments

Value

An inline widget to be included in an inline() wrapper.

See Also

bslib::input_switch for how the switch works with your Shiny server.

Examples

ui <- bslib::page_fixed(
    shiny::h1("Switch test"),
    inline("The server is now ",
        inline_switch("myswitch", TRUE,
            on = shiny::span(class = "text-success", "powered ON"),
            off = shiny::span(class = "text-danger", "powered OFF"),
            meaning = "Server power switch"),
        "."
    )
)

Inline text input

Description

A single line text input similar to shiny::textInput() that can be included in an inline() wrapper.

Usage

inline_text(id, value = "", placeholder = "Enter text", meaning = NULL)

Arguments

Value

An inline widget to be included in an inline() wrapper.

See Also

shiny::textInput for how the text input works with your Shiny server.

Examples

ui <- bslib::page_fixed(
    shiny::h1("Hello!"),
    inline("My name is ", inline_text("myname", "Sisyphus",
        placeholder = "Enter your name", meaning = "Your name"), ".")
)

Update an inline widget

Description

Use this in your server code to change the parameters of an existing inline widget. Most, but not all, parameters from the corresponding ⁠inline_*⁠ functions can be changed. Note that while Shiny has a separate update function for each type of widget (e.g. shiny::updateTextInput for shiny::textInput, etc.), the inshiny package has this single function to update all types of inline widgets. This function can only be called in a reactive context, and can only be called on ⁠inline_*⁠ widgets, not on "built-in" Shiny widgets.

Usage

update_inline(
  id,
  session = shiny::getDefaultReactiveDomain(),
  value,
  placeholder,
  meaning,
  label,
  icon,
  accent,
  min,
  max,
  step,
  default,
  on,
  off,
  datesdisabled,
  daysofweekdisabled,
  choices,
  selected
)

Arguments

Details

See the documentation for each inline widget for details of how each parameter is interpreted.

When adjusting min, max, datesdisabled, or daysofweekdisabled, it is recommended that you also send an update to value with the current value of input[[id]] or any new value as applicable. This will ensure that any invalid value gets highlighted in the app as invalid after accounting for the new bounds and disallowed values.

Value

Nothing.

Examples

# Example UI setup
ui <- bslib::page_fixed(
    inline(
        inline_button("mybutton", "Button"),
        inline_date("mydate"),
        inline_link("mylink", "Link"),
        inline_number("mynumber", 42),
        inline_select("myselect", letters),
        inline_slider("myslider", 42, 0, 100),
        inline_switch("myswitch", TRUE),
        inline_text("mytext")
    )
)

# This covers all updatable attributes except `meaning` (all widgets) and
# `placeholder` (date, number, slider, text).
server <- function(input, output) {
    update_inline("mybutton", label = "Click me", icon = shiny::icon("recycle"),
        accent = "info")
    update_inline("mydate", value = "2026-01-01", min = "2025-01-01",
        max = "2026-12-31", datesdisabled = "2025-12-25",
        daysofweekdisabled = c(0, 6))
    update_inline("mylink", label = "Click me", icon = shiny::icon("recycle"),
        accent = "info")
    update_inline("mynumber", value = 25, min = 20, max = 50, step = 5,
        default = 25)
    update_inline("myselect", choices = letters[1:5], selected = "c")
    update_inline("myslider", value = 25, min = 20, max = 50, step = 5,
        default = 25)
    update_inline("myswitch", value = TRUE, on = "Present", off = "Absent")
    update_inline("mytext", value = "Howdy")
}

Manually include inshiny scripts and stylesheet

Description

For inshiny to work, you need to link your Shiny app to inshiny's JavaScript code and CSS stylesheets. If you use inshiny's function inline() anywhere in your Shiny UI definition, which you probably do, this happens automatically. Otherwise, you can add a call to use_inshiny() to your UI.

Usage

use_inshiny()

Value

An htmltools::htmlDependency() object to include in your UI.

Examples

ui <- bslib::page(
    use_inshiny(),
    shiny::h1("My slider app"),
    inline_slider("slider", 50, 0, 100)
)