The `to` prop controls the final `href` prop, and `onClick` is used internally to perform the scrolling. If you need to run some code when the link is clicked use the `beforeAnimate` prop instead.

### `to: string`

The anchor (id) to which this link should scroll to. Any leading `#` will be stripped from this value.

### `target?: string`

The element scrolling will be performed on when clicked. Leading `#` will be stripped here as well.

Scrollchor works within any scrollable parent container. If no target is provided (or the target element is not found on the page), the default is scrolling both the `` and `` elements simultaneously.

### `animate?: Partial`

The smooth scrolling animation can be customized using this prop. Three pre-defined easing functions are exported by the package: `easeOutQuad`, `swing`, `linear`. When not provided, the default looks like this:

```ts
import { AnimateConfig, easeOutQuad } from 'react-scrollchor';

const defaultAnimate: AnimateConfig = {
offset: 0,
duration: 400,
easing: easeOutQuad,
};
```

* `offset?: number` — Additional pixels to scroll relative to the target element (supports negative values, e.g. for fixed position headers)
* `duration?: number` — Length of the animation in milliseconds
* `easing?: ScrollchorEasingFunction` — Easing function to calculate the animation steps. Pass a function that matches the exported interface for a custom easing.

| # | Parameter | Meaning |
|---|-----------|---------|
|0|percent|Percent completed of the animation (decimal, `0.0` to `1.0`)|
|1|elapsedTime|Time elapsed since the animation began, in ms|
|2|startValue|Static value set to `0`|
|3|valueChange|Static value set to `1`|
|4|duration|Duration of the animation, in ms|

Returns a decimal indicating how close the animation is to the end value (`0` = start, `1` = finished, `1.2` = 20% over the end value, think "bounce" effects)

The default values can be customized all at once or individually by providing only the properties you want to override. For example:

```jsx
import { Scrollchor, linear } from 'react-scrollchor';

const HomeLink = () => (

Home

);
```

You can find additional easing functions at these links:

* [Robert Penner's Easing Functions](http://robertpenner.com/easing/)
* [Javascript source code](https://github.com/danro/jquery-easing/blob/master/jquery.easing.js)

### `beforeAnimate: MouseEventHandler` / `afterAnimate: MouseEventHandler`

You can use these callbacks to trigger behaviors like: update state, load async stuff, etc. when either stage happens. The functions receive the originating `MouseEvent` as their only argument, the return value is not used.

`beforeAnimate` is triggered before the animation starts, i.e. immediately when the link is clicked, while `afterAnimate` is called once the animation has finished.

```js
setActive('home')}>Home
```

## Credits

### author
* bySabi Files <> [@bySabi](https://github.com/bySabi)

### maintainers
* xehpuk <> [@xehpuk](https://github.com/xehpuk)
* SeinopSys <> [@SeinopSys](https://github.com/SeinopSys)

### contributors
* Jean Chung <> [@jeanchung](https://github.com/jeanchung)
* Chua Kang Ming <> [@kambing86](https://github.com/kambing86)
* Benjamin MICHEL <> [@SBRK](https://github.com/SBRK)

## Contributing

* Documentation improvement
* Feel free to send any PR

## License

[ISC][isc-license]