Skip to content

Commit

Permalink
Merge branch 'master' into all-contributors/add-iamdarshshah
Browse files Browse the repository at this point in the history
  • Loading branch information
ankeetmaini authored Feb 7, 2021
2 parents 1813a62 + 33af8e1 commit 0e3c821
Show file tree
Hide file tree
Showing 2 changed files with 28 additions and 11 deletions.
20 changes: 16 additions & 4 deletions .all-contributorsrc
Original file line number Diff line number Diff line change
Expand Up @@ -3,8 +3,22 @@
"README.md"
],
"imageSize": 100,
"commit": false,
"contributorsPerLine": 5,
"skipCi": true,
"contributors": [
{
"login": "ankeetmaini",
"name": "Ankeet Maini",
"avatar_url": "https://avatars.githubusercontent.com/u/6652823?v=4",
"profile": "https://ankeetmaini.dev/",
"contributions": [
"question",
"doc",
"code",
"review",
"maintenance"
]
},
{
"login": "iamdarshshah",
"name": "Darsh Shah",
Expand All @@ -15,10 +29,8 @@
]
}
],
"contributorsPerLine": 7,
"projectName": "react-infinite-scroll-component",
"projectOwner": "ankeetmaini",
"repoType": "github",
"repoHost": "https://github.com",
"skipCi": true
"repoHost": "https://github.com"
}
19 changes: 12 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@
A component to make all your infinite scrolling woes go away with just 4.15 kB! `Pull Down to Refresh` feature
added. An infinite-scroll that actually works and super-simple to integrate!

# install
## Install

```bash
npm install --save react-infinite-scroll-component
Expand All @@ -21,7 +21,7 @@ added. An infinite-scroll that actually works and super-simple to integrate!
var InfiniteScroll = require('react-infinite-scroll-component');
```

# using
## Using

```jsx
<InfiniteScroll
Expand Down Expand Up @@ -49,7 +49,7 @@ added. An infinite-scroll that actually works and super-simple to integrate!
</InfiniteScroll>
```

# using scroll on top
## Using scroll on top

```jsx
<div
Expand Down Expand Up @@ -86,11 +86,11 @@ The `InfiniteScroll` component can be used in three ways.
- If your **scrollable** content is being rendered within a parent element that is already providing overflow scrollbars, you can set the `scrollableTarget` prop to reference the DOM element and use it's scrollbars for fetching more data.
- Without setting either the `height` or `scrollableTarget` props, the scroll will happen at `document.body` like _Facebook's_ timeline scroll.

# docs version wise
## docs version wise

[3.0.2](docs/README-3.0.2.md)

# live examples
## live examples

- infinite scroll (never ending) example using react (body/window scroll)
- [![Edit yk7637p62z](https://codesandbox.io/static/img/play-codesandbox.svg)](https://codesandbox.io/s/yk7637p62z)
Expand All @@ -101,7 +101,7 @@ The `InfiniteScroll` component can be used in three ways.
- infinite scroll with `scrollableTarget` (a parent element which is scrollable)
- [![Edit r7rp40n0zm](https://codesandbox.io/static/img/play-codesandbox.svg)](https://codesandbox.io/s/r7rp40n0zm)

# props
## props

| name | type | description |
| ------------------------------ | -------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
Expand Down Expand Up @@ -135,6 +135,7 @@ Thanks goes to these wonderful people ([emoji key](https://allcontributors.org/d
<!-- markdownlint-disable -->
<table>
<tr>
<td align="center"><a href="https://ankeetmaini.dev/"><img src="https://avatars.githubusercontent.com/u/6652823?v=4?s=100" width="100px;" alt=""/><br /><sub><b>Ankeet Maini</b></sub></a><br /><a href="#question-ankeetmaini" title="Answering Questions">πŸ’¬</a> <a href="https://github.com/ankeetmaini/react-infinite-scroll-component/commits?author=ankeetmaini" title="Documentation">πŸ“–</a> <a href="https://github.com/ankeetmaini/react-infinite-scroll-component/commits?author=ankeetmaini" title="Code">πŸ’»</a> <a href="https://github.com/ankeetmaini/react-infinite-scroll-component/pulls?q=is%3Apr+reviewed-by%3Aankeetmaini" title="Reviewed Pull Requests">πŸ‘€</a> <a href="#maintenance-ankeetmaini" title="Maintenance">🚧</a></td>
<td align="center"><a href="https://github.com/iamdarshshah"><img src="https://avatars.githubusercontent.com/u/25670841?v=4?s=100" width="100px;" alt=""/><br /><sub><b>Darsh Shah</b></sub></a><br /><a href="#infra-iamdarshshah" title="Infrastructure (Hosting, Build-Tools, etc)">πŸš‡</a></td>
</tr>
</table>
Expand All @@ -144,4 +145,8 @@ Thanks goes to these wonderful people ([emoji key](https://allcontributors.org/d

<!-- ALL-CONTRIBUTORS-LIST:END -->

This project follows the [all-contributors](https://github.com/all-contributors/all-contributors) specification. Contributions of any kind welcome!
This project follows the [all-contributors](https://allcontributors.org) specification. Contributions of any kind are welcome!

## LICENSE

[MIT](LICENSE)

0 comments on commit 0e3c821

Please sign in to comment.