Skip to content

Commit

Permalink
improvements
Browse files Browse the repository at this point in the history
  • Loading branch information
toviszsolt committed Mar 28, 2024
1 parent c049f63 commit 74f611e
Show file tree
Hide file tree
Showing 2 changed files with 3 additions and 10 deletions.
2 changes: 1 addition & 1 deletion CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Contributing to base64-transcode
# Contributing to react-scrollspy

We welcome and appreciate contributions from the community. Whether you're fixing a bug, improving existing
functionality, or adding new features, your contributions help to make
Expand Down
11 changes: 2 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -73,17 +73,13 @@ the `id` of an existing content element. You can use structures of any complexit
and you can nest multiple `ScrollSpy` components (although this works, it is not recommended). Don't worry, `ScrollSpy`
won't add any additional structures to the child component.

> #### Note:
>
> If you are new to url hashes, here is some information: https://en.wikipedia.org/wiki/URI_fragment
_Note: If you are new to url hashes, here is some information: https://en.wikipedia.org/wiki/URI_fragment_

```jsx
import ScrollSpy from 'react-scrollspy-navigation';
```

```jsx
// Last item won't use as ScrollSpy item, but you can place there.
// Obviously, non hash links will not be processed.
const Navigation = () => {
return (
<ScrollSpy activeClass="nav-active">
Expand All @@ -109,9 +105,7 @@ Don't forget to specify in the `activeClass` prop what className to add to the c
we are done, it was that simple. Continue reading the documentation to find out what options are available to configure
how `ScrollSpy` works.

> #### Note:
>
> The much loved `Refs` used in the previous version and React were thrown away.
_Note: The much loved `Refs` used in the previous version and React were thrown away._

## Configuration

Expand Down Expand Up @@ -143,7 +137,6 @@ const Comp = () => {
const onClickEach = (e, next, container) => {
console.log('The clicked element:', e.target);
console.log('The container element of target:', container);
// You can do something here if you want.
next();
};

Expand Down

0 comments on commit 74f611e

Please sign in to comment.