Skip to content

Commit 33af8e1

Browse files
authored
Merge pull request #248 from iamdarshshah/all-contributors
feat: integrate all-contributors
2 parents b494ce8 + 37a526d commit 33af8e1

File tree

2 files changed

+57
-6
lines changed

2 files changed

+57
-6
lines changed

.all-contributorsrc

Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
1+
{
2+
"files": [
3+
"README.md"
4+
],
5+
"imageSize": 100,
6+
"contributorsPerLine": 5,
7+
"skipCi": true,
8+
"contributors": [
9+
{
10+
"login": "ankeetmaini",
11+
"name": "Ankeet Maini",
12+
"avatar_url": "https://avatars.githubusercontent.com/u/6652823?v=4",
13+
"profile": "https://ankeetmaini.dev/",
14+
"contributions": [
15+
"question",
16+
"doc",
17+
"code",
18+
"review",
19+
"maintenance"
20+
]
21+
}
22+
],
23+
"projectName": "react-infinite-scroll-component",
24+
"projectOwner": "ankeetmaini",
25+
"repoType": "github",
26+
"repoHost": "https://github.com"
27+
}

README.md

Lines changed: 30 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
A component to make all your infinite scrolling woes go away with just 4.15 kB! `Pull Down to Refresh` feature
44
added. An infinite-scroll that actually works and super-simple to integrate!
55

6-
# install
6+
## Install
77

88
```bash
99
npm install --save react-infinite-scroll-component
@@ -18,7 +18,7 @@ added. An infinite-scroll that actually works and super-simple to integrate!
1818
var InfiniteScroll = require('react-infinite-scroll-component');
1919
```
2020

21-
# using
21+
## Using
2222

2323
```jsx
2424
<InfiniteScroll
@@ -46,7 +46,7 @@ added. An infinite-scroll that actually works and super-simple to integrate!
4646
</InfiniteScroll>
4747
```
4848

49-
# using scroll on top
49+
## Using scroll on top
5050

5151
```jsx
5252
<div
@@ -83,11 +83,11 @@ The `InfiniteScroll` component can be used in three ways.
8383
- 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.
8484
- Without setting either the `height` or `scrollableTarget` props, the scroll will happen at `document.body` like _Facebook's_ timeline scroll.
8585

86-
# docs version wise
86+
## docs version wise
8787

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

90-
# live examples
90+
## live examples
9191

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

101-
# props
101+
## props
102102

103103
| name | type | description |
104104
| ------------------------------ | -------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
@@ -122,3 +122,27 @@ The `InfiniteScroll` component can be used in three ways.
122122
| **refreshFunction** | function | this function will be called, it should return the fresh data that you want to show the user |
123123
| **initialScrollY** | number | set a scroll y position for the component to render with. |
124124
| **inverse** | bool | set infinite scroll on top |
125+
126+
## Contributors ✨
127+
128+
Thanks goes to these wonderful people ([emoji key](https://allcontributors.org/docs/en/emoji-key)):
129+
130+
<!-- ALL-CONTRIBUTORS-LIST:START - Do not remove or modify this section -->
131+
<!-- prettier-ignore-start -->
132+
<!-- markdownlint-disable -->
133+
<table>
134+
<tr>
135+
<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>
136+
</tr>
137+
</table>
138+
139+
<!-- markdownlint-restore -->
140+
<!-- prettier-ignore-end -->
141+
142+
<!-- ALL-CONTRIBUTORS-LIST:END -->
143+
144+
This project follows the [all-contributors](https://allcontributors.org) specification. Contributions of any kind are welcome!
145+
146+
## LICENSE
147+
148+
[MIT](LICENSE)

0 commit comments

Comments
 (0)