Skip to content

Update 6.0 and 6.2 definitions #69843

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
typescript-bot merged 6 commits into from
Jun 19, 2024
Merged

Update 6.0 and 6.2 definitions #69843

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
8ae47d3
Add 6.0 and 6.2 definitions
Parjak39 Jun 19, 2024
ba7518b
Add tests for rownum and toggle
Parjak39 Jun 19, 2024
a4bb9f0
syntax
Parjak39 Jun 19, 2024
8fe1d01
Rename add-type-definitions to index.d.ts
Parjak39 Jun 19, 2024
37ea672
formatting
Parjak39 Jun 19, 2024
76d93f3
revert deletions
Parjak39 Jun 19, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 14 additions & 1 deletion types/tabulator-tables/index.d.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1315,7 +1315,7 @@ export interface ColumnDefinition extends ColumnLayout, CellCallbacks {
*
* You can set accessors on a per column basis using the accessor option in the column definition object.
*/
accessor?: CustomAccessor | undefined;
accessor?: CustomAccessor | undefined | "rownum";

/** Each accessor function has its own matching params option, for example accessorDownload has accessorDownloadParams. */
accessorParams?: CustomAccessorParams | undefined;
Expand Down Expand Up @@ -1648,6 +1648,7 @@ export type Formatter =
| "handle"
| "rowSelection"
| "responsiveCollapse"
| "toggle"
| ((cell: CellComponent, formatterParams: {}, onRendered: EmptyCallback) => string | HTMLElement);

export type FormatterParams =
Expand All @@ -1662,6 +1663,7 @@ export type FormatterParams =
| StarRatingParams
| RowSelectionParams
| JSONRecord
| ToggleSwitchParams
| ((cell: CellComponent) => {});

export type Editor =
Expand Down Expand Up @@ -1780,6 +1782,17 @@ export interface RowSelectionParams {
rowRange?: RowRangeLookup | undefined;
}

export interface ToggleSwitchParams {
size?: number | undefined;
max?: number | undefined;
onValue?: string | number | undefined;
offValue?: string | number | undefined;
onTruthy?: boolean | undefined;
onColor?: string | undefined;
offColor?: string | undefined;
clickable?: boolean | undefined;
}

export interface SharedEditorParams {
elementAttributes?: JSONRecord | undefined;

Expand Down
24 changes: 24 additions & 0 deletions types/tabulator-tables/tabulator-tables-tests.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1718,3 +1718,27 @@ table.on("importError", function(err) {
table.on("importImported", function(data) {
// data - array of row data
});

table = new Tabulator("#example-table", {
columns: [
{
title: "First",
field: "rownum",
formatter: "rownum",
accessor: "rownum",
},
{
title: "Toggle",
field: "toggle",
formatter: "toggle",
editable: false,
formatterParams: {
onValue: "true",
offValue: "false",
onColor: "green",
offColor: "gray",
clickable: true,
},
},
],
});