mirror of
https://github.com/wassname/DefinitelyTyped.git
synced 2026-09-09 11:13:57 +08:00
Merge branch 'master' into rename-repo-url
This commit is contained in:
+2
-2
@@ -5,7 +5,7 @@
|
||||
|
||||
/// <reference path="../react/react.d.ts"/>
|
||||
|
||||
declare module FixedDataTable {
|
||||
declare namespace FixedDataTable {
|
||||
export var version: string;
|
||||
|
||||
export interface TableProps extends __React.Props<Table> {
|
||||
@@ -394,6 +394,6 @@ declare module FixedDataTable {
|
||||
}
|
||||
}
|
||||
|
||||
declare module "fixed-data-table" {
|
||||
declare module "fixed-data-table" {
|
||||
export = FixedDataTable;
|
||||
}
|
||||
|
||||
+78
-78
@@ -5,15 +5,15 @@
|
||||
|
||||
/// <reference path="../react/react.d.ts"/>
|
||||
|
||||
declare module FixedDataTable {
|
||||
declare namespace FixedDataTable {
|
||||
export var version: string;
|
||||
|
||||
/**
|
||||
* Data grid component with fixed or scrollable header and columns.
|
||||
*
|
||||
* The layout of the data table is as follows:
|
||||
*
|
||||
*
|
||||
*
|
||||
*
|
||||
* +---------------------------------------------------+
|
||||
* | Fixed Column Group | Scrollable Column Group |
|
||||
* | Header | Header |
|
||||
@@ -31,38 +31,38 @@ declare module FixedDataTable {
|
||||
* | Fixed Footer Columns | Scrollable Footer Columns |
|
||||
* | | |
|
||||
* +-----------------------+---------------------------+
|
||||
*
|
||||
*
|
||||
* Fixed Column Group Header:
|
||||
*
|
||||
*
|
||||
* These are the headers for a group of columns if included in
|
||||
* the table that do not scroll vertically or horizontally.
|
||||
*
|
||||
*
|
||||
* Scrollable Column Group Header:
|
||||
*
|
||||
*
|
||||
* The header for a group of columns that do not move while
|
||||
* scrolling vertically, but move horizontally with the
|
||||
* horizontal scrolling.
|
||||
*
|
||||
*
|
||||
* Fixed Header Columns:
|
||||
*
|
||||
* The header columns that do not move while scrolling
|
||||
*
|
||||
* The header columns that do not move while scrolling
|
||||
* vertically or horizontally.
|
||||
*
|
||||
*
|
||||
* Scrollable Header Columns:
|
||||
*
|
||||
*
|
||||
* The header columns that do not move while scrolling
|
||||
* vertically, but move horizontally with the horizontal scrolling.
|
||||
*
|
||||
*
|
||||
* Fixed Body Columns:
|
||||
*
|
||||
*
|
||||
* The body columns that do not move while scrolling
|
||||
* horizontally, but move vertically with the vertical scrolling.
|
||||
*
|
||||
*
|
||||
* Scrollable Body Columns:
|
||||
*
|
||||
*
|
||||
* The body columns that move while scrolling vertically or
|
||||
* horizontally.
|
||||
*
|
||||
*
|
||||
*/
|
||||
export interface TableProps extends __React.Props<Table> {
|
||||
/**
|
||||
@@ -70,23 +70,23 @@ declare module FixedDataTable {
|
||||
* horizontal scrollbar will appear.
|
||||
*/
|
||||
width: number;
|
||||
|
||||
|
||||
/**
|
||||
* Pixel height of table. If all rows do not fit, a
|
||||
* Pixel height of table. If all rows do not fit, a
|
||||
* vertical scrollbar will appear.
|
||||
*
|
||||
*
|
||||
* Either height or maxHeight must be specified.
|
||||
*/
|
||||
*/
|
||||
height?: number;
|
||||
|
||||
/**
|
||||
* Maximum pixel height of table. If all rows do not fit,
|
||||
* a vertical scrollbar will appear.
|
||||
*
|
||||
*
|
||||
* Either height or maxHeight must be specified.
|
||||
*/
|
||||
maxHeight?: number;
|
||||
|
||||
|
||||
/**
|
||||
* Pixel height of table's owner, this is used in a managed
|
||||
* scrolling situation when you want to slide the table up
|
||||
@@ -99,7 +99,7 @@ declare module FixedDataTable {
|
||||
* over-flowing height of table. It allows us to avoid
|
||||
* resizing and reflowing table when it is moving in the
|
||||
* view.
|
||||
*
|
||||
*
|
||||
* This is used if ownerHeight < height (or maxHeight).
|
||||
*/
|
||||
ownerHeight?: number;
|
||||
@@ -108,7 +108,7 @@ declare module FixedDataTable {
|
||||
* 'hidden'|'auto'
|
||||
*/
|
||||
overflowX?: string;
|
||||
|
||||
|
||||
/**
|
||||
* 'hidden'|'auto'
|
||||
*/
|
||||
@@ -124,14 +124,14 @@ declare module FixedDataTable {
|
||||
* and returns different value.
|
||||
*/
|
||||
rowHeight: number;
|
||||
|
||||
|
||||
/**
|
||||
* If specified, rowHeightGetter(index) is called for each
|
||||
* row and the returned value overrides rowHeight for
|
||||
* particular row.
|
||||
*/
|
||||
rowHeightGetter?: (index: number) => number;
|
||||
|
||||
|
||||
/**
|
||||
* To get any additional CSS classes that should be added to
|
||||
* a row, rowClassNameGetter(index) is called.
|
||||
@@ -140,61 +140,61 @@ declare module FixedDataTable {
|
||||
|
||||
/**
|
||||
* Pixel height of the column group header.
|
||||
*
|
||||
*
|
||||
* defaultValue: 0
|
||||
*/
|
||||
groupHeaderHeight?: number;
|
||||
|
||||
/**
|
||||
* Pixel height of the header.
|
||||
*
|
||||
*
|
||||
* defaultValue: 0
|
||||
*/
|
||||
headerHeight?: number;
|
||||
|
||||
/**
|
||||
* Pixel height of the footer.
|
||||
*
|
||||
*
|
||||
* defaultValue: 0
|
||||
*/
|
||||
footerHeight?: number;
|
||||
|
||||
|
||||
/**
|
||||
* Value of horizontal scroll.
|
||||
*
|
||||
*
|
||||
* defaultValue: 0
|
||||
*/
|
||||
scrollLeft?: number;
|
||||
|
||||
|
||||
/**
|
||||
* Index of column to scroll to.
|
||||
*/
|
||||
scrollToColumn?: number;
|
||||
|
||||
|
||||
/**
|
||||
* Value of vertical scroll.
|
||||
*
|
||||
*
|
||||
* defaultValue: 0
|
||||
*/
|
||||
scrollTop?: number;
|
||||
|
||||
|
||||
/**
|
||||
* Index of row to scroll to.
|
||||
*/
|
||||
scrollToRow?: number;
|
||||
|
||||
|
||||
/**
|
||||
* Callback that is called when scrolling starts with
|
||||
* current horizontal and vertical scroll values.
|
||||
*/
|
||||
onScrollStart?: (x: number, y: number) => void;
|
||||
|
||||
|
||||
/**
|
||||
* Callback that is called when scrolling ends or stops with
|
||||
* new horizontal and vertical scroll values.
|
||||
*/
|
||||
onScrollEnd?: (x: number, y: number) => void;
|
||||
|
||||
|
||||
/**
|
||||
* Callback that is called when rowHeightGetter returns a
|
||||
* different height for a row than the rowHeight prop. This
|
||||
@@ -202,44 +202,44 @@ declare module FixedDataTable {
|
||||
* of some parts of the content.
|
||||
*/
|
||||
onContentHeightChange?: (newHeight: number) => void;
|
||||
|
||||
|
||||
/**
|
||||
* Callback that is called when a row is clicked.
|
||||
*/
|
||||
onRowClick?: (event: __React.SyntheticEvent, rowIndex: number) => void;
|
||||
|
||||
|
||||
/**
|
||||
* Callback that is called when a row is double clicked.
|
||||
*/
|
||||
onRowDoubleClick?: (event: __React.SyntheticEvent, rowIndex: number) => void;
|
||||
|
||||
|
||||
/**
|
||||
* Callback that is called when a mouse-down event happens
|
||||
* on a row.
|
||||
*/
|
||||
onRowMouseDown?: (event: __React.SyntheticEvent, rowIndex: number) => void;
|
||||
|
||||
|
||||
/**
|
||||
* Callback that is called when a mouse-enter event happens
|
||||
* on a row.
|
||||
*/
|
||||
onRowMouseEnter?: (event: __React.SyntheticEvent, rowIndex: number) => void;
|
||||
|
||||
|
||||
/**
|
||||
* Callback that is called when a mouse-leave event happens
|
||||
* on a row.
|
||||
*/
|
||||
onRowMouseLeave?: (event: __React.SyntheticEvent, rowIndex: number) => void;
|
||||
|
||||
|
||||
/**
|
||||
* Callback that is called when resizer has been released
|
||||
* and column needs to be updated.
|
||||
*
|
||||
*
|
||||
* Required if the isResizable property is true on any
|
||||
* column.
|
||||
*/
|
||||
onColumnResizeEndCallback?: (newColumnWidth: number, columnKey: string) => void;
|
||||
|
||||
|
||||
/**
|
||||
* Whether a column is currently being resized.
|
||||
*/
|
||||
@@ -252,7 +252,7 @@ declare module FixedDataTable {
|
||||
interface ColumnProps extends __React.Props<Column> {
|
||||
/**
|
||||
* The horizontal alignment of the table cell content.
|
||||
*
|
||||
*
|
||||
* 'left'|'center'|'right'
|
||||
*/
|
||||
align?: string;
|
||||
@@ -260,7 +260,7 @@ declare module FixedDataTable {
|
||||
/**
|
||||
* Controls if the column is fixed when scrolling in the X
|
||||
* axis.
|
||||
*
|
||||
*
|
||||
* defaultValue: false
|
||||
*/
|
||||
fixed?: boolean;
|
||||
@@ -272,20 +272,20 @@ declare module FixedDataTable {
|
||||
* header cell with that string. By default, the React
|
||||
* element passed in can expect to receive the following
|
||||
* props:
|
||||
*
|
||||
*
|
||||
* props: {
|
||||
* columnKey: string // (of the column, if given)
|
||||
* height: number // (supplied from the Table or rowHeightGetter)
|
||||
* width: number // (supplied from the Column)
|
||||
* }
|
||||
*
|
||||
*
|
||||
* Because you are passing in your own React element, you
|
||||
* can feel free to pass in whatever props you may want or need.
|
||||
*
|
||||
*
|
||||
* If you pass in a function, you will receive the same props object as the first argument.
|
||||
*/
|
||||
header?: string | __React.ReactElement<any> | ((props: CellProps) => (string | __React.ReactElement<any>));
|
||||
|
||||
|
||||
/**
|
||||
* This is the body cell that will be cloned for this
|
||||
* column. This can either be a string a React element,
|
||||
@@ -293,23 +293,23 @@ declare module FixedDataTable {
|
||||
* in a string will render a default cell with that
|
||||
* string. By default, the React element passed in can
|
||||
* expect to receive the following props:
|
||||
*
|
||||
*
|
||||
* props: {
|
||||
* rowIndex; number // (the row index of the cell)
|
||||
* columnKey: string // (of the column, if given)
|
||||
* height: number // (supplied from the Table or rowHeightGetter)
|
||||
* width: number // (supplied from the Column)
|
||||
* }
|
||||
*
|
||||
*
|
||||
* Because you are passing in your own React element, you
|
||||
* can feel free to pass in whatever props you may want or
|
||||
* need.
|
||||
*
|
||||
*
|
||||
* If you pass in a function, you will receive the same
|
||||
* props object as the first argument.
|
||||
*/
|
||||
cell?: string | __React.ReactElement<any> | ((props: CellProps) => (string | __React.ReactElement<any>));
|
||||
|
||||
|
||||
/**
|
||||
* The footer cell for this column. This can either be a
|
||||
* string. a React element, or a function that generates a
|
||||
@@ -317,17 +317,17 @@ declare module FixedDataTable {
|
||||
* header cell with that string. By default, the React
|
||||
* element passed in can expect to receive the following
|
||||
* props:
|
||||
*
|
||||
*
|
||||
* props: {
|
||||
* columnKey: string // (of the column, if given)
|
||||
* height: number // (supplied from the Table or rowHeightGetter)
|
||||
* width: number // (supplied from the Column)
|
||||
* }
|
||||
*
|
||||
*
|
||||
* Because you are passing in your own React element, you
|
||||
* can feel free to pass in whatever props you may want or
|
||||
* need.
|
||||
*
|
||||
*
|
||||
* If you pass in a function, you will receive the same
|
||||
* props object as the first argument.
|
||||
*/
|
||||
@@ -349,7 +349,7 @@ declare module FixedDataTable {
|
||||
* If this is a resizable column this is its minimum pixel
|
||||
* width.
|
||||
*/
|
||||
minWidth?: number;
|
||||
minWidth?: number;
|
||||
|
||||
/**
|
||||
* If this is a resizable column this is its maximum pixel
|
||||
@@ -364,22 +364,22 @@ declare module FixedDataTable {
|
||||
* it proportionally according to all columns' flexGrow
|
||||
* values. Defaults to zero (no-flexing).
|
||||
*/
|
||||
flexGrow?: number;
|
||||
flexGrow?: number;
|
||||
|
||||
/**
|
||||
* Whether the column can be resized with the
|
||||
* FixedDataTableColumnResizeHandle. Please note that if a
|
||||
* column has a flex grow, once you resize the column this
|
||||
* will be set to 0.
|
||||
*
|
||||
*
|
||||
* This property only provides the UI for the column
|
||||
* resizing. If this is set to true, you will need to set the
|
||||
* onColumnResizeEndCallback table property and render your
|
||||
* columns appropriately.
|
||||
* columns appropriately.
|
||||
*/
|
||||
isResizable?: boolean;
|
||||
isResizable?: boolean;
|
||||
|
||||
/**
|
||||
/**
|
||||
* Whether cells in this column can be removed from document
|
||||
* when outside of viewport as a result of horizontal
|
||||
* scrolling. Setting this property to true allows the table
|
||||
@@ -389,12 +389,12 @@ declare module FixedDataTable {
|
||||
* performance drop. Setting the property to false will keep
|
||||
* previous behaviour and keep cell rendered if the row it
|
||||
* belongs to is visible.
|
||||
*
|
||||
*
|
||||
* defaultValue: false
|
||||
*/
|
||||
allowCellsRecycling?: boolean;
|
||||
}
|
||||
|
||||
|
||||
/**
|
||||
* Component that defines the attributes of a table column group.
|
||||
*/
|
||||
@@ -408,7 +408,7 @@ declare module FixedDataTable {
|
||||
/**
|
||||
* Controls if the column group is fixed when scrolling in the X
|
||||
* axis.
|
||||
*
|
||||
*
|
||||
* defaultValue: false
|
||||
*/
|
||||
fixed?: boolean;
|
||||
@@ -420,30 +420,30 @@ declare module FixedDataTable {
|
||||
* header cell with that string. By default, the React
|
||||
* element passed in can expect to receive the following
|
||||
* props:
|
||||
*
|
||||
*
|
||||
* props: {
|
||||
* height: number // (supplied from the groupHeaderHeight)
|
||||
* width: number // (supplied from the Column)
|
||||
* }
|
||||
*
|
||||
*
|
||||
* Because you are passing in your own React element, you
|
||||
* can feel free to pass in whatever props you may want or
|
||||
* need.
|
||||
*
|
||||
*
|
||||
* If you pass in a function, you will receive the same props
|
||||
* object as the first argument.
|
||||
*/
|
||||
header: string | __React.ReactElement<any> | ((props: CellProps) => (string | __React.ReactElement<any>));
|
||||
}
|
||||
|
||||
|
||||
/**
|
||||
* Component that handles default cell layout and styling.
|
||||
*
|
||||
* All props unless specified below will be set onto the top
|
||||
*
|
||||
* All props unless specified below will be set onto the top
|
||||
* level div rendered by the cell.
|
||||
*
|
||||
*
|
||||
* Example usage via from a Column:
|
||||
*
|
||||
*
|
||||
* const MyColumn = (
|
||||
* <Column
|
||||
* cell={({rowIndex, width, height}) => (
|
||||
@@ -492,6 +492,6 @@ declare module FixedDataTable {
|
||||
}
|
||||
}
|
||||
|
||||
declare module "fixed-data-table" {
|
||||
declare module "fixed-data-table" {
|
||||
export = FixedDataTable;
|
||||
}
|
||||
|
||||
Reference in New Issue
Block a user