|
| 1 | +# AUTO GENERATED FILE - DO NOT EDIT |
| 2 | + |
| 3 | +import typing # noqa: F401 |
| 4 | +from typing_extensions import TypedDict, NotRequired, Literal # noqa: F401 |
| 5 | +from dash.development.base_component import Component, _explicitize_args |
| 6 | + |
| 7 | +ComponentSingleType = typing.Union[str, int, float, Component, None] |
| 8 | +ComponentType = typing.Union[ |
| 9 | + ComponentSingleType, |
| 10 | + typing.Sequence[ComponentSingleType], |
| 11 | +] |
| 12 | + |
| 13 | +NumberType = typing.Union[ |
| 14 | + typing.SupportsFloat, typing.SupportsInt, typing.SupportsComplex |
| 15 | +] |
| 16 | + |
| 17 | + |
| 18 | +class Button(Component): |
| 19 | + """A Button component. |
| 20 | + Similar to dash.html.Button, but with theming and styles applied. |
| 21 | +
|
| 22 | + Keyword arguments: |
| 23 | +
|
| 24 | + - children (a list of or a singular dash component, string or number; optional): |
| 25 | + The children of this component. |
| 26 | +
|
| 27 | + - id (string; optional): |
| 28 | + The ID of this component, used to identify dash components in |
| 29 | + callbacks. The ID needs to be unique across all of the components |
| 30 | + in an app. |
| 31 | +
|
| 32 | + - accessKey (string; optional): |
| 33 | + Keyboard shortcut to activate or add focus to the element. |
| 34 | +
|
| 35 | + - autoFocus (boolean; optional): |
| 36 | + The element should be automatically focused after the page loaded. |
| 37 | +
|
| 38 | + - className (string; optional): |
| 39 | + Additional CSS class for the root DOM node. |
| 40 | +
|
| 41 | + - componentPath (boolean | number | string | dict | list; optional) |
| 42 | +
|
| 43 | + - contentEditable (boolean; optional): |
| 44 | + Indicates whether the element's content is editable. |
| 45 | +
|
| 46 | + - dir (string; optional): |
| 47 | + Defines the text direction. Allowed values are ltr (Left-To-Right) |
| 48 | + or rtl (Right-To-Left). |
| 49 | +
|
| 50 | + - disabled (boolean; optional): |
| 51 | + Indicates whether the user can interact with the element. |
| 52 | +
|
| 53 | + - draggable (boolean; optional): |
| 54 | + Defines whether the element can be dragged. |
| 55 | +
|
| 56 | + - form (string; optional): |
| 57 | + Indicates the form that is the owner of the element. |
| 58 | +
|
| 59 | + - formAction (string; optional): |
| 60 | + Indicates the action of the element, overriding the action defined |
| 61 | + in the <form>. |
| 62 | +
|
| 63 | + - formEncType (string; optional): |
| 64 | + If the button/input is a submit button (type=\"submit\"), this |
| 65 | + attribute sets the encoding type to use during form submission. If |
| 66 | + this attribute is specified, it overrides the enctype attribute of |
| 67 | + the button's form owner. |
| 68 | +
|
| 69 | + - formMethod (string; optional): |
| 70 | + If the button/input is a submit button (type=\"submit\"), this |
| 71 | + attribute sets the submission method to use during form submission |
| 72 | + (GET, POST, etc.). If this attribute is specified, it overrides |
| 73 | + the method attribute of the button's form owner. |
| 74 | +
|
| 75 | + - formNoValidate (boolean; optional): |
| 76 | + If the button/input is a submit button (type=\"submit\"), this |
| 77 | + boolean attribute specifies that the form is not to be validated |
| 78 | + when it is submitted. If this attribute is specified, it overrides |
| 79 | + the novalidate attribute of the button's form owner. |
| 80 | +
|
| 81 | + - formTarget (string; optional): |
| 82 | + If the button/input is a submit button (type=\"submit\"), this |
| 83 | + attribute specifies the browsing context (for example, tab, |
| 84 | + window, or inline frame) in which to display the response that is |
| 85 | + received after submitting the form. If this attribute is |
| 86 | + specified, it overrides the target attribute of the button's form |
| 87 | + owner. |
| 88 | +
|
| 89 | + - hidden (boolean; optional): |
| 90 | + Prevents rendering of given element, while keeping child elements, |
| 91 | + e.g. script elements, active. |
| 92 | +
|
| 93 | + - lang (string; optional): |
| 94 | + Defines the language used in the element. |
| 95 | +
|
| 96 | + - n_blur (number; default 0): |
| 97 | + Number of times the button lost focus. |
| 98 | +
|
| 99 | + - n_blur_timestamp (number; default -1): |
| 100 | + Last time the button lost focus. |
| 101 | +
|
| 102 | + - n_clicks (number; default 0): |
| 103 | + Number of times the button has been clicked. |
| 104 | +
|
| 105 | + - n_clicks_timestamp (number; default -1): |
| 106 | + Last time the button was clicked. |
| 107 | +
|
| 108 | + - name (string; optional): |
| 109 | + Name of the element. For example used by the server to identify |
| 110 | + the fields in form submits. |
| 111 | +
|
| 112 | + - persisted_props (boolean | number | string | dict | list; optional): |
| 113 | + Properties whose user interactions will persist after refreshing |
| 114 | + the component or the page. Since only `value` is allowed this prop |
| 115 | + can normally be ignored. |
| 116 | +
|
| 117 | + - persistence (string | number | boolean; optional): |
| 118 | + Used to allow user interactions in this component to be persisted |
| 119 | + when the component - or the page - is refreshed. If `persisted` is |
| 120 | + truthy and hasn't changed from its previous value, a `value` that |
| 121 | + the user has changed while using the app will keep that change, as |
| 122 | + long as the new `value` also matches what was given originally. |
| 123 | + Used in conjunction with `persistence_type`. |
| 124 | +
|
| 125 | + - persistence_type (a value equal to: None, 'local', 'session', 'memory'; optional): |
| 126 | + Where persisted user changes will be stored: memory: only kept in |
| 127 | + memory, reset on page refresh. local: window.localStorage, data is |
| 128 | + kept after the browser quit. session: window.sessionStorage, data |
| 129 | + is cleared once the browser quit. |
| 130 | +
|
| 131 | + - role (string; optional): |
| 132 | + Defines the role of an element in the context of accessibility. |
| 133 | +
|
| 134 | + - spellCheck (boolean; optional): |
| 135 | + Indicates whether spell checking is allowed for the element. |
| 136 | +
|
| 137 | + - tabIndex (number; optional): |
| 138 | + Overrides the browser's default tab order and follows the one |
| 139 | + specified instead. |
| 140 | +
|
| 141 | + - title (string; optional): |
| 142 | + Text to be displayed in a tooltip when hovering over the element. |
| 143 | +
|
| 144 | + - type (a value equal to: None, 'submit', 'reset', 'button'; default 'button'): |
| 145 | + Defines the type of the element. |
| 146 | +
|
| 147 | + - value (string | number | list of strings; optional): |
| 148 | + Defines a default value which will be displayed in the element on |
| 149 | + page load.""" |
| 150 | + |
| 151 | + _children_props: typing.List[str] = [] |
| 152 | + _base_nodes = ["children"] |
| 153 | + _namespace = "dash_core_components" |
| 154 | + _type = "Button" |
| 155 | + |
| 156 | + def __init__( |
| 157 | + self, |
| 158 | + children: typing.Optional[ComponentType] = None, |
| 159 | + className: typing.Optional[typing.Union[str]] = None, |
| 160 | + persistence: typing.Optional[typing.Union[str, NumberType, bool]] = None, |
| 161 | + persisted_props: typing.Optional[typing.Any] = None, |
| 162 | + persistence_type: typing.Optional[ |
| 163 | + Literal[None, "local", "session", "memory"] |
| 164 | + ] = None, |
| 165 | + id: typing.Optional[typing.Union[str, dict]] = None, |
| 166 | + componentPath: typing.Optional[typing.Any] = None, |
| 167 | + type: typing.Optional[Literal[None, "submit", "reset", "button"]] = None, |
| 168 | + autoFocus: typing.Optional[typing.Union[bool]] = None, |
| 169 | + disabled: typing.Optional[typing.Union[bool]] = None, |
| 170 | + form: typing.Optional[typing.Union[str]] = None, |
| 171 | + formAction: typing.Optional[typing.Union[str]] = None, |
| 172 | + formEncType: typing.Optional[typing.Union[str]] = None, |
| 173 | + formMethod: typing.Optional[typing.Union[str]] = None, |
| 174 | + formNoValidate: typing.Optional[typing.Union[bool]] = None, |
| 175 | + formTarget: typing.Optional[typing.Union[str]] = None, |
| 176 | + name: typing.Optional[typing.Union[str]] = None, |
| 177 | + value: typing.Optional[ |
| 178 | + typing.Union[str, NumberType, typing.Sequence[str]] |
| 179 | + ] = None, |
| 180 | + accessKey: typing.Optional[typing.Union[str]] = None, |
| 181 | + contentEditable: typing.Optional[ |
| 182 | + typing.Union[bool, Literal["true"], Literal["false"], Literal["inherit"]] |
| 183 | + ] = None, |
| 184 | + dir: typing.Optional[typing.Union[str]] = None, |
| 185 | + draggable: typing.Optional[typing.Union[bool]] = None, |
| 186 | + hidden: typing.Optional[typing.Union[bool]] = None, |
| 187 | + lang: typing.Optional[typing.Union[str]] = None, |
| 188 | + role: typing.Optional[typing.Union[str]] = None, |
| 189 | + spellCheck: typing.Optional[typing.Union[bool]] = None, |
| 190 | + style: typing.Optional[typing.Any] = None, |
| 191 | + tabIndex: typing.Optional[typing.Union[NumberType]] = None, |
| 192 | + title: typing.Optional[typing.Union[str]] = None, |
| 193 | + n_blur: typing.Optional[typing.Union[NumberType]] = None, |
| 194 | + n_blur_timestamp: typing.Optional[typing.Union[NumberType]] = None, |
| 195 | + n_clicks: typing.Optional[typing.Union[NumberType]] = None, |
| 196 | + n_clicks_timestamp: typing.Optional[typing.Union[NumberType]] = None, |
| 197 | + **kwargs |
| 198 | + ): |
| 199 | + self._prop_names = [ |
| 200 | + "children", |
| 201 | + "id", |
| 202 | + "accessKey", |
| 203 | + "autoFocus", |
| 204 | + "className", |
| 205 | + "componentPath", |
| 206 | + "contentEditable", |
| 207 | + "dir", |
| 208 | + "disabled", |
| 209 | + "draggable", |
| 210 | + "form", |
| 211 | + "formAction", |
| 212 | + "formEncType", |
| 213 | + "formMethod", |
| 214 | + "formNoValidate", |
| 215 | + "formTarget", |
| 216 | + "hidden", |
| 217 | + "lang", |
| 218 | + "n_blur", |
| 219 | + "n_blur_timestamp", |
| 220 | + "n_clicks", |
| 221 | + "n_clicks_timestamp", |
| 222 | + "name", |
| 223 | + "persisted_props", |
| 224 | + "persistence", |
| 225 | + "persistence_type", |
| 226 | + "role", |
| 227 | + "spellCheck", |
| 228 | + "style", |
| 229 | + "tabIndex", |
| 230 | + "title", |
| 231 | + "type", |
| 232 | + "value", |
| 233 | + ] |
| 234 | + self._valid_wildcard_attributes = [] |
| 235 | + self.available_properties = [ |
| 236 | + "children", |
| 237 | + "id", |
| 238 | + "accessKey", |
| 239 | + "autoFocus", |
| 240 | + "className", |
| 241 | + "componentPath", |
| 242 | + "contentEditable", |
| 243 | + "dir", |
| 244 | + "disabled", |
| 245 | + "draggable", |
| 246 | + "form", |
| 247 | + "formAction", |
| 248 | + "formEncType", |
| 249 | + "formMethod", |
| 250 | + "formNoValidate", |
| 251 | + "formTarget", |
| 252 | + "hidden", |
| 253 | + "lang", |
| 254 | + "n_blur", |
| 255 | + "n_blur_timestamp", |
| 256 | + "n_clicks", |
| 257 | + "n_clicks_timestamp", |
| 258 | + "name", |
| 259 | + "persisted_props", |
| 260 | + "persistence", |
| 261 | + "persistence_type", |
| 262 | + "role", |
| 263 | + "spellCheck", |
| 264 | + "style", |
| 265 | + "tabIndex", |
| 266 | + "title", |
| 267 | + "type", |
| 268 | + "value", |
| 269 | + ] |
| 270 | + self.available_wildcard_properties = [] |
| 271 | + _explicit_args = kwargs.pop("_explicit_args") |
| 272 | + _locals = locals() |
| 273 | + _locals.update(kwargs) # For wildcard attrs and excess named props |
| 274 | + args = {k: _locals[k] for k in _explicit_args if k != "children"} |
| 275 | + |
| 276 | + super(Button, self).__init__(children=children, **args) |
| 277 | + |
| 278 | + |
| 279 | +setattr(Button, "__init__", _explicitize_args(Button.__init__)) |
0 commit comments