Dash.jl
Dash.jl copied to clipboard
Docstrings for online help render oddly when props that are lists with nested elements exist
The docstrings flow oddly in some Julia help pages -- this one, for dcc_link, renders is_loading, prop_name, and component_name as if they were top-level props themselves. Simultaneously, title and target appear to be missing.
help?> dcc_link
search: dcc_link dcc_loading dcc_location dcc_slider dcc_checklist dcc_rangeslider dcc_confirmdialogprovider
dcc_link(;kwargs...)
dcc_link(children::Any;kwargs...)
dcc_link(children_maker::Function;kwargs...)
A Link component. Link allows you to create a clickable link within a multi-page app.
For links with destinations outside the current app, html.A is a better component to use. Keyword arguments:
• children (a list of or a singular dash component, string or number; optional): The children of this component
• id (String; optional): 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.
• href (String; optional): The URL of a linked resource.
• refresh (Bool; optional): Controls whether or not the page will refresh when the link is clicked
• className (String; optional): Often used with CSS to style elements with common properties.
• style (Dict; optional): Defines CSS styles which will override styles previously set.
• loading_state (optional): Object that holds the loading state object coming from dash-renderer. loadingstate has the following type: lists containing elements 'isloading', 'propname', 'componentname'.
Those elements have the following types:
• is_loading (Bool; optional): Determines if the component is loading or not
• prop_name (String; optional): Holds which property is loading
• component_name (String; optional): Holds the name of the component that is loading