Skip to content

Commit 1a1c931

Browse files
committed
Adapter.clip method documentation
1 parent 26ccc46 commit 1a1c931

File tree

1 file changed

+2
-1
lines changed

1 file changed

+2
-1
lines changed

README.md

+2-1
Original file line numberDiff line numberDiff line change
@@ -176,7 +176,8 @@ Below is the list of invocable methods of the Adapter API.
176176
|[append](https://dhilt.github.io/ngx-ui-scroll/#/adapter#append-prepend)|(items: any | any[], eof?: boolean)|Adds items or single item to the end of the uiScroll dataset. If eof parameter is not set, items will be added and rendered immediately, they will be placed right after the last item in the uiScroll buffer. If eof parameter is set to true, items will be added and rendered only if the end of the dataset is reached; otherwise, these items will be virtualized. |
177177
|[prepend](https://dhilt.github.io/ngx-ui-scroll/#/adapter#append-prepend)|(items: any | any[], bof?: boolean)|Adds items or single item to the beginning of the uiScroll dataset. If bof parameter is not set, items will be added and rendered immediately, they will be placed right before the first item in the uiScroll buffer. If bof parameter is set to true, items will be added and rendered only if the beginning of the dataset is reached; otherwise, these items will be virtualized. |
178178
|[check](https://dhilt.github.io/ngx-ui-scroll/#/adapter#check-size)| |Checks if any of current items changed it's size and runs a procedure to provide internal consistency and new items fetching if needed. |
179-
|[remove](https://dhilt.github.io/ngx-ui-scroll/#/adapter#remove)|(predicate: (item: ItemAdapter) => boolean)|Removes items from current buffer. Predicate is a function to be applied to every item currently in the buffer. Predicate must return boolean value. If predicate's return value is true, the item will be removed. |
179+
|[remove](https://dhilt.github.io/ngx-ui-scroll/#/adapter#remove)|(predicate: (item: ItemAdapter) => boolean)|Removes items from current buffer. Predicate is a function to be applied to every item presently in the buffer. Predicate must return boolean value. If predicate's return value is true, the item will be removed. _Note!_ Current implementation allows to remove only a continuous series of items per call. If you want to remove, say, 5 and 7 items, you should call the remove method twice. Removing a series of items from 5 to 7 could be done in a single call.|
180+
|[clip](https://dhilt.github.io/ngx-ui-scroll/#/adapter#clip)|(options?: {<br>&nbsp;&nbsp;forwardOnly?:&nbsp;boolean,<br>&nbsp;&nbsp;backwardOnly?:&nbsp;boolean<br>})|Removes out-of-viewport items on demand. Passing an options object, the direction in which inveisible items will be clipped could be specified. If no options is passed, clipping will affect both forward and backward directions. |
180181

181182
### Development
182183

0 commit comments

Comments
 (0)