Skip to content

feat: integrate all-contributors #248

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

Merged
merged 2 commits into from
Feb 7, 2021
Merged

feat: integrate all-contributors #248

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
fa48c2f
feat: integrate all-contributors bot
iamdarshshah Feb 7, 2021
37a526d
fix: links
iamdarshshah Feb 7, 2021
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
27 changes: 27 additions & 0 deletions .all-contributorsrc
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
{
"files": [
"README.md"
],
"imageSize": 100,
"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"
]
}
],
"projectName": "react-infinite-scroll-component",
"projectOwner": "ankeetmaini",
"repoType": "github",
"repoHost": "https://github.com"
}
36 changes: 30 additions & 6 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,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 @@ -18,7 +18,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 @@ -46,7 +46,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 @@ -83,11 +83,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 @@ -98,7 +98,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 All @@ -122,3 +122,27 @@ The `InfiniteScroll` component can be used in three ways.
| **refreshFunction** | function | this function will be called, it should return the fresh data that you want to show the user |
| **initialScrollY** | number | set a scroll y position for the component to render with. |
| **inverse** | bool | set infinite scroll on top |

## Contributors ✨

Thanks goes to these wonderful people ([emoji key](https://allcontributors.org/docs/en/emoji-key)):

<!-- ALL-CONTRIBUTORS-LIST:START - Do not remove or modify this section -->
<!-- prettier-ignore-start -->
<!-- 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>
</tr>
</table>

<!-- markdownlint-restore -->
<!-- prettier-ignore-end -->

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

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

## LICENSE

[MIT](LICENSE)