vhad/DefinitelyTyped
1
0
Fork 0
mirror of https://github.com/gosticks/DefinitelyTyped.git synced 2026-10-05 23:37:04 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

react-window: update scrollToItem params, docs (1.7.0)

Browse Source
This commit is contained in:
John Gozde
2019-03-16 11:41:54 -06:00
parent e51e5044b8
commit 2d7e758a78
1 changed files with 11 additions and 6 deletions
Download Patch File Download Diff File Expand all files Collapse all files
types/react-window/index.d.ts
Vendored
+11 -6
View File
@@ -2,6 +2,7 @@
// Project: https://github.com/bvaughn/react-window/, http://react-window.now.sh
// Definitions by: Martynas Kadiša <https://github.com/martynaskadisa>
// Alex Guerra <https://github.com/heyimalex>
// John Gozde <https://github.com/jgoz>
// Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped
// TypeScript Version: 2.8
@@ -395,17 +396,19 @@ export class FixedSizeGrid extends Component<FixedSizeGridProps> {
* Scroll to the specified item.
*
* By default, the Grid will scroll as little as possible to ensure the item is visible.
* You can control the alignment of the item though by specifying a second alignment parameter. Acceptable values are:
* You can control the alignment of the item though by specifying an `align` property. Acceptable values are:
*
* - auto (default) - Scroll as little as possible to ensure the item is visible. (If the item is already visible, it won't scroll at all.)
* - center - Center align the item within the grid.
* - end - Align the item to the bottom, right hand side of the grid.
* - start - Align the item to the top, left hand of the grid.
*
* If either `columnIndex` or `rowIndex` are omitted, `scrollLeft` or `scrollTop` will be unchanged (respectively).
*/
scrollToItem(params: {
align?: Align;
columnIndex: number;
rowIndex: number;
columnIndex?: number;
rowIndex?: number;
}): void;
}
@@ -418,17 +421,19 @@ export class VariableSizeGrid extends Component<VariableSizeGridProps> {
* Scroll to the specified item.
*
* By default, the Grid will scroll as little as possible to ensure the item is visible.
* You can control the alignment of the item though by specifying a second alignment parameter. Acceptable values are:
* You can control the alignment of the item though by specifying an `align` property. Acceptable values are:
*
* - auto (default) - Scroll as little as possible to ensure the item is visible. (If the item is already visible, it won't scroll at all.)
* - center - Center align the item within the grid.
* - end - Align the item to the bottom, right hand side of the grid.
* - start - Align the item to the top, left hand of the grid.
*
* If either `columnIndex` or `rowIndex` are omitted, `scrollLeft` or `scrollTop` will be unchanged (respectively).
*/
scrollToItem(params: {
align?: Align;
columnIndex: number;
rowIndex: number;
columnIndex?: number;
rowIndex?: number;
}): void;
/**
* VariableSizeGrid caches offsets and measurements for each column index for performance purposes.