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
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
|
# 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 Form(Component):
"""A Form component.
Form is a wrapper for the <form> HTML5 element.
For detailed attribute info see:
https://developer.mozilla.org/en-US/docs/Web/HTML/Element/form
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.
- accept (string; optional):
List of types the server accepts, typically a file type.
- acceptCharset (string; optional):
The character set, which if provided must be \"UTF-8\".
- accessKey (string; optional):
Keyboard shortcut to activate or add focus to the element.
- action (string; optional):
The URI of a program that processes the information submitted via
the form.
- aria-* (string; optional):
A wildcard aria attribute.
- autoComplete (string; optional):
Indicates whether controls in this form can by default have their
values automatically completed by the browser.
- className (string; optional):
Often used with CSS to style elements with common properties.
- contentEditable (string; optional):
Indicates whether the element's content is editable.
- data-* (string; optional):
A wildcard data attribute.
- dir (string; optional):
Defines the text direction. Allowed values are ltr (Left-To-Right)
or rtl (Right-To-Left).
- disable_n_clicks (boolean; optional):
When True, this will disable the n_clicks prop. Use this to
remove event listeners that may interfere with screen readers.
- draggable (string; optional):
Defines whether the element can be dragged.
- encType (string; optional):
Defines the content type of the form data when the method is POST.
- hidden (a value equal to: 'hidden', 'HIDDEN' | boolean; optional):
Prevents rendering of given element, while keeping child elements,
e.g. script elements, active.
- key (string; optional):
A unique identifier for the component, used to improve performance
by React.js while rendering components See
https://reactjs.org/docs/lists-and-keys.html for more info.
- lang (string; optional):
Defines the language used in the element.
- method (string; optional):
Defines which HTTP method to use when submitting the form. Can be
GET (default) or POST.
- n_clicks (number; default 0):
An integer that represents the number of times that this element
has been clicked on.
- n_clicks_timestamp (number; default -1):
An integer that represents the time (in ms since 1970) at which
n_clicks changed. This can be used to tell which button was
changed most recently.
- name (string; optional):
Name of the element. For example used by the server to identify
the fields in form submits.
- noValidate (a value equal to: 'noValidate', 'novalidate', 'NOVALIDATE' | boolean; optional):
This attribute indicates that the form shouldn't be validated when
submitted.
- role (string; optional):
Defines an explicit role for an element for use by assistive
technologies.
- spellCheck (string; optional):
Indicates whether spell checking is allowed for the element.
- tabIndex (string | number; optional):
Overrides the browser's default tab order and follows the one
specified instead.
- target (string; optional):
Specifies where to open the linked document (in the case of an <a>
element) or where to display the response received (in the case of
a <form> element).
- title (string; optional):
Text to be displayed in a tooltip when hovering over the element."""
_children_props = []
_base_nodes = ["children"]
_namespace = "dash_html_components"
_type = "Form"
def __init__(
self,
children: typing.Optional[ComponentType] = None,
id: typing.Optional[typing.Union[str, dict]] = None,
n_clicks: typing.Optional[NumberType] = None,
n_clicks_timestamp: typing.Optional[NumberType] = None,
disable_n_clicks: typing.Optional[bool] = None,
key: typing.Optional[str] = None,
accept: typing.Optional[str] = None,
acceptCharset: typing.Optional[str] = None,
action: typing.Optional[str] = None,
autoComplete: typing.Optional[str] = None,
encType: typing.Optional[str] = None,
method: typing.Optional[str] = None,
name: typing.Optional[str] = None,
noValidate: typing.Optional[
typing.Union[Literal["noValidate", "novalidate", "NOVALIDATE"], bool]
] = None,
target: typing.Optional[str] = None,
accessKey: typing.Optional[str] = None,
className: typing.Optional[str] = None,
contentEditable: typing.Optional[str] = None,
dir: typing.Optional[str] = None,
draggable: typing.Optional[str] = None,
hidden: typing.Optional[typing.Union[Literal["hidden", "HIDDEN"], bool]] = None,
lang: typing.Optional[str] = None,
role: typing.Optional[str] = None,
spellCheck: typing.Optional[str] = None,
style: typing.Optional[typing.Any] = None,
tabIndex: typing.Optional[typing.Union[str, NumberType]] = None,
title: typing.Optional[str] = None,
**kwargs
):
self._prop_names = [
"children",
"id",
"accept",
"acceptCharset",
"accessKey",
"action",
"aria-*",
"autoComplete",
"className",
"contentEditable",
"data-*",
"dir",
"disable_n_clicks",
"draggable",
"encType",
"hidden",
"key",
"lang",
"method",
"n_clicks",
"n_clicks_timestamp",
"name",
"noValidate",
"role",
"spellCheck",
"style",
"tabIndex",
"target",
"title",
]
self._valid_wildcard_attributes = ["data-", "aria-"]
self.available_properties = [
"children",
"id",
"accept",
"acceptCharset",
"accessKey",
"action",
"aria-*",
"autoComplete",
"className",
"contentEditable",
"data-*",
"dir",
"disable_n_clicks",
"draggable",
"encType",
"hidden",
"key",
"lang",
"method",
"n_clicks",
"n_clicks_timestamp",
"name",
"noValidate",
"role",
"spellCheck",
"style",
"tabIndex",
"target",
"title",
]
self.available_wildcard_properties = ["data-", "aria-"]
_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(Form, self).__init__(children=children, **args)
setattr(Form, "__init__", _explicitize_args(Form.__init__))
|
