Skip to content

Commit cd44324

Browse files
committed
Update README.md
1 parent d6ad8ba commit cd44324

File tree

1 file changed

+5
-4
lines changed

1 file changed

+5
-4
lines changed

README.md

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ Video demo:
1414

1515
https://github.com/user-attachments/assets/7c353b89-bbc7-4795-80ac-aef0c808c725
1616

17-
App Demo: https://scrollnav-demo.streamlit.app/
17+
App demo: https://scrollnav-demo.streamlit.app/
1818

1919
## Installation
2020

@@ -27,7 +27,8 @@ pip install streamlit-scroll-navigation
2727
`scroll_navbar()` creates a navigation bar with buttons that scroll the page to anchor IDs. It is highly customizable, supporting various orientations, labels, icons, and styles.
2828

2929
- `anchor_ids` ( `Collection[str]` ):
30-
A collection of anchor IDs that represent the sections or points to navigate to. **Required**.
30+
A collection of anchor IDs that represent the sections or points to navigate to.
31+
**Required**.
3132

3233
- `key` ( `str`, optional ):
3334
A unique key for the component. Each navbar must have a unique key for cross-origin message handling.
@@ -58,7 +59,7 @@ pip install streamlit-scroll-navigation
5859
**Default**: `True`.
5960
- `disable_scroll` (`bool`, optional):
6061
If True, navigation will snap instantly to anchors.
61-
Defaults to False.
62+
**Default**: `False`.
6263

6364
## Examples
6465

@@ -93,7 +94,7 @@ for anchor_id in anchor_ids:
9394
```
9495

9596
### Styles Overrides
96-
The override_styles argument allows you to customize the styles for scroll_navbar component. This property accepts an object containing specific style overrides that will be merged with the base styles defined in the component. By using this option, you can modify the appearance of the navigation bar to better fit your design requirements.
97+
The `override_styles` argument allows you to customize the styles for scroll_navbar component. This property accepts an object containing specific style overrides that will be merged with the base styles defined in the component. By using this option, you can modify the appearance of the navigation bar to better fit your design requirements.
9798

9899
Below is a list of style keys available for customization:
99100

0 commit comments

Comments
 (0)