pane class
A side pane.
Methods¶
__init__() ¶
__init__(
open=False,
on_close=None,
anchor="left",
persistent=False,
width="30vw",
height="30vh",
show_button=False,
page=None,
partial=None,
on_change=None,
active=True,
id=None,
properties=None,
class_name=None,
hover_text=None,
) -> None
Create a new pane
element.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
|
bool
|
If True, this pane is visible on the page. |
False
|
|
Union[str, Callable]
|
A function or the name of a function that is triggered when this pane is closed (if the user clicks outside of it or presses the Esc key).
|
None
|
|
str
|
Anchor side of the pane. |
left
|
|
bool
|
If False, the pane covers the page where it appeared and disappears if the user clicks in the page. |
False
|
|
str
|
Width, in CSS units, of this pane. |
30vw
|
|
str
|
Height, in CSS units, of this pane. |
30vh
|
|
bool
|
If True and when the pane is closed, a button allowing the pane to be opened is shown. |
False
|
|
str
|
The page name to show as the content of the block. |
None
|
|
Partial
|
A Partial object that holds the content of the block. |
None
|
|
Union[str, Callable]
|
A function or the name of a function that is triggered when the value is updated.
|
None
|
|
bool
|
Indicates if this component is active. |
True
|
|
str
|
The identifier that is assigned to the rendered HTML component. |
None
|
|
dict[str, Any]
|
Bound to a dictionary that contains additional properties for this element. |
None
|
|
str
|
The list of CSS class names that are associated with the generated HTML Element. |
None
|
|
str
|
The information that is displayed when the user hovers over this element. |
None
|