index.html 24 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660
  1. <!doctype html>
  2. <html lang="en">
  3. <head>
  4. <meta charset="utf-8">
  5. <meta name="viewport" content="width=device-width, initial-scale=1, shrink-to-fit=no">
  6. <meta name="description" content="Table Reorder Rows extension of Bootstrap Table.">
  7. <meta name="author" content="Zhixin Wen, and Bootstrap Table contributors">
  8. <meta name="generator" content="Jekyll v3.8.7">
  9. <meta name="keywords" content="bootstrap,table,pagination,checkbox,radio,datatables,css,css-framework,semantic,semantic-ui,bulma,material,material-design,materialize,foundation">
  10. <meta name="docsearch:language" content="en">
  11. <title>Table Reorder Rows · Bootstrap Table</title>
  12. <link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/bootstrap@4.6.2/dist/css/bootstrap.min.css"><!-- Documentation extras -->
  13. <link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/docsearch.js@2/dist/cdn/docsearch.min.css">
  14. <link rel="stylesheet" href="/assets/css/docs.min.css">
  15. <link rel="stylesheet" href="/assets/css/style.css?m=9">
  16. <!-- Favicons -->
  17. <link rel="icon" href="/favicon.png">
  18. <script type="text/javascript">
  19. if (window !== top) // 判断当前的 window 对象是否是 top 对象
  20. top.location.href = window.location.href // 如果不是,将 top 对象的网址自动导向被嵌入网页的网址
  21. </script>
  22. </head>
  23. <body>
  24. <a class="skippy sr-only sr-only-focusable" href="#content">
  25. <span class="skippy-text">Skip to main content</span>
  26. </a>
  27. <header class="navbar navbar-expand navbar-dark flex-column flex-md-row bd-navbar">
  28. <a class="navbar-brand mr-0 mr-md-2" href="/" aria-label="Bootstrap">
  29. <img src="/favicon.png" width="36" height="36">
  30. </a>
  31. <div class="navbar-nav-scroll">
  32. <ul class="navbar-nav bd-navbar-nav flex-row">
  33. <li class="nav-item">
  34. <a class="nav-link "
  35. href="/">Home</a>
  36. </li>
  37. <li class="nav-item">
  38. <a class="nav-link active"
  39. href="/docs/getting-started/introduction/">
  40. Documentation
  41. </a>
  42. </li>
  43. <li class="nav-item ">
  44. <a class="nav-link" href="/themes">
  45. Themes
  46. </a>
  47. </li>
  48. <li class="nav-item">
  49. <a class="nav-link "
  50. href="https://examples.bootstrap-table.com">
  51. Examples
  52. </a>
  53. </li>
  54. <li class="nav-item">
  55. <a class="nav-link"
  56. href="https://live.bootstrap-table.com"
  57. target="_blank">
  58. Online Editor
  59. </a>
  60. </li>
  61. <li class="nav-item ">
  62. <a class="nav-link" href="/news">
  63. News
  64. </a>
  65. </li>
  66. <li class="nav-item">
  67. <a class="nav-link"
  68. href="https://blog.bootstrap-table.com"
  69. target="_blank">
  70. Blog
  71. </a>
  72. </li>
  73. </ul>
  74. </div>
  75. <ul class="navbar-nav flex-row ml-md-auto d-none d-md-flex">
  76. <li class="nav-item dropdown">
  77. <a class="nav-item nav-link dropdown-toggle mr-md-2" href="#" id="bd-versions" data-toggle="dropdown" aria-haspopup="true" aria-expanded="false">
  78. v1.23.5
  79. </a>
  80. <div class="dropdown-menu dropdown-menu-md-right" aria-labelledby="bd-versions">
  81. <a class="dropdown-item active" href="/">Latest (1.23.5)</a>
  82. <a class="dropdown-item" href="http://bootstrap-table.com/versions/1.21.4/" target="_blank">v1.21.4</a>
  83. <a class="dropdown-item" href="http://bootstrap-table.com/versions/1.20.2/" target="_blank">v1.20.2</a>
  84. <a class="dropdown-item" href="http://bootstrap-table.com/versions/1.19.1/" target="_blank">v1.19.1</a>
  85. <a class="dropdown-item" href="http://bootstrap-table.com/versions/1.18.3/" target="_blank">v1.18.3</a>
  86. <a class="dropdown-item" href="http://bootstrap-table.com/versions/1.17.1/" target="_blank">v1.17.1</a>
  87. <a class="dropdown-item" href="http://bootstrap-table.com/versions/1.16.0/" target="_blank">v1.16.0</a>
  88. <a class="dropdown-item" href="http://bootstrap-table.com/versions/1.15.5/" target="_blank">v1.15.5</a>
  89. </div>
  90. </li>
  91. <li class="nav-item">
  92. <a class="nav-link p-2" href="https://github.com/wenzhixin/bootstrap-table" target="_blank" rel="noopener" aria-label="GitHub"><svg class="navbar-nav-svg" xmlns="http://www.w3.org/2000/svg" viewbox="0 0 512 499.36" focusable="false" role="img"><path d="M256 0C114.64 0 0 114.61 0 256c0 113.09 73.34 209 175.08 242.9 12.8 2.35 17.47-5.56 17.47-12.34 0-6.08-.22-22.18-.35-43.54-71.2 15.49-86.2-34.34-86.2-34.34-11.64-29.57-28.42-37.45-28.42-37.45-23.27-15.84 1.73-15.55 1.73-15.55 25.69 1.81 39.21 26.38 39.21 26.38 22.84 39.12 59.92 27.82 74.5 21.27 2.33-16.54 8.94-27.82 16.25-34.22-56.84-6.43-116.6-28.43-116.6-126.49 0-27.95 10-50.8 26.35-68.69-2.63-6.48-11.42-32.5 2.51-67.75 0 0 21.49-6.88 70.4 26.24a242.65 242.65 0 0 1 128.18 0c48.87-33.13 70.33-26.24 70.33-26.24 14 35.25 5.18 61.27 2.55 67.75 16.41 17.9 26.31 40.75 26.31 68.69 0 98.35-59.85 120-116.88 126.32 9.19 7.9 17.38 23.53 17.38 47.41 0 34.22-.31 61.83-.31 70.23 0 6.85 4.61 14.81 17.6 12.31C438.72 464.97 512 369.08 512 256.02 512 114.62 397.37 0 256 0z" fill="currentColor" fill-rule="evenodd"/></svg>
  93. </a>
  94. </li>
  95. <li class="nav-item">
  96. <a class="nav-link p-2" href="https://twitter.com/wenzhixin2010" target="_blank" rel="noopener" aria-label="Twitter"><svg class="navbar-nav-svg" xmlns="http://www.w3.org/2000/svg" viewbox="0 0 512 416.32" focusable="false" role="img"><path d="M160.83 416.32c193.2 0 298.92-160.22 298.92-298.92 0-4.51 0-9-.2-13.52A214 214 0 0 0 512 49.38a212.93 212.93 0 0 1-60.44 16.6 105.7 105.7 0 0 0 46.3-58.19 209 209 0 0 1-66.79 25.37 105.09 105.09 0 0 0-181.73 71.91 116.12 116.12 0 0 0 2.66 24c-87.28-4.3-164.73-46.3-216.56-109.82A105.48 105.48 0 0 0 68 159.6a106.27 106.27 0 0 1-47.53-13.11v1.43a105.28 105.28 0 0 0 84.21 103.06 105.67 105.67 0 0 1-47.33 1.84 105.06 105.06 0 0 0 98.14 72.94A210.72 210.72 0 0 1 25 370.84a202.17 202.17 0 0 1-25-1.43 298.85 298.85 0 0 0 160.83 46.92" fill="currentColor"/></svg>
  97. </a>
  98. </li>
  99. <li class="nav-item">
  100. <a class="nav-link p-2" href="https://opencollective.com/bootstrap-table" target="_blank" rel="noopener" aria-label="Open Collective"><svg class="navbar-nav-svg" xmlns="http://www.w3.org/2000/svg" viewbox="0 0 40 41" focusable="false" role="img" fill="currentColor" fill-rule="evenodd"><title>Open Collective</title><path d="M32.8 21c0 2.4-.8 4.9-2 6.9l5.1 5.1c2.5-3.4 4.1-7.6 4.1-12 0-4.6-1.6-8.8-4-12.2L30.7 14c1.2 2 2 4.3 2 7z" fill-opacity=".4"/><path d="M20 33.7a12.8 12.8 0 0 1 0-25.6c2.6 0 5 .7 7 2.1L32 5a20 20 0 1 0 .1 31.9l-5-5.2a13 13 0 0 1-7 2z"/></svg>
  101. </a>
  102. </li>
  103. </ul>
  104. <a class="btn btn-bd-download d-none d-lg-inline-block mb-3 mb-md-0 ml-md-3"
  105. href="/docs/getting-started/download/">Download</a>
  106. </header>
  107. <div class="container-fluid">
  108. <div class="row flex-xl-nowrap">
  109. <div class="col-12 col-md-3 col-xl-2 bd-sidebar">
  110. <form class="bd-search d-flex align-items-center">
  111. <input type="search" class="form-control"
  112. id="search-input" placeholder="Search..."
  113. aria-label="Search for..." autocomplete="off">
  114. <button class="btn btn-link bd-search-docs-toggle d-md-none p-0 ml-3"
  115. type="button" data-toggle="collapse" data-target="#bd-docs-nav"
  116. aria-controls="bd-docs-nav" aria-expanded="false"
  117. aria-label="Toggle docs navigation"><svg xmlns="http://www.w3.org/2000/svg" viewbox="0 0 30 30" width="30" height="30" focusable="false" role="img"><title>Menu</title><path stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-miterlimit="10" d="M4 7h22M4 15h22M4 23h22"/></svg>
  118. </button>
  119. </form>
  120. <nav class="collapse bd-links" id="bd-docs-nav"><div class="bd-toc-item">
  121. <a class="bd-toc-link" href="/docs/getting-started/introduction/">
  122. Getting started
  123. </a>
  124. <ul class="nav bd-sidenav"><li>
  125. <a href="/docs/getting-started/introduction/">
  126. Introduction
  127. </a>
  128. </li><li>
  129. <a href="/docs/getting-started/download/">
  130. Download
  131. </a>
  132. </li><li>
  133. <a href="/docs/getting-started/contents/">
  134. Contents
  135. </a>
  136. </li><li>
  137. <a href="/docs/getting-started/usage/">
  138. Usage
  139. </a>
  140. </li><li>
  141. <a href="/docs/getting-started/browsers-devices/">
  142. Browsers & devices
  143. </a>
  144. </li><li>
  145. <a href="/docs/getting-started/build-tools/">
  146. Build tools
  147. </a>
  148. </li></ul>
  149. </div><div class="bd-toc-item">
  150. <a class="bd-toc-link" href="/docs/api/table-options/">
  151. API
  152. </a>
  153. <ul class="nav bd-sidenav"><li>
  154. <a href="/docs/api/table-options/">
  155. Table Options
  156. </a>
  157. </li><li>
  158. <a href="/docs/api/column-options/">
  159. Column Options
  160. </a>
  161. </li><li>
  162. <a href="/docs/api/events/">
  163. Events
  164. </a>
  165. </li><li>
  166. <a href="/docs/api/methods/">
  167. Methods
  168. </a>
  169. </li><li>
  170. <a href="/docs/api/localizations/">
  171. Localizations
  172. </a>
  173. </li></ul>
  174. </div><div class="bd-toc-item active">
  175. <a class="bd-toc-link" href="/docs/extensions/addrbar/">
  176. Extensions
  177. </a>
  178. <ul class="nav bd-sidenav"><li>
  179. <a href="/docs/extensions/addrbar/">
  180. Addrbar
  181. </a>
  182. </li><li>
  183. <a href="/docs/extensions/auto-refresh/">
  184. Auto Refresh
  185. </a>
  186. </li><li>
  187. <a href="/docs/extensions/cookie/">
  188. Cookie
  189. </a>
  190. </li><li>
  191. <a href="/docs/extensions/copy-rows/">
  192. Copy Rows
  193. </a>
  194. </li><li>
  195. <a href="/docs/extensions/custom-view/">
  196. Custom View
  197. </a>
  198. </li><li>
  199. <a href="/docs/extensions/defer-url/">
  200. Defer URL
  201. </a>
  202. </li><li>
  203. <a href="/docs/extensions/editable/">
  204. Editable
  205. </a>
  206. </li><li>
  207. <a href="/docs/extensions/export/">
  208. Export
  209. </a>
  210. </li><li>
  211. <a href="/docs/extensions/filter-control/">
  212. Filter Control
  213. </a>
  214. </li><li>
  215. <a href="/docs/extensions/fixed-columns/">
  216. Fixed Columns
  217. </a>
  218. </li><li>
  219. <a href="/docs/extensions/group-by-v2/">
  220. Group By v2
  221. </a>
  222. </li><li>
  223. <a href="/docs/extensions/i18n-enhance/">
  224. i18n Enhance
  225. </a>
  226. </li><li>
  227. <a href="/docs/extensions/key-events/">
  228. Key Events
  229. </a>
  230. </li><li>
  231. <a href="/docs/extensions/mobile/">
  232. Mobile
  233. </a>
  234. </li><li>
  235. <a href="/docs/extensions/multiple-sort/">
  236. Multiple Sort
  237. </a>
  238. </li><li>
  239. <a href="/docs/extensions/page-jump-to/">
  240. Page Jump To
  241. </a>
  242. </li><li>
  243. <a href="/docs/extensions/pipeline/">
  244. Pipeline
  245. </a>
  246. </li><li>
  247. <a href="/docs/extensions/print/">
  248. Print
  249. </a>
  250. </li><li>
  251. <a href="/docs/extensions/reorder-columns/">
  252. Reorder Columns
  253. </a>
  254. </li><li class="active bd-sidenav-active">
  255. <a href="/docs/extensions/reorder-rows/">
  256. Reorder Rows
  257. </a>
  258. </li><li>
  259. <a href="/docs/extensions/resizable/">
  260. Resizable
  261. </a>
  262. </li><li>
  263. <a href="/docs/extensions/sticky-header/">
  264. Sticky Header
  265. </a>
  266. </li><li>
  267. <a href="/docs/extensions/toolbar/">
  268. Toolbar
  269. </a>
  270. </li><li>
  271. <a href="/docs/extensions/treegrid/">
  272. Treegrid
  273. </a>
  274. </li></ul>
  275. </div><div class="bd-toc-item">
  276. <a class="bd-toc-link" href="/docs/vuejs/introduction/">
  277. VueJS
  278. </a>
  279. <ul class="nav bd-sidenav"><li>
  280. <a href="/docs/vuejs/introduction/">
  281. Introduction
  282. </a>
  283. </li><li>
  284. <a href="/docs/vuejs/browser/">
  285. Browser
  286. </a>
  287. </li><li>
  288. <a href="/docs/vuejs/webpack/">
  289. Webpack
  290. </a>
  291. </li><li>
  292. <a href="/docs/vuejs/component/">
  293. Component
  294. </a>
  295. </li></ul>
  296. </div><div class="bd-toc-item">
  297. <a class="bd-toc-link" href="/docs/online-editor/">
  298. Online Editor
  299. </a>
  300. <ul class="nav bd-sidenav"></ul>
  301. </div><div class="bd-toc-item">
  302. <a class="bd-toc-link" href="/docs/faq/">
  303. FAQ
  304. </a>
  305. <ul class="nav bd-sidenav"></ul>
  306. </div><div class="bd-toc-item">
  307. <a class="bd-toc-link" href="/docs/about/overview/">
  308. About
  309. </a>
  310. <ul class="nav bd-sidenav"><li>
  311. <a href="/docs/about/overview/">
  312. Overview
  313. </a>
  314. </li><li>
  315. <a href="/docs/about/team/">
  316. Team
  317. </a>
  318. </li><li>
  319. <a href="/docs/about/license/">
  320. License
  321. </a>
  322. </li><li>
  323. <a href="/docs/about/translations/">
  324. Translations
  325. </a>
  326. </li></ul>
  327. </div></nav>
  328. </div>
  329. <div class="d-none d-xl-block col-xl-2 bd-toc">
  330. <ul class="section-nav">
  331. <li class="toc-entry toc-h2"><a href="#usage">Usage</a></li>
  332. <li class="toc-entry toc-h2"><a href="#example">Example</a></li>
  333. <li class="toc-entry toc-h2"><a href="#options">Options</a>
  334. <ul>
  335. <li class="toc-entry toc-h3"><a href="#reorderablerows">reorderableRows</a></li>
  336. <li class="toc-entry toc-h3"><a href="#onallowdrop">onAllowDrop</a></li>
  337. <li class="toc-entry toc-h3"><a href="#ondragstop">onDragStop</a></li>
  338. <li class="toc-entry toc-h3"><a href="#ondragstyle">onDragStyle</a></li>
  339. <li class="toc-entry toc-h3"><a href="#ondragclass">onDragClass</a></li>
  340. <li class="toc-entry toc-h3"><a href="#ondropstyle">onDropStyle</a></li>
  341. <li class="toc-entry toc-h3"><a href="#onreorderrowsdrag">onReorderRowsDrag</a></li>
  342. <li class="toc-entry toc-h3"><a href="#onreorderrowsdrop">onReorderRowsDrop</a></li>
  343. <li class="toc-entry toc-h3"><a href="#draghandle">dragHandle</a></li>
  344. <li class="toc-entry toc-h3"><a href="#userowattrfunc">useRowAttrFunc</a></li>
  345. </ul>
  346. </li>
  347. <li class="toc-entry toc-h2"><a href="#events">Events</a>
  348. <ul>
  349. <li class="toc-entry toc-h3"><a href="#onreorderrowreorder-rowbstable">onReorderRow(reorder-row.bs.table)</a></li>
  350. </ul>
  351. </li>
  352. </ul>
  353. </div>
  354. <main class="col-12 col-md-9 col-xl-8 py-md-3 pl-md-5 bd-content extensions" role="main">
  355. <div class="d-md-flex flex-md-row-reverse align-items-center justify-content-between">
  356. <a class="btn btn-sm btn-bd-light mb-2 mb-md-0"
  357. href="https://github.com/wenzhixin/bootstrap-table/blob/develop/site/docs/extensions/reorder-rows.md"
  358. title="View and edit this file on GitHub" target="_blank" rel="noopener">
  359. View on GitHub
  360. </a>
  361. <h1 class="bd-title" id="content">
  362. Table Reorder Rows
  363. </h1>
  364. </div>
  365. <p class="bd-lead">Table Reorder Rows extension of Bootstrap Table.</p>
  366. <div id="gg"></div>
  367. <p>Dependence: <a href="https://github.com/isocra/TableDnD">tablednd</a> v0.9</p>
  368. <p>if you want you can include the bootstrap-table-reorder-rows.css file to use the default dragClass.</p>
  369. <h2 id="usage">Usage</h2>
  370. <figure class="highlight"><pre><code class="language-html" data-lang="html"><span class="nt">&lt;link</span> <span class="na">rel=</span><span class="s">"stylesheet"</span> <span class="na">href=</span><span class="s">"extensions/reorder-rows/bootstrap-table-reorder-rows.css"</span><span class="nt">&gt;</span>
  371. <span class="nt">&lt;script </span><span class="na">src=</span><span class="s">".../jquery.tablednd.js"</span><span class="nt">&gt;&lt;/script&gt;</span>
  372. <span class="nt">&lt;script </span><span class="na">src=</span><span class="s">"extensions/reorder-rows/bootstrap-table-reorder-rows.js"</span><span class="nt">&gt;&lt;/script&gt;</span></code></pre></figure>
  373. <h2 id="example">Example</h2>
  374. <p><a href="https://examples.bootstrap-table.com/#extensions/reorder-rows.html">Reorder Rows</a></p>
  375. <h2 id="options">Options</h2>
  376. <h3 id="reorderablerows">reorderableRows</h3>
  377. <ul>
  378. <li>
  379. <p><strong>attribute:</strong> <code class="highlighter-rouge">data-reorderable-rows</code></p>
  380. </li>
  381. <li>
  382. <p><strong>type:</strong> <code class="highlighter-rouge">Boolean</code></p>
  383. </li>
  384. <li>
  385. <p><strong>Detail:</strong></p>
  386. <p>Set true to allow the reorder feature.</p>
  387. </li>
  388. <li>
  389. <p><strong>Default:</strong> <code class="highlighter-rouge">false</code></p>
  390. </li>
  391. </ul>
  392. <h3 id="onallowdrop">onAllowDrop</h3>
  393. <ul>
  394. <li>
  395. <p><strong>attribute:</strong> <code class="highlighter-rouge">data-on-allow-drop</code></p>
  396. </li>
  397. <li>
  398. <p><strong>type:</strong> <code class="highlighter-rouge">function</code></p>
  399. </li>
  400. <li>
  401. <p><strong>Detail:</strong></p>
  402. <p>Pass a function that will be called as a row over another row. If the function returns true, allow dropping on that row, otherwise not. The function takes 4 parameters:</p>
  403. <ul>
  404. <li>the dragged-row data</li>
  405. <li>the data of the row under the cursor</li>
  406. <li>the dragged row</li>
  407. <li>the row under the cursor</li>
  408. </ul>
  409. <p>It returns a boolean: true allows the drop, false doesn’t allow it.</p>
  410. </li>
  411. <li>
  412. <p><strong>Default:</strong> <code class="highlighter-rouge">null</code></p>
  413. </li>
  414. </ul>
  415. <h3 id="ondragstop">onDragStop</h3>
  416. <ul>
  417. <li>
  418. <p><strong>attribute:</strong> <code class="highlighter-rouge">data-on-drag-stop</code></p>
  419. </li>
  420. <li>
  421. <p><strong>type:</strong> <code class="highlighter-rouge">function</code></p>
  422. </li>
  423. <li>
  424. <p><strong>Detail:</strong></p>
  425. <p>Pass a function that will be called when the user stops dragging regardless of if the rows have been rearranged. The function takes 3 parameters: the table, the row data and the row which the user was dragging.</p>
  426. </li>
  427. <li>
  428. <p><strong>Default:</strong> <code class="highlighter-rouge">null</code></p>
  429. </li>
  430. </ul>
  431. <h3 id="ondragstyle">onDragStyle</h3>
  432. <ul>
  433. <li>
  434. <p><strong>attribute:</strong> <code class="highlighter-rouge">data-on-drag-style</code></p>
  435. </li>
  436. <li>
  437. <p><strong>type:</strong> <code class="highlighter-rouge">String</code></p>
  438. </li>
  439. <li>
  440. <p><strong>Detail:</strong></p>
  441. <p>This is the style that is assigned to the row during drag. There are limitations to the styles that can be associated with a row (such as you can’t assign a border well you can, but it won’t be displayed).</p>
  442. </li>
  443. <li>
  444. <p><strong>Default:</strong> <code class="highlighter-rouge">null</code></p>
  445. </li>
  446. </ul>
  447. <h3 id="ondragclass">onDragClass</h3>
  448. <ul>
  449. <li>
  450. <p><strong>attribute:</strong> <code class="highlighter-rouge">data-on-drag-class</code></p>
  451. </li>
  452. <li>
  453. <p><strong>type:</strong> <code class="highlighter-rouge">String</code></p>
  454. </li>
  455. <li>
  456. <p><strong>Detail:</strong></p>
  457. <p>This class is added for the duration of the drag and then removed when the row is dropped. It is more flexible than using onDragStyle since it can be inherited by the row cells and other content.</p>
  458. </li>
  459. <li>
  460. <p><strong>Default:</strong> <code class="highlighter-rouge">reorder-rows-on-drag-class</code></p>
  461. </li>
  462. </ul>
  463. <h3 id="ondropstyle">onDropStyle</h3>
  464. <ul>
  465. <li>
  466. <p><strong>attribute:</strong> <code class="highlighter-rouge">data-on-drop-style</code></p>
  467. </li>
  468. <li>
  469. <p><strong>type:</strong> <code class="highlighter-rouge">String</code></p>
  470. </li>
  471. <li>
  472. <p><strong>Detail:</strong></p>
  473. <p>This is the style that is assigned to the row when it is dropped. As for onDragStyle, there are limitations to what you can do. Also, this replaces the original style, so again consider using onDragClass which is simply added and then removed on drop.</p>
  474. </li>
  475. <li>
  476. <p><strong>Default:</strong> <code class="highlighter-rouge">null</code></p>
  477. </li>
  478. </ul>
  479. <h3 id="onreorderrowsdrag">onReorderRowsDrag</h3>
  480. <ul>
  481. <li>
  482. <p><strong>attribute:</strong> <code class="highlighter-rouge">data-on-reorder-rows-drag</code></p>
  483. </li>
  484. <li>
  485. <p><strong>type:</strong> <code class="highlighter-rouge">Function</code></p>
  486. </li>
  487. <li>
  488. <p><strong>Detail:</strong></p>
  489. <p>Pass a function that will be called when the user starts dragging. The function takes 1 parameter: the row which the user has started to drag.</p>
  490. </li>
  491. <li>
  492. <p><strong>Default:</strong> <code class="highlighter-rouge">empty function</code></p>
  493. </li>
  494. </ul>
  495. <h3 id="onreorderrowsdrop">onReorderRowsDrop</h3>
  496. <ul>
  497. <li>
  498. <p><strong>attribute:</strong> <code class="highlighter-rouge">data-on-reorder-rows-drop</code></p>
  499. </li>
  500. <li>
  501. <p><strong>type:</strong> <code class="highlighter-rouge">Function</code></p>
  502. </li>
  503. <li>
  504. <p><strong>Detail:</strong></p>
  505. <p>Pass a function that will be called when the row is dropped. The function takes 1 parameter: the row that was dropped.</p>
  506. </li>
  507. <li>
  508. <p><strong>Default:</strong> <code class="highlighter-rouge">empty function</code></p>
  509. </li>
  510. </ul>
  511. <h3 id="draghandle">dragHandle</h3>
  512. <ul>
  513. <li>
  514. <p><strong>attribute:</strong> <code class="highlighter-rouge">data-drag-handle</code></p>
  515. </li>
  516. <li>
  517. <p><strong>type:</strong> <code class="highlighter-rouge">String</code></p>
  518. </li>
  519. <li>
  520. <p><strong>Detail:</strong></p>
  521. <p>This is the cursor element.</p>
  522. <p><strong>Note: This option is mainly used to adapt to the <code class="highlighter-rouge">TableDnD</code> plugin. Under no special circumstances, please do not modify the default value.</strong></p>
  523. </li>
  524. <li>
  525. <p><strong>Default:</strong> <code class="highlighter-rouge">&gt;tbody&gt;tr&gt;td:not(.bs-checkbox)</code></p>
  526. </li>
  527. </ul>
  528. <h3 id="userowattrfunc">useRowAttrFunc</h3>
  529. <ul>
  530. <li>
  531. <p><strong>attribute:</strong> <code class="highlighter-rouge">data-use-row-attr-func</code></p>
  532. </li>
  533. <li>
  534. <p><strong>type:</strong> <code class="highlighter-rouge">Boolean</code></p>
  535. </li>
  536. <li>
  537. <p><strong>Detail:</strong></p>
  538. <p>This function must be used if your <code class="highlighter-rouge">tr</code> elements won’t have the <code class="highlighter-rouge">id</code> attribute. If your <code class="highlighter-rouge">tr</code> elements don’t have the <code class="highlighter-rouge">id</code> attribute this plugin doesn’t fire the onDrop event.</p>
  539. </li>
  540. <li>
  541. <p><strong>Default:</strong> <code class="highlighter-rouge">false</code></p>
  542. </li>
  543. </ul>
  544. <h2 id="events">Events</h2>
  545. <h3 id="onreorderrowreorder-rowbstable">onReorderRow(reorder-row.bs.table)</h3>
  546. <p>Fired when the row was dropped, receives two parameters:</p>
  547. <ul>
  548. <li>The new table data</li>
  549. <li>The dropped row</li>
  550. <li>The row of the old position</li>
  551. </ul>
  552. </main>
  553. </div>
  554. </div>
  555. <script src="https://cdn.jsdelivr.net/npm/jquery/dist/jquery.min.js"></script>
  556. <script src="https://cdn.jsdelivr.net/npm/popper.js@1.16.1/dist/umd/popper.min.js"></script>
  557. <script src="https://cdn.jsdelivr.net/npm/bootstrap@4.6.2/dist/js/bootstrap.min.js"></script>
  558. <script async defer src="https://buttons.github.io/buttons.js"></script><script src="https://cdn.jsdelivr.net/npm/docsearch.js@2/dist/cdn/docsearch.min.js"></script>
  559. <script>
  560. $(function () {
  561. $('.bd-content.api a').attr('target', '_blank')
  562. })
  563. </script><script src="https://gg.wenzhixin.net.cn/bootstrap-table/gg.js"></script>
  564. <script src="/assets/js/docs.min.js?m=1"></script>
  565. <!-- Global site tag (gtag.js) - Google Analytics -->
  566. <script async src="https://www.googletagmanager.com/gtag/js?id=UA-132747866-1"></script>
  567. <script>
  568. window.dataLayer = window.dataLayer || []
  569. function gtag() {window.dataLayer.push(arguments)}
  570. gtag('js', new Date())
  571. gtag('config', 'UA-132747866-1')
  572. </script>
  573. </body>
  574. </html>