-
Notifications
You must be signed in to change notification settings - Fork 2.3k
/
layouts.py
373 lines (331 loc) 路 12.7 KB
/
layouts.py
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
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
from __future__ import annotations
import warnings
from typing import TYPE_CHECKING, Literal
from gradio_client.documentation import document, set_documentation_group
from gradio.blocks import BlockContext, Updateable
from gradio.deprecation import warn_deprecation, warn_style_method_deprecation
from gradio.events import Changeable, Selectable
if TYPE_CHECKING:
from gradio.blocks import Block
set_documentation_group("layout")
@document()
class Row(Updateable, BlockContext):
"""
Row is a layout element within Blocks that renders all children horizontally.
Example:
with gr.Blocks() as demo:
with gr.Row():
gr.Image("lion.jpg", scale=2)
gr.Image("tiger.jpg", scale=1)
demo.launch()
Guides: controlling-layout
"""
def __init__(
self,
*,
variant: Literal["default", "panel", "compact"] = "default",
visible: bool = True,
elem_id: str | None = None,
elem_classes: list[str] | str | None = None,
equal_height: bool = True,
**kwargs,
):
"""
Parameters:
variant: row type, 'default' (no background), 'panel' (gray background color and rounded corners), or 'compact' (rounded corners and no internal gap).
visible: If False, row will be hidden.
elem_id: An optional string that is assigned as the id of this component in the HTML DOM. Can be used for targeting CSS styles.
elem_classes: An optional string or list of strings that are assigned as the class of this component in the HTML DOM. Can be used for targeting CSS styles.
equal_height: If True, makes every child element have equal height
"""
self.variant = variant
self.equal_height = equal_height
if variant == "compact":
self.allow_expected_parents = False
BlockContext.__init__(
self, visible=visible, elem_id=elem_id, elem_classes=elem_classes, **kwargs
)
@staticmethod
def update(
visible: bool | None = None,
):
return {
"visible": visible,
"__type__": "update",
}
def style(
self,
*,
equal_height: bool | None = None,
**kwargs,
):
"""
Styles the Row.
Parameters:
equal_height: If True, makes every child element have equal height
"""
warn_style_method_deprecation()
if equal_height is not None:
self.equal_height = equal_height
return self
@document()
class Column(Updateable, BlockContext):
"""
Column is a layout element within Blocks that renders all children vertically. The widths of columns can be set through the `scale` and `min_width` parameters.
If a certain scale results in a column narrower than min_width, the min_width parameter will win.
Example:
with gr.Blocks() as demo:
with gr.Row():
with gr.Column(scale=1):
text1 = gr.Textbox()
text2 = gr.Textbox()
with gr.Column(scale=4):
btn1 = gr.Button("Button 1")
btn2 = gr.Button("Button 2")
Guides: controlling-layout
"""
def __init__(
self,
*,
scale: int = 1,
min_width: int = 320,
variant: Literal["default", "panel", "compact"] = "default",
visible: bool = True,
elem_id: str | None = None,
elem_classes: list[str] | str | None = None,
**kwargs,
):
"""
Parameters:
scale: relative width compared to adjacent Columns. For example, if Column A has scale=2, and Column B has scale=1, A will be twice as wide as B.
min_width: minimum pixel width of Column, will wrap if not sufficient screen space to satisfy this value. If a certain scale value results in a column narrower than min_width, the min_width parameter will be respected first.
variant: column type, 'default' (no background), 'panel' (gray background color and rounded corners), or 'compact' (rounded corners and no internal gap).
visible: If False, column will be hidden.
elem_id: An optional string that is assigned as the id of this component in the HTML DOM. Can be used for targeting CSS styles.
elem_classes: An optional string or list of strings that are assigned as the class of this component in the HTML DOM. Can be used for targeting CSS styles.
"""
if scale != round(scale):
warn_deprecation(
f"'scale' value should be an integer. Using {scale} will cause issues."
)
self.scale = scale
self.min_width = min_width
self.variant = variant
if variant == "compact":
self.allow_expected_parents = False
BlockContext.__init__(
self, visible=visible, elem_id=elem_id, elem_classes=elem_classes, **kwargs
)
@staticmethod
def update(
variant: str | None = None,
visible: bool | None = None,
):
return {
"variant": variant,
"visible": visible,
"__type__": "update",
}
class Tabs(Updateable, BlockContext, Changeable, Selectable):
"""
Tabs is a layout element within Blocks that can contain multiple "Tab" Components.
"""
def __init__(
self,
*,
selected: int | str | None = None,
visible: bool = True,
elem_id: str | None = None,
elem_classes: list[str] | str | None = None,
**kwargs,
):
"""
Parameters:
selected: The currently selected tab. Must correspond to an id passed to the one of the child TabItems. Defaults to the first TabItem.
visible: If False, Tabs will be hidden.
elem_id: An optional string that is assigned as the id of this component in the HTML DOM. Can be used for targeting CSS styles.
elem_classes: An optional string or list of strings that are assigned as the class of this component in the HTML DOM. Can be used for targeting CSS styles.
"""
BlockContext.__init__(
self, visible=visible, elem_id=elem_id, elem_classes=elem_classes, **kwargs
)
Changeable.__init__(self)
Selectable.__init__(self)
self.selected = selected
@staticmethod
def update(
selected: int | str | None = None,
):
return {
"selected": selected,
"__type__": "update",
}
@document()
class Tab(Updateable, BlockContext, Selectable):
"""
Tab (or its alias TabItem) is a layout element. Components defined within the Tab will be visible when this tab is selected tab.
Example:
with gr.Blocks() as demo:
with gr.Tab("Lion"):
gr.Image("lion.jpg")
gr.Button("New Lion")
with gr.Tab("Tiger"):
gr.Image("tiger.jpg")
gr.Button("New Tiger")
Guides: controlling-layout
"""
def __init__(
self,
label: str,
*,
id: int | str | None = None,
elem_id: str | None = None,
elem_classes: list[str] | str | None = None,
**kwargs,
):
"""
Parameters:
label: The visual label for the tab
id: An optional identifier for the tab, required if you wish to control the selected tab from a predict function.
elem_id: An optional string that is assigned as the id of the <div> containing the contents of the Tab layout. The same string followed by "-button" is attached to the Tab button. Can be used for targeting CSS styles.
elem_classes: An optional string or list of strings that are assigned as the class of this component in the HTML DOM. Can be used for targeting CSS styles.
"""
BlockContext.__init__(
self, elem_id=elem_id, elem_classes=elem_classes, **kwargs
)
Selectable.__init__(self)
self.label = label
self.id = id
def get_expected_parent(self) -> type[Tabs]:
return Tabs
def get_block_name(self):
return "tabitem"
TabItem = Tab
@document()
class Group(Updateable, BlockContext):
"""
Group is a layout element within Blocks which groups together children so that
they do not have any padding or margin between them.
Example:
with gr.Group():
gr.Textbox(label="First")
gr.Textbox(label="Last")
"""
def __init__(
self,
*,
visible: bool = True,
elem_id: str | None = None,
elem_classes: list[str] | str | None = None,
**kwargs,
):
"""
Parameters:
visible: If False, group will be hidden.
elem_id: An optional string that is assigned as the id of this component in the HTML DOM. Can be used for targeting CSS styles.
elem_classes: An optional string or list of strings that are assigned as the class of this component in the HTML DOM. Can be used for targeting CSS styles.
"""
BlockContext.__init__(
self, visible=visible, elem_id=elem_id, elem_classes=elem_classes, **kwargs
)
@staticmethod
def update(
visible: bool | None = None,
):
return {
"visible": visible,
"__type__": "update",
}
class Box(Updateable, BlockContext):
"""
DEPRECATED.
Box is a a layout element which places children in a box with rounded corners and
some padding around them.
Example:
with gr.Box():
gr.Textbox(label="First")
gr.Textbox(label="Last")
"""
def __init__(
self,
*,
visible: bool = True,
elem_id: str | None = None,
**kwargs,
):
"""
Parameters:
visible: If False, box will be hidden.
elem_id: An optional string that is assigned as the id of this component in the HTML DOM. Can be used for targeting CSS styles.
"""
warnings.warn("gr.Box is deprecated. Use gr.Group instead.", DeprecationWarning)
BlockContext.__init__(self, visible=visible, elem_id=elem_id, **kwargs)
@staticmethod
def update(
visible: bool | None = None,
):
return {
"visible": visible,
"__type__": "update",
}
def style(self, **kwargs):
warn_style_method_deprecation()
return self
class Form(Updateable, BlockContext):
def __init__(self, *, scale: int = 0, min_width: int = 0, **kwargs):
"""
Parameters:
scale: relative width compared to adjacent Columns. For example, if Column A has scale=2, and Column B has scale=1, A will be twice as wide as B.
min_width: minimum pixel width of Column, will wrap if not sufficient screen space to satisfy this value. If a certain scale value results in a column narrower than min_width, the min_width parameter will be respected first.
"""
self.scale = scale
self.min_width = min_width
BlockContext.__init__(self, **kwargs)
def add_child(self, child: Block):
if isinstance(self.parent, Row):
scale = getattr(child, "scale", None)
self.scale += 1 if scale is None else scale
self.min_width += getattr(child, "min_width", 0) or 0
BlockContext.add_child(self, child)
@document()
class Accordion(Updateable, BlockContext):
"""
Accordion is a layout element which can be toggled to show/hide the contained content.
Example:
with gr.Accordion("See Details"):
gr.Markdown("lorem ipsum")
"""
def __init__(
self,
label,
*,
open: bool = True,
visible: bool = True,
elem_id: str | None = None,
elem_classes: list[str] | str | None = None,
**kwargs,
):
"""
Parameters:
label: name of accordion section.
open: if True, accordion is open by default.
elem_id: An optional string that is assigned as the id of this component in the HTML DOM. Can be used for targeting CSS styles.
elem_classes: An optional string or list of strings that are assigned as the class of this component in the HTML DOM. Can be used for targeting CSS styles.
"""
self.label = label
self.open = open
BlockContext.__init__(
self, visible=visible, elem_id=elem_id, elem_classes=elem_classes, **kwargs
)
@staticmethod
def update(
open: bool | None = None,
label: str | None = None,
visible: bool | None = None,
):
return {
"visible": visible,
"label": label,
"open": open,
"__type__": "update",
}