index.d.ts 8.7 KB

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