dash_mp_components.Link

class dash_mp_components.Link(children: str | int | float | Component | None | Sequence[str | int | float | Component | None] = None, href: str | None = None, target: str | None = None, refresh: bool | None = None, title: str | None = None, className: str | None = None, style: Any | None = None, id: str | dict | None = None, loading_state: LoadingState | None = None, preserveQuery: bool | None = None, **kwargs)

Bases: Component

A Link component. Custom Link component that can handle both internal and external URLs. You can also use this component if you need to preserve the url query parameters when following a link.

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.

• className (string; optional):

  Often used with CSS to style elements with common properties.

• href (string; required):

  The URL of a linked resource.

• loading_state (dict; optional):

  Object that holds the loading state object coming from dash-renderer.

  loading_state is a dict with keys:

  • is_loading (boolean; 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.

• preserveQuery (boolean; optional):

  If True, the current query parameters will not be removed from the url when following the link.

• refresh (boolean; optional):

  Controls whether or not the page will refresh when the link is clicked.

• target (string; optional):

  Specifies where to open the link reference.

• title (string; optional):

  Adds the title attribute to your link, which can contain supplementary information.

__init__(children: str | int | float | Component | None | Sequence[str | int | float | Component | None] = None, href: str | None = None, target: str | None = None, refresh: bool | None = None, title: str | None = None, className: str | None = None, style: Any | None = None, id: str | dict | None = None, loading_state: LoadingState | None = None, preserveQuery: bool | None = None, **kwargs)

Methods

__init__([children, href, target, refresh, ...])
to_plotly_json()

Attributes

REQUIRED
UNDEFINED
available_wildcard_properties

class LoadingState

Bases: TypedDict