From 2d7e758a78e933f5045e4a6f1c6d89d3f3d7ced5 Mon Sep 17 00:00:00 2001 From: John Gozde Date: Sat, 16 Mar 2019 11:41:54 -0600 Subject: [PATCH] react-window: update scrollToItem params, docs (1.7.0) --- types/react-window/index.d.ts | 17 +++++++++++------ 1 file changed, 11 insertions(+), 6 deletions(-) diff --git a/types/react-window/index.d.ts b/types/react-window/index.d.ts index 810661d387..eee0b6b8ae 100644 --- a/types/react-window/index.d.ts +++ b/types/react-window/index.d.ts @@ -2,6 +2,7 @@ // Project: https://github.com/bvaughn/react-window/, http://react-window.now.sh // Definitions by: Martynas KadiĊĦa // Alex Guerra +// John Gozde // Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped // TypeScript Version: 2.8 @@ -395,17 +396,19 @@ export class FixedSizeGrid extends Component { * 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 { * 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.