1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
|
# 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 Tabs(Component):
"""A Tabs component.
A Dash component that lets you render pages with tabs - the Tabs component's children
can be dcc.Tab components, which can hold a label that will be displayed as a tab, and can in turn hold
children components that will be that tab's content.
Keyword arguments:
- children (list of a list of or a singular dash component, string or numbers | a list of or a singular dash component, string or number; optional):
Array that holds Tab components.
- 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):
Appends a class to the Tabs container holding the individual Tab
components.
- colors (dict; default { border: '#d6d6d6', primary: '#1975FA', background: '#f9f9f9',}):
Holds the colors used by the Tabs and Tab components. If you set
these, you should specify colors for all properties, so: colors: {
border: '#d6d6d6', primary: '#1975FA', background: '#f9f9f9'
}.
`colors` is a dict with keys:
- border (string; optional)
- primary (string; optional)
- background (string; optional)
- content_className (string; optional):
Appends a class to the Tab content container holding the children
of the Tab that is selected.
- content_style (dict; optional):
Appends (inline) styles to the tab content container holding the
children of the Tab that is selected.
- mobile_breakpoint (number; default 800):
Breakpoint at which tabs are rendered full width (can be 0 if you
don't want full width tabs on mobile).
- parent_className (string; optional):
Appends a class to the top-level parent container holding both the
Tabs container and the content container.
- parent_style (dict; optional):
Appends (inline) styles to the top-level parent container holding
both the Tabs container and the content container.
- persisted_props (list of a value equal to: 'value's; default ['value']):
Properties whose user interactions will persist after refreshing
the component or the page. Since only `value` is allowed this prop
can normally be ignored.
- persistence (boolean | string | number; optional):
Used to allow user interactions in this component to be persisted
when the component - or the page - is refreshed. If `persisted` is
truthy and hasn't changed from its previous value, a `value` that
the user has changed while using the app will keep that change, as
long as the new `value` also matches what was given originally.
Used in conjunction with `persistence_type`.
- persistence_type (a value equal to: 'local', 'session', 'memory'; default 'local'):
Where persisted user changes will be stored: memory: only kept in
memory, reset on page refresh. local: window.localStorage, data is
kept after the browser quit. session: window.sessionStorage, data
is cleared once the browser quit.
- value (string; optional):
The value of the currently selected Tab.
- vertical (boolean; default False):
Renders the tabs vertically (on the side)."""
_children_props = []
_base_nodes = ["children"]
_namespace = "dash_core_components"
_type = "Tabs"
Colors = TypedDict(
"Colors",
{
"border": NotRequired[str],
"primary": NotRequired[str],
"background": NotRequired[str],
},
)
def __init__(
self,
children: typing.Optional[ComponentType] = None,
id: typing.Optional[typing.Union[str, dict]] = None,
value: typing.Optional[str] = None,
className: typing.Optional[str] = None,
content_className: typing.Optional[str] = None,
parent_className: typing.Optional[str] = None,
style: typing.Optional[typing.Any] = None,
parent_style: typing.Optional[dict] = None,
content_style: typing.Optional[dict] = None,
vertical: typing.Optional[bool] = None,
mobile_breakpoint: typing.Optional[NumberType] = None,
colors: typing.Optional["Colors"] = None,
persistence: typing.Optional[typing.Union[bool, str, NumberType]] = None,
persisted_props: typing.Optional[typing.Sequence[Literal["value"]]] = None,
persistence_type: typing.Optional[Literal["local", "session", "memory"]] = None,
**kwargs
):
self._prop_names = [
"children",
"id",
"className",
"colors",
"content_className",
"content_style",
"mobile_breakpoint",
"parent_className",
"parent_style",
"persisted_props",
"persistence",
"persistence_type",
"style",
"value",
"vertical",
]
self._valid_wildcard_attributes = []
self.available_properties = [
"children",
"id",
"className",
"colors",
"content_className",
"content_style",
"mobile_breakpoint",
"parent_className",
"parent_style",
"persisted_props",
"persistence",
"persistence_type",
"style",
"value",
"vertical",
]
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"}
super(Tabs, self).__init__(children=children, **args)
setattr(Tabs, "__init__", _explicitize_args(Tabs.__init__))
|
