progress.js 17 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550
  1. // Generated by CoffeeScript 2.0.0-beta4
  2. (function() {
  3. // ------------------------------------------------------------------------
  4. // 變數與常數設置
  5. // ------------------------------------------------------------------------
  6. // 模組名稱。
  7. var ClassName, EVENT_NAMESPACE, Error, Event, MODULE_NAMESPACE, NAME, Selector, Settings;
  8. NAME = 'progress';
  9. // 模組事件鍵名。
  10. EVENT_NAMESPACE = `.${NAME}`;
  11. // 模組命名空間。
  12. MODULE_NAMESPACE = `module-${NAME}`;
  13. // 模組設定。
  14. Settings = {
  15. // 消音所有提示,甚至是錯誤訊息。
  16. silent: false,
  17. // 顯示除錯訊息。
  18. debug: true,
  19. // 監聽 DOM 結構異動並自動重整快取。
  20. observeChanges: true,
  21. // 是否要在百分比達到 `100` 時,自動將進度條改為「成功」狀態。
  22. autoSuccess: true,
  23. // 緩衝條。
  24. buffer: {
  25. // 緩衝值。
  26. value: 0
  27. },
  28. // 初始化的進度條值。
  29. value: 0,
  30. // 多個進度條的值。
  31. // values
  32. // 進度條的最大值,會以此作為百分比的推算。
  33. total: 100,
  34. // 是否要在進度條上顯示百分比。
  35. text: false,
  36. // 當數值變動時所會呼叫的回呼函式。
  37. onChange: (percent, value, total) => {},
  38. // 當達到成功狀態時所會呼叫的回呼函式。
  39. onSuccess: (value, total) => {},
  40. // 當啟用時所會呼叫的回呼函式。
  41. onActive: (value, total) => {},
  42. // 當狀態改為錯誤時所會呼叫的回呼函式。
  43. onError: (value, total) => {},
  44. // 當呈現為警告狀態時所會呼叫的回呼函式。
  45. onWarning: (value, total) => {},
  46. // 當處於緩衝時所會呼叫的回呼函式。
  47. onBuffering: (bufferValue, value, total) => {},
  48. // 處於未知狀態時所會呼叫的回呼函式。
  49. onIndeterminate: () => {},
  50. // 處於準備中所會呼叫的回呼函式。
  51. onPreparing: () => {},
  52. // 處於已請求但仍未知時所會呼叫的回呼函式。
  53. onQueriedIndeterminate: () => {},
  54. // 當進度達到全滿時所會呼叫的回呼函式。
  55. onComplete: (total) => {}
  56. };
  57. // 事件名稱。
  58. Event = {
  59. CHANGE: `change${EVENT_NAMESPACE}`,
  60. SUCCESS: `success${EVENT_NAMESPACE}`,
  61. ACTIVE: `active${EVENT_NAMESPACE}`,
  62. ERROR: `error${EVENT_NAMESPACE}`,
  63. WARNING: `warning${EVENT_NAMESPACE}`,
  64. BUFFERING: `buffering${EVENT_NAMESPACE}`,
  65. INDETERMINATE: `indeterminate${EVENT_NAMESPACE}`,
  66. PREPARING: `preparing${EVENT_NAMESPACE}`,
  67. QUERIED_INDETERMINATE: `queriedindeterminate${EVENT_NAMESPACE}`,
  68. COMPLETE: `complete${EVENT_NAMESPACE}`
  69. };
  70. // 樣式名稱。
  71. ClassName = {
  72. BUFFERING: 'buffering',
  73. PREPARING: 'preparing',
  74. ACTIVE: 'active',
  75. QUERIED_INDETERMINATE: 'queried indeterminate',
  76. INDETERMINATE: 'indeterminate',
  77. SUCCESS: 'success',
  78. ERROR: 'error',
  79. WARNING: 'warning',
  80. BAR: 'bar',
  81. TEXT: 'text',
  82. BUFFER: 'buffer'
  83. };
  84. // 選擇器名稱。
  85. Selector = {
  86. BAR: ':scope > .bar',
  87. BUFFER: ':scope > .buffer.bar',
  88. TEXT: ':scope > .bar > .text',
  89. DIV: '<div>'
  90. };
  91. // 錯誤訊息。
  92. Error = {};
  93. // ------------------------------------------------------------------------
  94. // 模組註冊
  95. // ------------------------------------------------------------------------
  96. ts.register({NAME, MODULE_NAMESPACE, Error, Settings}, ({$allModules, $this, element, debug, settings}) => {
  97. var $bar, $buffer, $text, module;
  98. // ------------------------------------------------------------------------
  99. // 區域變數
  100. // ------------------------------------------------------------------------
  101. $bar = $this.find(Selector.BAR);
  102. $buffer = $this.find(Selector.BUFFER);
  103. $text = $this.find(Selector.TEXT);
  104. // ------------------------------------------------------------------------
  105. // 模組定義
  106. // ------------------------------------------------------------------------
  107. return module = {
  108. is: {
  109. success: () => {
  110. return $this.hasClass(ClassName.SUCCESS);
  111. },
  112. error: () => {
  113. return $this.hasClass(ClassName.ERROR);
  114. },
  115. warning: () => {
  116. return $this.hasClass(ClassName.WARNING);
  117. },
  118. active: () => {
  119. return $this.hasClass(ClassName.ACTIVE);
  120. },
  121. preparing: () => {
  122. return $this.hasClass(ClassName.PREPARING);
  123. },
  124. buffering: () => {
  125. return $this.hasClass(ClassName.BUFFERING);
  126. },
  127. buffer: {
  128. complete: () => {
  129. return module.get.buffer.percent() >= 100;
  130. }
  131. },
  132. queried: {
  133. indeterminate: () => {
  134. return $this.hasClass(ClassName.QUERIED_INDETERMINATE);
  135. }
  136. },
  137. indeterminate: () => {
  138. return $this.hasClass(ClassName.INDETERMINATE);
  139. },
  140. complete: () => {
  141. return module.get.percent() >= 100;
  142. }
  143. },
  144. get: {
  145. text: () => {
  146. return $text.html();
  147. },
  148. percent: () => {
  149. return parseInt(settings.value / settings.total * 100);
  150. },
  151. value: () => {
  152. return settings.value;
  153. },
  154. total: () => {
  155. return settings.total;
  156. },
  157. buffer: {
  158. percent: () => {
  159. return settings.buffer.value / settings.total * 100;
  160. },
  161. value: () => {
  162. return settings.buffer.value;
  163. },
  164. bar: () => {
  165. return $buffer.get();
  166. }
  167. },
  168. bar: () => {
  169. return $bar.get();
  170. }
  171. },
  172. create: {
  173. buffer: {
  174. bar: () => {
  175. if ($buffer.exists()) {
  176. return;
  177. }
  178. return $buffer = ts(Selector.DIV).addClass(`${ClassName.BUFFER} ${ClassName.BAR}`).appendTo(element);
  179. }
  180. },
  181. bar: () => {
  182. return $bar = ts(Selector.DIV).addClass(ClassName.BAR).appendTo(element);
  183. },
  184. text: () => {
  185. return $text = ts(Selector.DIV).addClass(ClassName.TEXT).appendTo($bar);
  186. }
  187. },
  188. repaint: {
  189. bar: () => {
  190. var percent;
  191. percent = Math.round(settings.value / settings.total * 100);
  192. if (percent >= 100) {
  193. $bar.css('width', "100%");
  194. if (settings.autoSuccess) {
  195. module.set.success();
  196. module.remove.warning();
  197. module.remove.error();
  198. }
  199. module.trigger.complete();
  200. } else {
  201. $bar.css('width', `${percent}%`);
  202. if (settings.autoSuccess) {
  203. module.remove.success();
  204. module.remove.warning();
  205. module.remove.error();
  206. }
  207. }
  208. if (settings.text === true) {
  209. return module.set.text(`${percent}%`);
  210. }
  211. },
  212. buffer: () => {
  213. var bufferPercent;
  214. bufferPercent = Math.round(settings.buffer.value / settings.total * 100);
  215. if (bufferPercent >= 100) {
  216. return $buffer.css('width', "100%");
  217. } else {
  218. return $buffer.css('width', `${bufferPercent}%`);
  219. }
  220. }
  221. },
  222. set: {
  223. percent: (percent) => {
  224. if (percent === module.get.percent()) {
  225. return $allModules;
  226. }
  227. settings.value = Math.round(percent / settings.total * 100);
  228. module.repaint.bar();
  229. module.trigger.change();
  230. return $allModules;
  231. },
  232. value: (value) => {
  233. if (value === module.get.value()) {
  234. return $allModules;
  235. }
  236. settings.value = value;
  237. module.repaint.bar();
  238. module.trigger.change();
  239. return $allModules;
  240. },
  241. increment: (value) => {
  242. if (settings.value === settings.total) {
  243. return $allModules;
  244. }
  245. settings.value = settings.value + value;
  246. if (settings.value > settings.total) {
  247. settings.value = settings.total;
  248. }
  249. module.repaint.bar();
  250. module.trigger.change();
  251. return $allModules;
  252. },
  253. decrement: (value) => {
  254. if (settings.value === 0) {
  255. return $allModules;
  256. }
  257. settings.value = settings.value - value;
  258. if (settings.value < 0) {
  259. settings.value = 0;
  260. }
  261. module.repaint.bar();
  262. module.trigger.change();
  263. return $allModules;
  264. },
  265. total: (total) => {
  266. settings.total = total;
  267. module.repaint.bar();
  268. return $allModules;
  269. },
  270. active: () => {
  271. $this.addClass(ClassName.ACTIVE);
  272. module.trigger.active();
  273. return $allModules;
  274. },
  275. warning: () => {
  276. module.remove.success();
  277. module.remove.error();
  278. $this.addClass(ClassName.WARNING);
  279. module.trigger.warning();
  280. return $allModules;
  281. },
  282. success: () => {
  283. module.remove.warning();
  284. module.remove.error();
  285. $this.addClass(ClassName.SUCCESS);
  286. module.trigger.success();
  287. return $allModules;
  288. },
  289. error: () => {
  290. module.remove.success();
  291. module.remove.warning();
  292. $this.addClass(ClassName.ERROR);
  293. module.trigger.error();
  294. return $allModules;
  295. },
  296. preparing: () => {
  297. module.reset();
  298. $this.addClass(ClassName.PREPARING);
  299. module.trigger.preparing();
  300. return $allModules;
  301. },
  302. buffering: () => {
  303. $this.addClass(ClassName.BUFFERING);
  304. return $allModules;
  305. },
  306. buffer: {
  307. percent: (percent) => {
  308. if (percent === module.get.buffer.percent()) {
  309. return $allModules;
  310. }
  311. module.set.buffering();
  312. module.create.buffer.bar();
  313. settings.buffer.value = Math.round(percent / settings.total * 100);
  314. module.repaint.buffer();
  315. module.trigger.buffering();
  316. return $allModules;
  317. },
  318. value: (value) => {
  319. if (value === module.get.buffer.value()) {
  320. return $allModules;
  321. }
  322. module.set.buffering();
  323. module.create.buffer.bar();
  324. settings.buffer.value = value;
  325. module.repaint.buffer();
  326. module.trigger.buffering();
  327. return $allModules;
  328. },
  329. increment: (value) => {
  330. if (settings.buffer.value === settings.total) {
  331. return $allModules;
  332. }
  333. module.set.buffering();
  334. module.create.buffer.bar();
  335. settings.buffer.value = settings.buffer.value + value;
  336. if (settings.buffer.value > settings.total) {
  337. settings.buffer.value = settings.total;
  338. }
  339. module.repaint.buffer();
  340. module.trigger.buffering();
  341. return $allModules;
  342. },
  343. decrement: (value) => {
  344. if (settings.value === 0) {
  345. return $allModules;
  346. }
  347. module.set.buffering();
  348. module.create.buffer.bar();
  349. settings.buffer.value = settings.buffer.value - value;
  350. if (settings.buffer.value < 0) {
  351. settings.buffer.value = 0;
  352. }
  353. module.repaint.buffer();
  354. module.trigger.buffering();
  355. return $allModules;
  356. }
  357. },
  358. indeterminate: () => {
  359. module.reset();
  360. $this.addClass(ClassName.INDETERMINATE);
  361. module.trigger.indeterminate();
  362. return $allModules;
  363. },
  364. queried: {
  365. indeterminate: () => {
  366. module.reset();
  367. $this.addClass(ClassName.QUERIED_INDETERMINATE);
  368. module.trigger.queried.indeterminate();
  369. return $allModules;
  370. }
  371. },
  372. text: (text) => {
  373. $text.html(text);
  374. return $allModules;
  375. }
  376. },
  377. remove: {
  378. active: () => {
  379. $this.removeClass(ClassName.ACTIVE);
  380. return $allModules;
  381. },
  382. warning: () => {
  383. $this.removeClass(ClassName.WARNING);
  384. return $allModules;
  385. },
  386. success: () => {
  387. $this.removeClass(ClassName.SUCCESS);
  388. return $allModules;
  389. },
  390. error: () => {
  391. $this.removeClass(ClassName.ERROR);
  392. return $allModules;
  393. },
  394. preparing: () => {
  395. $this.removeClass(ClassName.PREPARING);
  396. return $allModules;
  397. },
  398. buffer: () => {
  399. $this.removeClass(ClassName.BUFFERING);
  400. settings.buffer.value = 0;
  401. $buffer.remove();
  402. return $allModules;
  403. },
  404. queried: {
  405. indeterminate: () => {
  406. $this.removeClass(ClassName.QUERIED_INDETERMINATE);
  407. return $allModules;
  408. }
  409. },
  410. indeterminate: () => {
  411. $this.removeClass(ClassName.INDETERMINATE);
  412. return $allModules;
  413. }
  414. },
  415. complete: () => {
  416. module.set.value(module.get.total());
  417. return $allModules;
  418. },
  419. reset: () => {
  420. module.remove.warning();
  421. module.remove.success();
  422. module.remove.error();
  423. module.remove.active();
  424. module.remove.buffer();
  425. module.remove.preparing();
  426. module.remove.queried.indeterminate();
  427. module.remove.indeterminate();
  428. module.set.value(0);
  429. return $allModules;
  430. },
  431. trigger: {
  432. change: () => {
  433. return $this.trigger(Event.CHANGE);
  434. },
  435. success: () => {
  436. return $this.trigger(Event.SUCCESS);
  437. },
  438. active: () => {
  439. return $this.trigger(Event.ACTIVE);
  440. },
  441. error: () => {
  442. return $this.trigger(Event.ERROR);
  443. },
  444. warning: () => {
  445. return $this.trigger(Event.WARNING);
  446. },
  447. buffering: () => {
  448. return $this.trigger(Event.BUFFERING);
  449. },
  450. indeterminate: () => {
  451. return $this.trigger(Event.INDETERMINATE);
  452. },
  453. preparing: () => {
  454. return $this.trigger(Event.PREPARING);
  455. },
  456. queried: {
  457. indeterminate: () => {
  458. return $this.trigger(Event.QUERIED_INDETERMINATE);
  459. }
  460. },
  461. complete: () => {
  462. return $this.trigger(Event.COMPLETE);
  463. }
  464. },
  465. bind: {
  466. events: () => {
  467. $this.on(Event.CHANGE, () => {
  468. debug('發生 CHANGE 事件', element, module.get.percent(), module.get.value(), module.get.total());
  469. return settings.onChange.call(element, module.get.percent(), module.get.value(), module.get.total());
  470. });
  471. $this.on(Event.SUCCESS, () => {
  472. debug('發生 SUCCESS 事件', element);
  473. return settings.onSuccess.call(element, module.get.value(), module.get.total());
  474. });
  475. $this.on(Event.ACTIVE, () => {
  476. debug('發生 ACTIVE 事件', element);
  477. return settings.onActive.call(element, module.get.value(), module.get.total());
  478. });
  479. $this.on(Event.ERROR, () => {
  480. debug('發生 ERROR 事件', element);
  481. return settings.onError.call(element, module.get.value(), module.get.total());
  482. });
  483. $this.on(Event.WARNING, () => {
  484. debug('發生 WARNING 事件', element);
  485. return settings.onWarning.call(element, module.get.value(), module.get.total());
  486. });
  487. $this.on(Event.BUFFERING, () => {
  488. debug('發生 BUFFERING 事件', element);
  489. return settings.onBuffering.call(element, module.get.buffer.value(), module.get.value(), module.get.total());
  490. });
  491. $this.on(Event.INDETERMINATE, () => {
  492. debug("發生 INDETERMINATE 事件", element);
  493. return settings.onIndeterminate.call(element);
  494. });
  495. $this.on(Event.PREPARING, () => {
  496. debug("發生 PREPARING 事件", element);
  497. return settings.onPreparing.call(element);
  498. });
  499. $this.on(Event.QUERIED_INDETERMINATE, () => {
  500. debug("發生 QUERIED_INDETERMINATE 事件", element);
  501. return settings.onQueriedIndeterminate.call(element);
  502. });
  503. return $this.on(Event.COMPLETE, () => {
  504. debug("發生 COMPLETE 事件", element);
  505. return settings.onComplete.call(element, module.get.total());
  506. });
  507. }
  508. },
  509. // ------------------------------------------------------------------------
  510. // 基礎方法
  511. // ------------------------------------------------------------------------
  512. initialize: () => {
  513. debug('初始化進度條', element);
  514. if (!$bar.exists()) {
  515. module.create.bar();
  516. }
  517. if (!$text.exists()) {
  518. module.create.text();
  519. }
  520. module.repaint.bar();
  521. return module.bind.events();
  522. },
  523. instantiate: () => {
  524. return debug('實例化進度條', element);
  525. },
  526. refresh: () => {
  527. $bar = $this.find(Selector.BAR);
  528. $text = $this.find(Selector.TEXT);
  529. $buffer = $this.find(Selector.BUFFER);
  530. return $allModules;
  531. },
  532. destroy: () => {
  533. debug('摧毀進度條', element);
  534. $this.removeData(MODULE_NAMESPACE).off(EVENT_NAMESPACE);
  535. return $allModules;
  536. }
  537. };
  538. });
  539. }).call(this);