Learn R Programming

dash (version 0.9.4)

dbcTooltip: Tooltip component

Description

A component for adding tooltips to any element, no callbacks required! Simply add the Tooltip to you layout, and give it a target (id of a component to which the tooltip should be attached)

Usage

dbcTooltip(children=NULL, id=NULL, style=NULL, class_name=NULL,
className=NULL, key=NULL, target=NULL, placement=NULL,
flip=NULL, delay=NULL, loading_state=NULL)

Arguments

children

A list of or a singular dash component, string or number. The children of this component

id

Character. The ID of this component, used to identify dash components in callbacks. The ID needs to be unique across all of the components in an app.

style

Named list. Defines CSS styles which will override styles previously set.

class_name

Character. Often used with CSS to style elements with common properties.

className

Character. **DEPRECATED** Use `class_name` instead.

Often used with CSS to style elements with common properties.

key

Character. A unique identifier for the component, used to improve performance by React.js while rendering components See https://reactjs.org/docs/lists-and-keys.html for more info

target

Character | named list. The id of the element to attach the tooltip to

placement

A value equal to: 'auto', 'auto-start', 'auto-end', 'top', 'top-start', 'top-end', 'right', 'right-start', 'right-end', 'bottom', 'bottom-start', 'bottom-end', 'left', 'left-start', 'left-end'. How to place the tooltip.

flip

Logical. Whether to flip the direction of the popover if too close to the container edge, default True.

delay

Lists containing elements 'show', 'hide'. those elements have the following types: - show (numeric; optional) - hide (numeric; optional). Control the delay of hide and show events.

loading_state

Lists containing elements 'is_loading', 'prop_name', 'component_name'. those elements have the following types: - is_loading (logical; optional): determines if the component is loading or not - prop_name (character; optional): holds which property is loading - component_name (character; optional): holds the name of the component that is loading. Object that holds the loading state object coming from dash-renderer

Value

named list of JSON elements corresponding to React.js properties and their values