Skip to content

Commit 07842ec

Browse files
author
Elson Correia
committed
remove documentation branch from doc
1 parent c0bbfeb commit 07842ec

File tree

2 files changed

+23
-23
lines changed

2 files changed

+23
-23
lines changed

README.md

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -80,13 +80,13 @@ return (
8080

8181
| Features | Props / Components |
8282
| :------------- | :------------- |
83-
| [Components](https://github.com/beforesemicolon/flatlist-react/blob/documentation/documentation/Doc.md#components) | [PlainList](https://github.com/beforesemicolon/flatlist-react/blob/documentation/documentation/Doc.md#plainlist) |
84-
| [Rendering](https://github.com/beforesemicolon/flatlist-react/blob/documentation/documentation/Doc.md#rendering) | [list](https://github.com/beforesemicolon/flatlist-react/blob/documentation/documentation/Doc.md#list-and-renderitem), [renderItem](https://github.com/beforesemicolon/flatlist-react/blob/documentation/documentation/Doc.md#list-and-renderitem), [renderWhenEmpty](https://github.com/beforesemicolon/flatlist-react/blob/documentation/documentation/Doc.md#renderwhenempty), [wrapperHtmlTag](https://github.com/beforesemicolon/flatlist-react/blob/documentation/documentation/Doc.md#wrapperhtmltag), [limit](https://github.com/beforesemicolon/flatlist-react/blob/documentation/documentation/Doc.md#limit), [reversed](https://github.com/beforesemicolon/flatlist-react/blob/documentation/documentation/Doc.md#reversed) |
85-
| [Render Optimization](https://github.com/beforesemicolon/flatlist-react/blob/documentation/documentation/Doc.md#render-optimization) | [renderOnScroll](https://github.com/beforesemicolon/flatlist-react/blob/documentation/documentation/Doc.md#renderonscroll) |
86-
| [Pagination (Infinite Scroll)](https://github.com/beforesemicolon/flatlist-react/blob/documentation/documentation/Doc.md#pagination) | [hasMoreItems](https://github.com/beforesemicolon/flatlist-react/blob/documentation/documentation/Doc.md#hasmoreitems), [loadMoreItems](https://github.com/beforesemicolon/flatlist-react/blob/documentation/documentation/Doc.md#loadmoreitems), [paginationLoadingIndicator](https://github.com/beforesemicolon/flatlist-react/blob/documentation/documentation/Doc.md#paginationloadingindicator), [paginationLoadingIndicatorPosition](https://github.com/beforesemicolon/flatlist-react/blob/documentation/documentation/Doc.md#paginationloadingindicatorposition) |
87-
| [Filtering](https://github.com/beforesemicolon/flatlist-react/blob/documentation/documentation/Doc.md#filtering) | [filterBy](https://github.com/beforesemicolon/flatlist-react/blob/documentation/documentation/Doc.md#filterby) |
88-
| [Searching](https://github.com/beforesemicolon/flatlist-react/blob/documentation/documentation/Doc.md#searching) | [searchTerm](https://github.com/beforesemicolon/flatlist-react/blob/documentation/documentation/Doc.md#searchterm), [searchBy](https://github.com/beforesemicolon/flatlist-react/blob/documentation/documentation/Doc.md#searchby), [searchOnEveryWord](https://github.com/beforesemicolon/flatlist-react/blob/documentation/documentation/Doc.md#searchoneveryword), [searchMinCharactersCount](https://github.com/beforesemicolon/flatlist-react/blob/documentation/documentation/Doc.md#searchmincharacterscount), [searchCaseInsensitive](https://github.com/beforesemicolon/flatlist-react/blob/documentation/documentation/Doc.md#searchcaseinsensitive) |
89-
| [Sorting](https://github.com/beforesemicolon/flatlist-react/blob/documentation/documentation/Doc.md#sorting) | [sortBy](https://github.com/beforesemicolon/flatlist-react/blob/documentation/documentation/Doc.md#sortby), [sortCaseInsensitive](https://github.com/beforesemicolon/flatlist-react/blob/documentation/documentation/Doc.md#sortcaseinsensitive), [sortDescending](https://github.com/beforesemicolon/flatlist-react/blob/documentation/documentation/Doc.md#sortdescending) |
90-
| [Grouping](https://github.com/beforesemicolon/flatlist-react/blob/documentation/documentation/Doc.md#grouping) | [groupOf](https://github.com/beforesemicolon/flatlist-react/blob/documentation/documentation/Doc.md#groupof), [groupBy](https://github.com/beforesemicolon/flatlist-react/blob/documentation/documentation/Doc.md#groupby), [groupSeparator](https://github.com/beforesemicolon/flatlist-react/blob/documentation/documentation/Doc.md#groupseparator), [groupSeparatorAtTheBottom](https://github.com/beforesemicolon/flatlist-react/blob/documentation/documentation/Doc.md#groupseparatoratthebottom), [groupReversed](https://github.com/beforesemicolon/flatlist-react/blob/documentation/documentation/Doc.md#groupreversed), [groupSorted](https://github.com/beforesemicolon/flatlist-react/blob/documentation/documentation/Doc.md#groupsorted), [groupSortedBy](https://github.com/beforesemicolon/flatlist-react/blob/documentation/documentation/Doc.md#groupsortedby), [groupSortedDescending](https://github.com/beforesemicolon/flatlist-react/blob/documentation/documentation/Doc.md#groupsorteddescending), [groupSortedCaseInsensitive](https://github.com/beforesemicolon/flatlist-react/blob/documentation/documentation/Doc.md#groupsortedcaseinsensitive) |
91-
| [Styling](https://github.com/beforesemicolon/flatlist-react/blob/documentation/documentation/Doc.md#styling) | [displayGrid](https://github.com/beforesemicolon/flatlist-react/blob/documentation/documentation/Doc.md#displaygrid), [gridGap](https://github.com/beforesemicolon/flatlist-react/blob/documentation/documentation/Doc.md#gridgap), [minColumnWidth](https://github.com/beforesemicolon/flatlist-react/blob/documentation/documentation/Doc.md#mincolumnwidth), [displayRow](https://github.com/beforesemicolon/flatlist-react/blob/documentation/documentation/Doc.md#displayrow), [rowGap](https://github.com/beforesemicolon/flatlist-react/blob/documentation/documentation/Doc.md#rowgap) |
92-
| [scrollToTop](https://github.com/beforesemicolon/flatlist-react/blob/documentation/documentation/Doc.md#scrolltotop) |[scrollToTopButton](https://github.com/beforesemicolon/flatlist-react/blob/documentation/documentation/Doc.md#scrolltotopbutton), [scrollToTopOffset](https://github.com/beforesemicolon/flatlist-react/blob/documentation/documentation/Doc.md#scrolltotopoffset), [scrollToTopPadding](https://github.com/beforesemicolon/flatlist-react/blob/documentation/documentation/Doc.md#scrolltotoppadding), [scrollToTopPosition](https://github.com/beforesemicolon/flatlist-react/blob/documentation/documentation/Doc.md#scrolltotopposition) |
83+
| [Components](https://github.com/beforesemicolon/flatlist-react/blob/master/documentation/Doc.md#components) | [PlainList](https://github.com/beforesemicolon/flatlist-react/blob/master/documentation/Doc.md#plainlist) |
84+
| [Rendering](https://github.com/beforesemicolon/flatlist-react/blob/master/documentation/Doc.md#rendering) | [list](https://github.com/beforesemicolon/flatlist-react/blob/master/documentation/Doc.md#list-and-renderitem), [renderItem](https://github.com/beforesemicolon/flatlist-react/blob/master/documentation/Doc.md#list-and-renderitem), [renderWhenEmpty](https://github.com/beforesemicolon/flatlist-react/blob/master/documentation/Doc.md#renderwhenempty), [wrapperHtmlTag](https://github.com/beforesemicolon/flatlist-react/blob/master/documentation/Doc.md#wrapperhtmltag), [limit](https://github.com/beforesemicolon/flatlist-react/blob/master/documentation/Doc.md#limit), [reversed](https://github.com/beforesemicolon/flatlist-react/blob/master/documentation/Doc.md#reversed) |
85+
| [Render Optimization](https://github.com/beforesemicolon/flatlist-react/blob/master/documentation/Doc.md#render-optimization) | [renderOnScroll](https://github.com/beforesemicolon/flatlist-react/blob/master/documentation/Doc.md#renderonscroll) |
86+
| [Pagination (Infinite Scroll)](https://github.com/beforesemicolon/flatlist-react/blob/master/documentation/Doc.md#pagination) | [hasMoreItems](https://github.com/beforesemicolon/flatlist-react/blob/master/documentation/Doc.md#hasmoreitems), [loadMoreItems](https://github.com/beforesemicolon/flatlist-react/blob/master/documentation/Doc.md#loadmoreitems), [paginationLoadingIndicator](https://github.com/beforesemicolon/flatlist-react/blob/master/documentation/Doc.md#paginationloadingindicator), [paginationLoadingIndicatorPosition](https://github.com/beforesemicolon/flatlist-react/blob/master/documentation/Doc.md#paginationloadingindicatorposition) |
87+
| [Filtering](https://github.com/beforesemicolon/flatlist-react/blob/master/documentation/Doc.md#filtering) | [filterBy](https://github.com/beforesemicolon/flatlist-react/blob/master/documentation/Doc.md#filterby) |
88+
| [Searching](https://github.com/beforesemicolon/flatlist-react/blob/master/documentation/Doc.md#searching) | [searchTerm](https://github.com/beforesemicolon/flatlist-react/blob/master/documentation/Doc.md#searchterm), [searchBy](https://github.com/beforesemicolon/flatlist-react/blob/master/documentation/Doc.md#searchby), [searchOnEveryWord](https://github.com/beforesemicolon/flatlist-react/blob/master/documentation/Doc.md#searchoneveryword), [searchMinCharactersCount](https://github.com/beforesemicolon/flatlist-react/blob/master/documentation/Doc.md#searchmincharacterscount), [searchCaseInsensitive](https://github.com/beforesemicolon/flatlist-react/blob/master/documentation/Doc.md#searchcaseinsensitive) |
89+
| [Sorting](https://github.com/beforesemicolon/flatlist-react/blob/master/documentation/Doc.md#sorting) | [sortBy](https://github.com/beforesemicolon/flatlist-react/blob/master/documentation/Doc.md#sortby), [sortCaseInsensitive](https://github.com/beforesemicolon/flatlist-react/blob/master/documentation/Doc.md#sortcaseinsensitive), [sortDescending](https://github.com/beforesemicolon/flatlist-react/blob/master/documentation/Doc.md#sortdescending) |
90+
| [Grouping](https://github.com/beforesemicolon/flatlist-react/blob/master/documentation/Doc.md#grouping) | [groupOf](https://github.com/beforesemicolon/flatlist-react/blob/master/documentation/Doc.md#groupof), [groupBy](https://github.com/beforesemicolon/flatlist-react/blob/master/documentation/Doc.md#groupby), [groupSeparator](https://github.com/beforesemicolon/flatlist-react/blob/master/documentation/Doc.md#groupseparator), [groupSeparatorAtTheBottom](https://github.com/beforesemicolon/flatlist-react/blob/master/documentation/Doc.md#groupseparatoratthebottom), [groupReversed](https://github.com/beforesemicolon/flatlist-react/blob/master/documentation/Doc.md#groupreversed), [groupSorted](https://github.com/beforesemicolon/flatlist-react/blob/master/documentation/Doc.md#groupsorted), [groupSortedBy](https://github.com/beforesemicolon/flatlist-react/blob/master/documentation/Doc.md#groupsortedby), [groupSortedDescending](https://github.com/beforesemicolon/flatlist-react/blob/master/documentation/Doc.md#groupsorteddescending), [groupSortedCaseInsensitive](https://github.com/beforesemicolon/flatlist-react/blob/master/documentation/Doc.md#groupsortedcaseinsensitive) |
91+
| [Styling](https://github.com/beforesemicolon/flatlist-react/blob/master/documentation/Doc.md#styling) | [displayGrid](https://github.com/beforesemicolon/flatlist-react/blob/master/documentation/Doc.md#displaygrid), [gridGap](https://github.com/beforesemicolon/flatlist-react/blob/master/documentation/Doc.md#gridgap), [minColumnWidth](https://github.com/beforesemicolon/flatlist-react/blob/master/documentation/Doc.md#mincolumnwidth), [displayRow](https://github.com/beforesemicolon/flatlist-react/blob/master/documentation/Doc.md#displayrow), [rowGap](https://github.com/beforesemicolon/flatlist-react/blob/master/documentation/Doc.md#rowgap) |
92+
| [scrollToTop](https://github.com/beforesemicolon/flatlist-react/blob/master/documentation/Doc.md#scrolltotop) |[scrollToTopButton](https://github.com/beforesemicolon/flatlist-react/blob/master/documentation/Doc.md#scrolltotopbutton), [scrollToTopOffset](https://github.com/beforesemicolon/flatlist-react/blob/master/documentation/Doc.md#scrolltotopoffset), [scrollToTopPadding](https://github.com/beforesemicolon/flatlist-react/blob/master/documentation/Doc.md#scrolltotoppadding), [scrollToTopPosition](https://github.com/beforesemicolon/flatlist-react/blob/master/documentation/Doc.md#scrolltotopposition) |

documentation/Doc.md

Lines changed: 13 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -18,16 +18,16 @@ Make sure you are running **react** and **react-dom** version **16.8.0+**.
1818
FlatList has alternative ways to present your props in order to make things easier to change and quicker to specify.
1919

2020
There are available **shorthands props** just in case you want to make batch updates or want to keep things nicely together:
21-
- [`group`](https://github.com/beforesemicolon/flatlist-react/blob/documentation/documentation/Doc.md#grouping)
22-
- [`sort`](https://github.com/beforesemicolon/flatlist-react/blob/documentation/documentation/Doc.md#sorting)
23-
- [`search`](https://github.com/beforesemicolon/flatlist-react/blob/documentation/documentation/Doc.md#searching)
24-
- [`paginate`](https://github.com/beforesemicolon/flatlist-react/blob/documentation/documentation/Doc.md#pagination)
25-
- [`scrollToTop`](https://github.com/beforesemicolon/flatlist-react/blob/documentation/documentation/Doc.md#scrolltotop)
26-
- [`display`](https://github.com/beforesemicolon/flatlist-react/blob/documentation/documentation/Doc.md#styling).
21+
- [`group`](https://github.com/beforesemicolon/flatlist-react/blob/master/documentation/Doc.md#grouping)
22+
- [`sort`](https://github.com/beforesemicolon/flatlist-react/blob/master/documentation/Doc.md#sorting)
23+
- [`search`](https://github.com/beforesemicolon/flatlist-react/blob/master/documentation/Doc.md#searching)
24+
- [`paginate`](https://github.com/beforesemicolon/flatlist-react/blob/master/documentation/Doc.md#pagination)
25+
- [`scrollToTop`](https://github.com/beforesemicolon/flatlist-react/blob/master/documentation/Doc.md#scrolltotop)
26+
- [`display`](https://github.com/beforesemicolon/flatlist-react/blob/master/documentation/Doc.md#styling).
2727

2828
For example:
2929

30-
There are several props for [grouping](https://github.com/beforesemicolon/flatlist-react/blob/documentation/documentation/Doc.md#grouping) but there is also a
30+
There are several props for [grouping](https://github.com/beforesemicolon/flatlist-react/blob/master/documentation/Doc.md#grouping) but there is also a
3131
`group` prop which takes all these props all at once.
3232

3333
```jsx
@@ -119,11 +119,11 @@ FlatList also offers internal components for usage to further help with your lis
119119
### PlainList
120120
`PlainList` is a simpler version of FlatList. It is an ideal option when all you want to do is render a list.
121121
It supports only the following props:
122-
- [list](https://github.com/beforesemicolon/flatlist-react/blob/documentation/documentation/Doc.md#list-and-renderitem)
123-
- [renderItem](https://github.com/beforesemicolon/flatlist-react/blob/documentation/documentation/Doc.md#list-and-renderitem)
124-
- [renderWhenEmpty](https://github.com/beforesemicolon/flatlist-react/blob/documentation/documentation/Doc.md#renderwhenempty)
125-
- [renderOnScroll](https://github.com/beforesemicolon/flatlist-react/blob/documentation/documentation/Doc.md#renderonscroll)
126-
- [wrapperHtmlTag](https://github.com/beforesemicolon/flatlist-react/blob/documentation/documentation/Doc.md#wrapperhtmltag)
122+
- [list](https://github.com/beforesemicolon/flatlist-react/blob/master/documentation/Doc.md#list-and-renderitem)
123+
- [renderItem](https://github.com/beforesemicolon/flatlist-react/blob/master/documentation/Doc.md#list-and-renderitem)
124+
- [renderWhenEmpty](https://github.com/beforesemicolon/flatlist-react/blob/master/documentation/Doc.md#renderwhenempty)
125+
- [renderOnScroll](https://github.com/beforesemicolon/flatlist-react/blob/master/documentation/Doc.md#renderonscroll)
126+
- [wrapperHtmlTag](https://github.com/beforesemicolon/flatlist-react/blob/master/documentation/Doc.md#wrapperhtmltag)
127127

128128
It is the ideal component to render small simple lists like dropDown, selection options or any other
129129
list you dont plan to do anything besides rendering them and leave it.
@@ -320,7 +320,7 @@ The `renderOnScroll` will render your list to fill the container and then stop.
320320
further render the remainder items. This is great if creating a lot of dom elements takes time and you dont want the browser
321321
to become iresponsive while rendering a very large list.
322322

323-
It is different from [pagination(Infinite Scrolling)](https://github.com/beforesemicolon/flatlist-react/blob/documentation/documentation/Doc.md#pagination). With pagination you start with some items and when the user reaches the
323+
It is different from [pagination(Infinite Scrolling)](https://github.com/beforesemicolon/flatlist-react/blob/master/documentation/Doc.md#pagination). With pagination you start with some items and when the user reaches the
324324
end it will fetch some more while showing the loading indicator.
325325

326326
`renderOnScroll` is great for when you have large list and rendering it all at once would take long and freeze the browser.

0 commit comments

Comments
 (0)