Shiny's internal %AND% function

Description

Reproduced since it is not exported in the Shiny namespace.

Usage

x %AND% y

Underscore Join Operator

Description

Inspired by Shiny's %.% operator which joins two arguments with a period (.), instead this uses an underscore (_) which is more suitable for HTML id attributes.

Usage

x %_% y

Names-Not-In Operator

Description

Shorthand to determine object names in x but not in y

Usage

x %nni% y

Configuration Options List for mark.js API

Description

All API options for mark.j v8.11.1, excluding the callback functions: each, filter, noMatch, and done.

Usage

configurator

Format

List with 15 named elements.

element

Element tag to wrap matches, default is "mark".

className

Class named appended to the match element, default is "".

exclude

Vector of element selectors to exclude from match, default is c().

accuracy

Match algorithm ("partially", "complementary", or "exactly"), default is "partially". (see mark.js API for more details).

synonyms

List of key-value pairs to consider equivalent, default is list().

ignorePunctuation

Vector of punctuation marks to ignore, default is c().

wildcards

Matching using wildcards such as "?" and "*" ("disabled", "enabled", or "withSpaces"), default is "disabled" (see mark.js API for more details).

iframes

Search within iframe elements, default is FALSE.

iframesTimeout

Maximum time (in ms) to wait for load before skipping an iframe element, default is 5000.

seperateWordSearch

Search for each space-seperated word instead of the complete input, default is TRUE.

diacritics

Match using diacritic characters, default is TRUE.

acrossElements

Search for matches across elements, default is FALSE.

caseSensitive

Case sensitive matching, default is FALSE.

ignoreJoiners

Skip soft hyphen, zero width space, zero width non-joiner and zero width joiner, default is FALSE.

debug

Print debug information to the brower's console, default is FALSE.

Details

See the mark.js API for a detailed description of each option. Also see the mark.js Configurator for these options in action.

Non-blocking match.arg with better error reporting.

Description

Performs similar traceback as match.arg for default argument values. Unlike match.arg, this function does not stop execution. It simply emits a detailed warning including the invalid argument value, the calling funcation, and the expected argument values.

Usage

default(arg, choices, message = NULL)

Shiny Searchbar Demos

Description

Run one of the the shinySearchbar demos: "gallery" and "overflow".

Usage

demo(name = "gallery", ...)

Arguments

Examples

if (interactive()) {
  shinySearchbar:::demo("gallery")
}

Create the searchbar widget.

Description

Create a textInput-like searchbar which can search through and highlight the user's input within another element.

Usage

searchbar(
  inputId,
  contextId,
  value = NULL,
  label = NULL,
  width = NULL,
  placeholder = NULL,
  counter = TRUE,
  cycler = TRUE,
  scrollBehavior = c("smooth", "auto"),
  markOpts = configurator,
  quiet = FALSE
)

Arguments

Details

The counter and cycler arguments add additional functionality to the searchbar. The counter shows the user how many matches were found and the cycler gives the user an interface to cycle through each match with automatic scrolling (using either the buttons or Enter and Shift+Enter).

The markOpts are a list of options to pass to the underlying mark.js API, which handles finding and highlighting the matches in element identified by contextId.

Value

A seachbar input control that can be added to a UI definition.

See Also

updateMarkOptions, configurator

Examples

if (interactive()) {
  ui <- fluidPage(
    searchbar("sb", "text"),
    textOutput("text")
  )
  server <- function(input, output) {
    output$text <- renderText("Hello world!")
  }
  shinyApp(ui, server)
}

Shiny's internal shinyInputLabel function

Description

Reproduced since it is not exported in the Shiny namespace.

Usage

shinyInputLabel(inputId, label = NULL)

Update mark.js Options for an Initialized Searchbar Widget

Description

Only the options explicitly passed with this function are updated, the previous options are left unchanged.

Usage

updateMarkOptions(
  inputId,
  markOpts,
  session = shiny::getDefaultReactiveDomain(),
  quiet = FALSE
)

Arguments

Value

No return value, called to update markOpts of the input control.

See Also

configurator

Validate the Options Passed to mark.js API

Description

Validate the Options Passed to mark.js API

Usage

validateMarkOpts(opts)