UNPKG

8.9 kBTypeScriptView Raw
1interface BootstrapTableClasses{
2 buttons: string;
3 buttonsGroup: string;
4 inputGroup: string;
5 buttonsPrefix: string;
6 paginationActive: string;
7 buttonActive: string;
8 dropdownActive: string;
9 pull: string;
10 input: string;
11 dropup: string;
12 buttonsDropdown: string;
13 paginationDropdown: string;
14 inputPrefix: string
15}
16
17// eslint-disable-next-line no-unused-vars
18interface BootstrapTableHtml{
19 searchInput: string;
20 searchButton: string;
21 pagination: string[];
22 pageDropdown: string[];
23 inputGroup: string;
24 toolbarDropdown: string[];
25 icon: string;
26 pageDropdownItem: string;
27 paginationItem: string;
28 toolbarDropdownSeparator: string;
29 dropdownCaret: string;
30 searchClearButton: string;
31 toolbarDropdownItem: string
32}
33
34interface BootstrapTableIcons{
35 toggleOff: string;
36 clearSearch: string;
37 detailOpen: string;
38 search: string;
39 fullscreen: string;
40 columns: string;
41 detailClose: string;
42 refresh: string;
43 paginationSwitchDown: string;
44 paginationSwitchUp: string;
45 toggleOn: string
46}
47
48interface BootstrapTableEvents{
49 'refresh.bs.table': string;
50 'load-error.bs.table': string;
51 'click-row.bs.table': string;
52 'dbl-click-row.bs.table': string;
53 'post-body.bs.table': string;
54 'collapse-row.bs.table': string;
55 'reset-view.bs.table': string;
56 'click-cell.bs.table': string;
57 'check-all.bs.table': string;
58 'post-footer.bs.table': string;
59 'uncheck.bs.table': string;
60 'check-some.bs.table': string;
61 'refresh-options.bs.table': string;
62 'pre-body.bs.table': string;
63 'uncheck-some.bs.table': string;
64 'expand-row.bs.table': string;
65 'all.bs.table': string;
66 'uncheck-all.bs.table': string;
67 'column-switch.bs.table': string;
68 'check.bs.table': string;
69 'search.bs.table': string;
70 'load-success.bs.table': string;
71 'dbl-click-cell.bs.table': string;
72 'page-change.bs.table': string;
73 'post-header.bs.table': string;
74 'toggle.bs.table': string;
75 'sort.bs.table': string;
76 'scroll-body.bs.table': string
77}
78
79interface BootstrapTableColumn{
80 sortName?: any;
81 widthUnit?: string;
82 sorter?: any;
83 searchFormatter?: boolean;
84 titleTooltip?: any;
85 falign?: any;
86 title?: any;
87 align?: any;
88 radio?: boolean;
89 colspan?: any;
90 showSelectTitle?: boolean;
91 rowspan?: any;
92 checkbox?: boolean;
93 halign?: any;
94 switchable?: boolean;
95 class?: any;
96 escape?: boolean;
97 events?: BootstrapTableEvents;
98 order?: string;
99 visible?: boolean;
100 detailFormatter?: any;
101 valign?: any;
102 sortable?: boolean;
103 cellStyle?: any;
104 searchable?: boolean;
105 footerFormatter?: any;
106 formatter?: any;
107 checkboxEnabled?: boolean;
108 field?: any;
109 width?: any;
110 clickToSelect?: boolean;
111 searchHighlightFormatter?: boolean;
112 cardVisible?: boolean
113}
114
115interface BootstrapTableLocale{
116 formatPaginationSwitchDown?: () => string;
117
118 formatColumns?: () => string;
119
120 formatAllRows?: () => string;
121
122 formatLoadingMessage?: () => string;
123
124 formatSRPaginationPreText?: () => string;
125
126 formatPaginationSwitch?: () => string;
127
128 formatDetailPagination?: (totalRows) => string;
129
130 formatNoMatches?: () => string;
131
132 formatSRPaginationNextText?: () => string;
133
134 formatSearch?: () => string;
135
136 formatFullscreen?: () => string;
137
138 formatShowingRows?: (pageFrom, pageTo, totalRows, totalNotFiltered) => string;
139 formatSRPaginationPageText?: (page) => string;
140
141 formatClearSearch?: () => string;
142
143 formatPaginationSwitchUp?: () => string;
144
145 formatToggle?: () => string;
146
147 formatToggleOff?: () => string;
148
149 formatColumnsToggleAll?: () => string;
150
151 formatRefresh?: () => string;
152
153 formatToggleOn?: () => string;
154
155 formatRecordsPerPage(pageNumber): string
156}
157
158interface BootstrapAjaxParams{
159 cache: boolean;
160 data: {
161 search: string;
162 offset: number;
163 limit: number;
164 sort?: any;
165 order?: any
166 };
167 dataType: string;
168 type: string;
169 contentType: string;
170 error: (jqXHR: JQuery.jqXHR) => any;
171 success: (results: any, textStatus?: string, jqXHR?: JQuery.jqXHR) => any;
172}
173
174interface BootstrapTableOptions{
175 onCheck?: (row) => boolean;
176 loadingFontSize?: string;
177 onDblClickCell?: (field, value, row, $element) => boolean;
178 rowStyle?: (row, index) => {};
179 showColumnsToggleAll?: boolean;
180 footerStyle?: (column) => {};
181 onUncheck?: (row) => boolean;
182 pageSize?: number;
183 footerField?: string;
184 showFullscreen?: boolean;
185 sortStable?: boolean;
186 searchAlign?: string;
187 ajax?: (params: BootstrapAjaxParams) => any;
188 onAll?: (name, args) => boolean;
189 onClickRow?: (item, $element) => boolean;
190 ajaxOptions?: {};
191 onCheckSome?: (rows) => boolean;
192 customSort?: any;
193 iconSize?: any;
194 onCollapseRow?: (index, row) => boolean;
195 searchHighlight?: boolean;
196 height?: any;
197 onUncheckSome?: (rows) => boolean;
198 onToggle?: (cardView) => boolean;
199 ignoreClickToSelectOn?: ({tagName}?: {tagName: any}) => any;
200 cache?: boolean;
201 method?: string;
202 onColumnSwitch?: (field, checked) => boolean;
203 searchSelector?: boolean;
204 strictSearch?: boolean;
205 multipleSelectRow?: boolean;
206 onLoadError?: (status) => boolean;
207 buttonsToolbar?: any;
208 paginationVAlign?: string;
209 showColumnsSearch?: boolean;
210 queryParamsType?: string;
211 sortOrder?: any;
212 paginationDetailHAlign?: string;
213 customSearch?: any;
214 visibleSearch?: boolean;
215 showButtonText?: boolean;
216 sortName?: any;
217 columns?: BootstrapTableColumn[];
218 onScrollBody?: () => boolean;
219 iconsPrefix?: string;
220 onPostBody?: () => boolean;
221 search?: boolean;
222 searchOnEnterKey?: boolean;
223 searchText?: string;
224 responseHandler?: (res) => any;
225 toolbarAlign?: string;
226 paginationParts?: string[];
227 cardView?: boolean;
228 showSearchButton?: boolean;
229 escape?: boolean;
230 searchTimeOut?: number;
231 buttonsAlign?: string;
232 buttonsOrder?: string[];
233 detailFormatter?: (index, row) => string;
234 onDblClickRow?: (item, $element) => boolean;
235 paginationNextText?: string;
236 buttonsPrefix?: string;
237 loadingTemplate?: (loadingMessage) => string;
238 theadClasses?: string;
239 onLoadSuccess?: (data) => boolean;
240 url?: any;
241 toolbar?: any;
242 onPostHeader?: () => boolean;
243 sidePagination?: string;
244 clickToSelect?: boolean;
245 virtualScrollItemHeight?: any;
246 rowAttributes?: (row, index) => {};
247 dataField?: string;
248 idField?: string;
249 onSort?: (name, order) => boolean;
250 pageNumber?: number;
251 data?: any[];
252 totalNotFilteredField?: string;
253 undefinedText?: string;
254 onSearch?: (text) => boolean;
255 onPageChange?: (number, size) => boolean;
256 paginationUseIntermediate?: boolean;
257 searchAccentNeutralise?: boolean;
258 singleSelect?: boolean;
259 showButtonIcons?: boolean;
260 showPaginationSwitch?: boolean;
261 onPreBody?: (data) => boolean;
262 detailFilter?: (index, row) => boolean;
263 detailViewByClick?: boolean;
264 totalField?: string;
265 contentType?: string;
266 showColumns?: boolean;
267 totalNotFiltered?: number;
268 checkboxHeader?: boolean;
269 onRefresh?: (params) => boolean;
270 dataType?: string;
271 paginationPreText?: string;
272 showToggle?: boolean;
273 detailView?: boolean;
274 serverSort?: boolean;
275 totalRows?: number;
276 silentSort?: boolean;
277 onPostFooter?: () => boolean;
278 selectItemName?: string;
279 detailViewIcon?: boolean;
280 detailViewAlign?: string;
281 minimumCountColumns?: number;
282 uniqueId?: any;
283 onResetView?: () => boolean;
284 paginationHAlign?: string;
285 sortClass?: any;
286 pagination?: boolean;
287 queryParams?: (params) => any;
288 paginationSuccessivelySize?: number;
289 classes?: BootstrapTableClasses;
290 rememberOrder?: boolean;
291 paginationPagesBySide?: number;
292 trimOnSearch?: boolean;
293 showRefresh?: boolean;
294 locale?: BootstrapTableLocale;
295 onCheckAll?: (rows) => boolean;
296 showFooter?: boolean;
297 headerStyle?: (column) => {};
298 maintainMetaData?: boolean;
299 onRefreshOptions?: (options) => boolean;
300 showExtendedPagination?: boolean;
301 smartDisplay?: boolean;
302 paginationLoop?: boolean;
303 virtualScroll?: boolean;
304 sortReset?: boolean;
305 filterOptions?: {filterAlgorithm: string};
306 onUncheckAll?: (rows) => boolean;
307 showSearchClearButton?: boolean;
308 buttons?: {};
309 showHeader?: boolean;
310 onClickCell?: (field, value, row, $element) => boolean;
311 sortable?: boolean;
312 icons?: BootstrapTableIcons;
313 onExpandRow?: (index, row, $detail) => boolean;
314 buttonsClass?: string;
315 pageList?: number[];
316}
317
318interface JQuery{
319 bootstrapTable(options: BootstrapTableOptions): JQuery;
320
321 bootstrapTable(method: string, ...parameters: any[]): JQuery | any;
322}