index.d.ts 8.7 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322
  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. multipleSelectRow?: boolean;
  180. onLoadError?: (status) => boolean;
  181. buttonsToolbar?: any;
  182. paginationVAlign?: string;
  183. showColumnsSearch?: boolean;
  184. queryParamsType?: string;
  185. sortOrder?: any;
  186. paginationDetailHAlign?: string;
  187. customSearch?: any;
  188. visibleSearch?: boolean;
  189. showButtonText?: boolean;
  190. sortName?: any;
  191. columns?: BootstrapTableColumn[];
  192. onScrollBody?: () => boolean;
  193. iconsPrefix?: string;
  194. onPostBody?: () => boolean;
  195. search?: boolean;
  196. searchOnEnterKey?: boolean;
  197. searchText?: string;
  198. responseHandler?: (res) => any;
  199. toolbarAlign?: string;
  200. paginationParts?: string[];
  201. cardView?: boolean;
  202. showSearchButton?: boolean;
  203. escape?: boolean;
  204. searchTimeOut?: number;
  205. buttonsAlign?: string;
  206. buttonsOrder?: string[];
  207. detailFormatter?: (index, row) => string;
  208. onDblClickRow?: (item, $element) => boolean;
  209. paginationNextText?: string;
  210. buttonsPrefix?: string;
  211. loadingTemplate?: (loadingMessage) => string;
  212. theadClasses?: string;
  213. onLoadSuccess?: (data) => boolean;
  214. url?: any;
  215. toolbar?: any;
  216. onPostHeader?: () => boolean;
  217. sidePagination?: string;
  218. clickToSelect?: boolean;
  219. virtualScrollItemHeight?: any;
  220. rowAttributes?: (row, index) => {};
  221. dataField?: string;
  222. idField?: string;
  223. onSort?: (name, order) => boolean;
  224. pageNumber?: number;
  225. data?: any[];
  226. totalNotFilteredField?: string;
  227. undefinedText?: string;
  228. onSearch?: (text) => boolean;
  229. onPageChange?: (number, size) => boolean;
  230. paginationUseIntermediate?: boolean;
  231. searchAccentNeutralise?: boolean;
  232. singleSelect?: boolean;
  233. showButtonIcons?: boolean;
  234. showPaginationSwitch?: boolean;
  235. onPreBody?: (data) => boolean;
  236. detailFilter?: (index, row) => boolean;
  237. detailViewByClick?: boolean;
  238. totalField?: string;
  239. contentType?: string;
  240. showColumns?: boolean;
  241. totalNotFiltered?: number;
  242. checkboxHeader?: boolean;
  243. onRefresh?: (params) => boolean;
  244. dataType?: string;
  245. paginationPreText?: string;
  246. showToggle?: boolean;
  247. detailView?: boolean;
  248. serverSort?: boolean;
  249. totalRows?: number;
  250. silentSort?: boolean;
  251. onPostFooter?: () => boolean;
  252. selectItemName?: string;
  253. detailViewIcon?: boolean;
  254. detailViewAlign?: string;
  255. minimumCountColumns?: number;
  256. uniqueId?: any;
  257. onResetView?: () => boolean;
  258. paginationHAlign?: string;
  259. sortClass?: any;
  260. pagination?: boolean;
  261. queryParams?: (params) => any;
  262. paginationSuccessivelySize?: number;
  263. classes?: BootstrapTableClasses;
  264. rememberOrder?: boolean;
  265. paginationPagesBySide?: number;
  266. trimOnSearch?: boolean;
  267. showRefresh?: boolean;
  268. locale?: BootstrapTableLocale;
  269. onCheckAll?: (rows) => boolean;
  270. showFooter?: boolean;
  271. headerStyle?: (column) => {};
  272. maintainMetaData?: boolean;
  273. onRefreshOptions?: (options) => boolean;
  274. showExtendedPagination?: boolean;
  275. smartDisplay?: boolean;
  276. paginationLoop?: boolean;
  277. virtualScroll?: boolean;
  278. sortReset?: boolean;
  279. filterOptions?: {filterAlgorithm: string};
  280. onUncheckAll?: (rows) => boolean;
  281. showSearchClearButton?: boolean;
  282. buttons?: {};
  283. showHeader?: boolean;
  284. onClickCell?: (field, value, row, $element) => boolean;
  285. sortable?: boolean;
  286. icons?: BootstrapTableIcons;
  287. onExpandRow?: (index, row, $detail) => boolean;
  288. buttonsClass?: string;
  289. pageList?: number[];
  290. }
  291. interface JQuery{
  292. bootstrapTable(options: BootstrapTableOptions): JQuery;
  293. bootstrapTable(method: string, ...parameters: any[]): JQuery | any;
  294. }