Skip to contents

Creates a scout action

scout_action.Rd

Creates an item that can perform actions on the server side.

Usage

scout_action(id, label, description, closeOnClick = TRUE, ...)

Arguments

id

Unique id.

label

Action label.

description

Action description.

closeOnClick

Whether to close the scoutbar whenever this action is clicked. Default to TRUE.

...

Other options. See https://www.scoutbar.co/docs/actions.

Value

A list containing:

  • children: a sublist where are passed the options.

  • class: a character vector to identify the action on the JavaScript side. You are not expected to modify it as it will break the JavaScript binding.

Details

This function is meant to be embeded directly within scoutbar or via a more structured way within scout_page or scout_section. It serves as a bridge between R and JavaScript to communicate with the Scoutbar React API, so you are not expected to call it on its own.