Skip to content

Update README.md #22

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Update README.md #22

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 9 additions & 3 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,9 +22,15 @@ A lightweight **zero-dependency** React hook + Component that automatically stic
- Other libraries use easing functions with durations instead, but these doesn't work well when you want to stream in new content with variable sizing - which is common for AI chatbot use cases.
- `scrollToBottom` returns a `Promise<boolean>` which will resolve to `true` as soon as the scroll was successful, or `false` if the scroll was cancelled.

# Usage
## Installation

## `<StickToBottom>` Component
```bash
npm install use-stick-to-bottom
```

## Usage

### `<StickToBottom>` Component

```jsx
import { StickToBottom, useStickToBottomContext } from 'use-stick-to-bottom';
Expand Down Expand Up @@ -60,7 +66,7 @@ function ScrollToBottom() {
}
```

## `useStickToBottom` Hook
### `useStickToBottom` Hook

```jsx
import { useStickToBottom } from 'use-stick-to-bottom';
Expand Down