Skip to content

Commit 2f801f7

Browse files
committed
Documentation updates
1 parent 8df8d94 commit 2f801f7

File tree

3 files changed

+43
-38
lines changed

3 files changed

+43
-38
lines changed

docs/_quartodoc.yml

Lines changed: 37 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -283,26 +283,43 @@ quartodoc:
283283
- title: Shiny Express
284284
desc: Functions for Shiny Express applications
285285
contents:
286-
- express.layout.set_page
287-
- express.layout.p
288-
- express.layout.div
289-
- express.layout.span
290-
- express.layout.pre
291-
- express.layout.sidebar
292-
- express.layout.layout_columns
293-
- express.layout.layout_column_wrap
294-
- express.layout.column
295-
- express.layout.row
296-
- express.layout.card
297-
- express.layout.accordion
298-
- express.layout.accordion_panel
299-
- express.layout.navset
300-
- express.layout.navset_card
301-
- express.layout.nav_panel
302-
- express.layout.page_fluid
303-
- express.layout.page_fixed
304-
- express.layout.page_fillable
305-
- express.layout.page_sidebar
286+
- kind: page
287+
path: ContextManagerComponents
288+
summary:
289+
name: "Context manager components"
290+
desc: ""
291+
flatten: true
292+
contents:
293+
- express.ui.set_page
294+
- express.ui.sidebar
295+
- express.ui.layout_sidebar
296+
- express.ui.layout_column_wrap
297+
- express.ui.layout_columns
298+
- express.ui.card
299+
- express.ui.accordion
300+
- express.ui.accordion_panel
301+
- express.ui.nav_panel
302+
- express.ui.nav_control
303+
- express.ui.nav_menu
304+
- express.ui.navset_bar
305+
- express.ui.navset_card_pill
306+
- express.ui.navset_card_tab
307+
- express.ui.navset_card_underline
308+
- express.ui.navset_hidden
309+
- express.ui.navset_pill
310+
- express.ui.navset_pill_list
311+
- express.ui.navset_tab
312+
- express.ui.navset_underline
313+
- express.ui.value_box
314+
- express.ui.panel_well
315+
- express.ui.panel_conditional
316+
- express.ui.panel_fixed
317+
- express.ui.panel_absolute
318+
- express.ui.page_fluid
319+
- express.ui.page_fixed
320+
- express.ui.page_fillable
321+
- express.ui.page_sidebar
322+
- express.ui.page_navbar
306323
- title: Deprecated
307324
desc: ""
308325
contents:

shiny/express/ui/_cm_components.py

Lines changed: 5 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -856,16 +856,16 @@ def navset_pill_list(
856856
If provided, will create an input value that holds the currently selected nav
857857
item.
858858
selected
859-
Choose a particular nav item to select by default value (should match it's
859+
Choose a particular nav item to select by default value (should match its
860860
``value``).
861-
sidebar
862-
A :class:`shiny.ui.Sidebar` component to display on every :func:`~shiny.ui.nav` page.
863861
header
864862
UI to display above the selected content.
865863
footer
866864
UI to display below the selected content.
867-
placement
868-
Placement of the nav items relative to the content.
865+
well
866+
``True`` to place a well (gray rounded rectangle) around the navigation list.
867+
widths
868+
Column widths of the navigation list and tabset content areas respectively.
869869
"""
870870
return RecallContextManager(
871871
ui.navset_pill_list,
@@ -1017,11 +1017,6 @@ def nav_control() -> RecallContextManager[NavPanel]:
10171017
Context manager for a control in the navigation container.
10181018
10191019
This function wraps :func:`~shiny.ui.nav_control`.
1020-
1021-
Parameters
1022-
----------
1023-
*args
1024-
UI elements to display as the nav item.
10251020
"""
10261021
return RecallContextManager(ui.nav_control)
10271022

@@ -1042,11 +1037,6 @@ def nav_menu(
10421037
----------
10431038
title
10441039
A title to display. Can be a character string or UI elements (i.e., tags).
1045-
*args
1046-
A collection of nav items (e.g., :func:`~shiny.ui.nav`) and/or strings.
1047-
Strings will be rendered as a section header unless the string is a set
1048-
of two or more hyphens (e.g., ``---``), in which case it will be rendered
1049-
as a divider.
10501040
value
10511041
The value of the item. This is used to determine whether the item is active
10521042
(when an ``id`` is provided to the nav container), programmatically select the
@@ -1563,8 +1553,6 @@ def page_navbar(
15631553
selected
15641554
Choose a particular nav item to select by default value (should match it's
15651555
``value``).
1566-
sidebar
1567-
A :func:`~shiny.ui.sidebar` component to display on every page.
15681556
fillable
15691557
Whether or not the main content area should be considered a fillable
15701558
(i.e., flexbox) container.

shiny/ui/_navs.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -923,7 +923,7 @@ def navset_pill_list(
923923
If provided, will create an input value that holds the currently selected nav
924924
item.
925925
selected
926-
Choose a particular nav item to select by default value (should match it's
926+
Choose a particular nav item to select by default value (should match its
927927
``value``).
928928
header
929929
UI to display above the selected content.

0 commit comments

Comments
 (0)