aboutsummaryrefslogtreecommitdiff
path: root/venv/lib/python3.8/site-packages/dash/dcc/Link.py
diff options
context:
space:
mode:
Diffstat (limited to 'venv/lib/python3.8/site-packages/dash/dcc/Link.py')
-rw-r--r--venv/lib/python3.8/site-packages/dash/dcc/Link.py132
1 files changed, 132 insertions, 0 deletions
diff --git a/venv/lib/python3.8/site-packages/dash/dcc/Link.py b/venv/lib/python3.8/site-packages/dash/dcc/Link.py
new file mode 100644
index 0000000..4234b3e
--- /dev/null
+++ b/venv/lib/python3.8/site-packages/dash/dcc/Link.py
@@ -0,0 +1,132 @@
+# AUTO GENERATED FILE - DO NOT EDIT
+
+import typing # noqa: F401
+from typing_extensions import TypedDict, NotRequired, Literal # noqa: F401
+from dash.development.base_component import Component, _explicitize_args
+
+ComponentType = typing.Union[
+ str,
+ int,
+ float,
+ Component,
+ None,
+ typing.Sequence[typing.Union[str, int, float, Component, None]],
+]
+
+NumberType = typing.Union[
+ typing.SupportsFloat, typing.SupportsInt, typing.SupportsComplex
+]
+
+
+class Link(Component):
+ """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.
+
+ - href (string; required):
+ The URL of a linked resource.
+
+ - target (string; optional):
+ Specifies where to open the link reference.
+
+ - refresh (boolean; default False):
+ Controls whether or not the page will refresh when the link is
+ clicked.
+
+ - title (string; optional):
+ Adds the title attribute to your link, which can contain
+ supplementary information.
+
+ - className (string; optional):
+ Often used with CSS to style elements with common properties.
+
+ - 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.
+
+ - 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."""
+
+ _children_props = []
+ _base_nodes = ["children"]
+ _namespace = "dash_core_components"
+ _type = "Link"
+ LoadingState = TypedDict(
+ "LoadingState",
+ {
+ "is_loading": NotRequired[bool],
+ "prop_name": NotRequired[str],
+ "component_name": NotRequired[str],
+ },
+ )
+
+ def __init__(
+ self,
+ children: typing.Optional[ComponentType] = None,
+ href: typing.Optional[str] = None,
+ target: typing.Optional[str] = None,
+ refresh: typing.Optional[bool] = None,
+ title: typing.Optional[str] = None,
+ className: typing.Optional[str] = None,
+ style: typing.Optional[typing.Any] = None,
+ id: typing.Optional[typing.Union[str, dict]] = None,
+ loading_state: typing.Optional["LoadingState"] = None,
+ **kwargs
+ ):
+ self._prop_names = [
+ "children",
+ "href",
+ "target",
+ "refresh",
+ "title",
+ "className",
+ "style",
+ "id",
+ "loading_state",
+ ]
+ self._valid_wildcard_attributes = []
+ self.available_properties = [
+ "children",
+ "href",
+ "target",
+ "refresh",
+ "title",
+ "className",
+ "style",
+ "id",
+ "loading_state",
+ ]
+ self.available_wildcard_properties = []
+ _explicit_args = kwargs.pop("_explicit_args")
+ _locals = locals()
+ _locals.update(kwargs) # For wildcard attrs and excess named props
+ args = {k: _locals[k] for k in _explicit_args if k != "children"}
+
+ for k in ["href"]:
+ if k not in args:
+ raise TypeError("Required argument `" + k + "` was not specified.")
+
+ super(Link, self).__init__(children=children, **args)
+
+
+setattr(Link, "__init__", _explicitize_args(Link.__init__))