Loading Module

A Loading component that wraps any other component and displays a spinner until the wrapped component has rendered.

Types

Type Description

Attr

A list of children or a property for this dash component

Loading

A Loading component that wraps any other component and displays a spinner until the wrapped component has rendered.

LoadingType

value equal to: 'graph', 'cube', 'circle', 'dot', 'default'

Prop

• children (list with values of type: a list of or a singular dash component, string or number | a list of or a singular dash component, string or number) - Array that holds components to render • type (value equal to: 'graph', 'cube', 'circle', 'dot', 'default'; default default) - Property that determines which spinner to show one of 'graph', 'cube', 'circle', 'dot', or 'default'. • fullscreen (boolean) - Boolean that makes the spinner display full-screen • debug (boolean) - If true, the spinner will display the component_name and prop_name while loading • className (string) - Additional CSS class for the spinner root DOM node • parent_className (string) - Additional CSS class for the outermost dcc.Loading parent div DOM node • style (record) - Additional CSS styling for the spinner root DOM node • parent_style (record) - Additional CSS styling for the outermost dcc.Loading parent div DOM node • color (string; default #119DFF) - Primary colour used for the loading spinners • loading_state (record with the fields: 'is_loading: boolean (optional)', 'prop_name: string (optional)', 'component_name: string (optional)') - Object that holds the loading state object coming from dash-renderer

Functions and values

Function or value Description

Loading.loading id attrs

Full Usage: Loading.loading id attrs

Parameters:
    id : string
    attrs : Attr list

Returns: DashComponent

A Loading component that wraps any other component and displays a spinner until the wrapped component has rendered. Properties: • id (string) - 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. • children (list with values of type: a list of or a singular dash component, string or number | a list of or a singular dash component, string or number) - Array that holds components to render • type (value equal to: 'graph', 'cube', 'circle', 'dot', 'default'; default default) - Property that determines which spinner to show one of 'graph', 'cube', 'circle', 'dot', or 'default'. • fullscreen (boolean) - Boolean that makes the spinner display full-screen • debug (boolean) - If true, the spinner will display the component_name and prop_name while loading • className (string) - Additional CSS class for the spinner root DOM node • parent_className (string) - Additional CSS class for the outermost dcc.Loading parent div DOM node • style (record) - Additional CSS styling for the spinner root DOM node • parent_style (record) - Additional CSS styling for the outermost dcc.Loading parent div DOM node • color (string; default #119DFF) - Primary colour used for the loading spinners • loading_state (record with the fields: 'is_loading: boolean (optional)', 'prop_name: string (optional)', 'component_name: string (optional)') - Object that holds the loading state object coming from dash-renderer

id : string
attrs : Attr list
Returns: DashComponent