@vonage/vivid-react
Version:
Vivid wrapped for easy React usage & IDE autocomplete support & typescript typings
55 lines (54 loc) • 3.27 kB
TypeScript
import React, { ReactNode, SyntheticEvent } from 'react';
/** VwcDataGrid
* For more info on this Vivid element please visit https://vivid.deno.dev/components/data-grid
* @param {boolean} noTabbing - When true the component will not add itself to the tab queue.
Default is false. **attribute** `no-tabbing`
* @param {GenerateHeaderOptions} generateHeader - Whether the grid should automatically generate a header row and its type **attribute** `generate-header`
* @param {string} gridTemplateColumns - String that gets applied to the css gridTemplateColumns attribute of child rows **attribute** `grid-template-columns`
* @param {object[]} rowsData - The data being displayed in the grid
* @param {ColumnDefinition[] | null} columnDefinitions - The column definitions of the grid
* @param {ViewTemplate} rowItemTemplate - The template to use for the programmatic generation of rows
* @param {ViewTemplate | undefined} cellItemTemplate - The template used to render cells in generated rows.
* @param {ViewTemplate | undefined} headerCellItemTemplate - The template used to render header cells in generated rows.
* @param {number} focusRowIndex - The index of the row that will receive focus the next time the
grid is focused. This value changes as focus moves to different
rows within the grid. Changing this value when focus is already
within the grid moves focus to the specified row.
* @param {number} focusColumnIndex - The index of the column that will receive focus the next time the
grid is focused. This value changes as focus moves to different rows
within the grid. Changing this value when focus is already within
the grid moves focus to the specified column.
* @param {number | undefined} fixedColumns - Number of columns to be fixed when scrolling horizontally **attribute** `fixed-columns`
* @param {string} rowElementTag - Set by the component templates.
* @param {DataGridSelectionMode | undefined} selectionMode - Indicates the selection mode. **attribute** `selection-mode`
* @param {string} VIVID_VERSION - The current version of the Vivid library, which is useful for debugging.
It can be accessed from any Vivid element via `<el>.constructor.VIVID_VERSION`.
* @param {string} componentName - Core component name, without prefix
*/
declare const VwcDataGrid: {
(props: {
children?: ReactNode;
slot?: string | undefined;
id?: string | undefined;
style?: React.CSSProperties | undefined;
ref?: React.RefObject<HTMLDivElement> | ((instance: HTMLDivElement | null) => void) | null | undefined;
onCellClick?: ((event: SyntheticEvent) => void) | undefined;
noTabbing?: boolean | undefined;
generateHeader?: any;
gridTemplateColumns?: string | undefined;
rowsData?: any[] | undefined;
columnDefinitions?: any;
rowItemTemplate?: any;
cellItemTemplate?: any;
headerCellItemTemplate?: any;
focusRowIndex?: number | undefined;
focusColumnIndex?: number | undefined;
fixedColumns?: any;
rowElementTag?: string | undefined;
selectionMode?: any;
VIVID_VERSION?: string | undefined;
componentName?: string | undefined;
}): JSX.Element;
displayName: string;
};
export default VwcDataGrid;