Skip to content

Commit 5de0b7b

Browse files
authored
Move additional section below Parameters/Returns
1 parent 6cdf332 commit 5de0b7b

File tree

1 file changed

+23
-23
lines changed

1 file changed

+23
-23
lines changed

shiny/bookmark/_button.py

Lines changed: 23 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -28,8 +28,30 @@ def input_bookmark_button(
2828
2929
A `bookmarkButton` is a [input_action_button()] with a default label that consists of a link icon and the text "Bookmark...". It is meant to be used for bookmarking state.
3030
31+
Parameters
32+
----------
33+
label
34+
The button label.
35+
icon
36+
The icon to display on the button.
37+
width
38+
The CSS width, e.g. '400px', or '100%'.
39+
disabled
40+
Whether the button is disabled.
41+
id
42+
An ID for the bookmark button. This should only be provided when multiple buttons are needed (or used inside a module). See the note on multiple buttons.
43+
title
44+
A tooltip that is shown when the mouse cursor hovers over the button.
45+
kwargs
46+
Additional attributes for the button.
47+
48+
Returns
49+
-------
50+
:
51+
A UI element.
52+
3153
Multiple (module) buttons
32-
----------------
54+
-------------------------
3355
3456
By default, Shiny will listen for the default `id` being used and call
3557
`session.bookmark()` on button click. However, this will not work if the bookmark
@@ -52,28 +74,6 @@ async def _():
5274
await session.bookmark()
5375
```
5476
55-
Parameters
56-
----------
57-
label
58-
The button label.
59-
icon
60-
The icon to display on the button.
61-
width
62-
The CSS width, e.g. '400px', or '100%'.
63-
disabled
64-
Whether the button is disabled.
65-
id
66-
An ID for the bookmark button. This should only be provided when multiple buttons are needed (or used inside a module). See the note on multiple buttons.
67-
title
68-
A tooltip that is shown when the mouse cursor hovers over the button.
69-
kwargs
70-
Additional attributes for the button.
71-
72-
Returns
73-
-------
74-
:
75-
A UI element.
76-
7777
See Also
7878
--------
7979
* :func:`~shiny.ui.input_action_button`

0 commit comments

Comments
 (0)