dbcTable: Table component

View source: R/dashBootstrapComponents.R

dbcTableR Documentation

Table component

Description

A component for applying Bootstrap styles to HTML tables. Use this as a drop-in replacement for 'html.Table', or generate a table from a Pandas DataFrame using 'dbc.Table.from_dataframe'.

Usage

dbcTable(children=NULL, id=NULL, style=NULL, class_name=NULL,
className=NULL, key=NULL, size=NULL, bordered=NULL,
borderless=NULL, striped=NULL, color=NULL, dark=NULL,
hover=NULL, responsive=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

size

Character. Specify table size, options: 'sm', 'md', 'lg'

bordered

Logical. Apply the 'table-bordered' class which adds borders on all sides of the table and cells.

borderless

Logical. Apply the 'table-borderless' class which removes all borders from the table and cells.

striped

Logical. Apply the ‘table-striped' class which applies ’zebra striping' to rows in the table body.

color

Character. Table color, options: primary, secondary, success, info, warning, danger, dark, light. Default: secondary.

dark

Logical. **DEPRECATED** - Use color="dark" instead.

Apply the 'table-dark' class for dark cell backgrounds and light text.

hover

Logical. Apply the 'table-hover' class which enables a hover state on table rows within the table body.

responsive

Logical | character. Set to True or one of the breakpoints 'sm', 'md', 'lg', 'xl' to make table scroll horizontally at lower breakpoints.

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


dash documentation built on June 23, 2022, 9:11 a.m.