Skip to content

Commit 1cb01cc

Browse files
committed
Update README documentation
1 parent 95b5109 commit 1cb01cc

File tree

1 file changed

+5
-2
lines changed

1 file changed

+5
-2
lines changed

README.md

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ pip install streamlit-scroll-navigation
2222

2323
## Usage
2424

25-
scroll_navbar() creates a scrollable navigation bar that allows users to navigate to different sections based on provided anchor IDs. It is highly customizable, supporting various orientations, labels, icons, and styles.
25+
`scroll_navbar()` creates a navigation bar that with buttons that scroll the page to anchor IDs. It is highly customizable, supporting various orientations, labels, icons, and styles.
2626

2727
- `anchor_ids` ( `Collection[str]` ):
2828
A collection of anchor IDs that represent the sections or points to navigate to. **Required**.
@@ -51,6 +51,9 @@ scroll_navbar() creates a scrollable navigation bar that allows users to navigat
5151
A dictionary to override the default styles of the component, allowing further customization.
5252
**Default**: `{}`.
5353

54+
- `auto_update_anchor` ( `bool`, optional ):
55+
If true, the highlighted anchor will automatically update to the next nearest anchor when the current one is scrolled out of view.
56+
**Default**: `true`.
5457

5558
## Examples
5659

@@ -150,7 +153,7 @@ Below is a list of style keys available for customization:
150153

151154
Contributions are welcome! If you’d like to contribute, follow these steps:
152155

153-
1. Fork the repository.
156+
1. Fork [the repository](https://github.com/SnpM/streamlit-scroll-navigation).
154157
2. Create a new branch for your feature or bugfix.
155158
3. Make your changes and commit them with clear messages.
156159
4. Open a pull request, and provide a detailed description of your changes.

0 commit comments

Comments
 (0)