Skip to content

Commit d6ad8ba

Browse files
committed
Document disable_scroll
1 parent a570ba0 commit d6ad8ba

File tree

2 files changed

+4
-1
lines changed

2 files changed

+4
-1
lines changed

README.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -56,6 +56,9 @@ pip install streamlit-scroll-navigation
5656
- `auto_update_anchor` ( `bool`, optional ):
5757
If true, the highlighted anchor will automatically update to the next nearest anchor when the current one is scrolled out of view.
5858
**Default**: `True`.
59+
- `disable_scroll` (`bool`, optional):
60+
If True, navigation will snap instantly to anchors.
61+
Defaults to False.
5962

6063
## Examples
6164

streamlit_scroll_navigation/__init__.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -97,7 +97,7 @@ def scroll_navbar(
9797
If True, the highlighted anchor will automatically update to the next nearest anchor when the current one is scrolled out of view.
9898
Defaults to True.
9999
disable_scroll (bool, optional):
100-
If True, disables the scroll functionality of the navigation bar.
100+
If True, navigation will snap instantly to anchors.
101101
Defaults to False.
102102
Returns:
103103
str: The ID of the anchor that is currently selected.

0 commit comments

Comments
 (0)