Skip to content

Commit

Permalink
chore: update readme with methods table
Browse files Browse the repository at this point in the history
  • Loading branch information
azimgd committed May 15, 2024
1 parent 5b8a6d8 commit bcfd52c
Show file tree
Hide file tree
Showing 2 changed files with 6 additions and 1 deletion.
6 changes: 6 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -59,6 +59,12 @@ import ShadowListContainer from 'shadowlist';
| `initialScrollIndex` | Number | Optional | The initial index of the item to scroll to when the list mounts. |
| `inverted` | Boolean | Optional | If true, the list will be rendered in an inverted order. |

## Methods
| Method | Type | Description |
|-----------------|-------------------------------------|-----------------------------------------------------------|
| `scrollToIndex` | `(index: number) => void` | Scrolls the list to the specified index. |
| `scrollToOffset`| `(offset: number) => void` | Scrolls the list to the specified offset. |

## Contributing

See the [contributing guide](CONTRIBUTING.md) to learn how to contribute to the repository and the development workflow.
Expand Down
1 change: 0 additions & 1 deletion example/src/App.tsx
Original file line number Diff line number Diff line change
@@ -1,5 +1,4 @@
import * as React from 'react';

import {
SafeAreaView,
StyleSheet,
Expand Down

0 comments on commit bcfd52c

Please sign in to comment.