scoutbar: Creates a Scoutbar React widget

In scoutbaR: A Spotlight 'React' Widget for 'shiny' Apps

Creates a Scoutbar React widget

Description

Scoutbar react widget for Shiny.

Use this function from the server side of your Shiny app to update a scoutbar.

Usage

scoutbar(
  inputId,
  theme = c("light", "dark", "auto"),
  placeholder = list("Hello", "Type some text"),
  actions = list(),
  ...
)

update_scoutbar(session = shiny::getDefaultReactiveDomain(), inputId, ...)

Arguments

inputId	Widget input id. You can check the scoutbar configuration with input[["<inputId>-configuration"]]. You can query the scoutbar open state with input[["<inputId>-open"]].
theme	Scoutbar theme.
placeholder	Scoutbar placeholder text. A string or a list of strings.
actions	Scoutbar actions. Expect scout_action or scout_section and scout_page. scout_action can be nested inside scout_section and scout_page.
...	Scoutbar configuration. Expect a list of properties like in scoutbar. See possible values here at https://www.scoutbar.co/docs/features.
session	Shiny session object.

Details

Provides a contextual menu users can activate with keyboard shortcut or programmatically with update_scoutbar. Scoutbar may be seen as an alternative to sidebars and navbars, as it allows to construct better navigation menus.

Value

A list of shiny tags containing all the web dependencies and scoutbar elements required to instantiate the Scoutbar React widget from JavaScript.

This function is called for its side effect. It sends a message to JavaScript through the current websocket connection, leveraging the shiny session object.

scoutbaR documentation built on April 3, 2025, 8:54 p.m.