filepond-plugin-file-poster.js 18 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629
  1. /*!
  2. * FilePondPluginFilePoster 2.5.1
  3. * Licensed under MIT, https://opensource.org/licenses/MIT/
  4. * Please visit https://pqina.nl/filepond/ for details.
  5. */
  6. /* eslint-disable */
  7. (function(global, factory) {
  8. typeof exports === 'object' && typeof module !== 'undefined'
  9. ? (module.exports = factory())
  10. : typeof define === 'function' && define.amd
  11. ? define(factory)
  12. : ((global = global || self),
  13. (global.FilePondPluginFilePoster = factory()));
  14. })(this, function() {
  15. 'use strict';
  16. var IMAGE_SCALE_SPRING_PROPS = {
  17. type: 'spring',
  18. stiffness: 0.5,
  19. damping: 0.45,
  20. mass: 10
  21. };
  22. var createPosterView = function createPosterView(_) {
  23. return _.utils.createView({
  24. name: 'file-poster',
  25. tag: 'div',
  26. ignoreRect: true,
  27. create: function create(_ref) {
  28. var root = _ref.root;
  29. root.ref.image = document.createElement('img');
  30. root.element.appendChild(root.ref.image);
  31. },
  32. write: _.utils.createRoute({
  33. DID_FILE_POSTER_LOAD: function DID_FILE_POSTER_LOAD(_ref2) {
  34. var root = _ref2.root,
  35. props = _ref2.props;
  36. var id = props.id;
  37. // get item
  38. var item = root.query('GET_ITEM', { id: props.id });
  39. if (!item) return;
  40. // get poster
  41. var poster = item.getMetadata('poster');
  42. root.ref.image.src = poster;
  43. // let others know of our fabulous achievement (so the image can be faded in)
  44. root.dispatch('DID_FILE_POSTER_DRAW', { id: id });
  45. }
  46. }),
  47. mixins: {
  48. styles: ['scaleX', 'scaleY', 'opacity'],
  49. animations: {
  50. scaleX: IMAGE_SCALE_SPRING_PROPS,
  51. scaleY: IMAGE_SCALE_SPRING_PROPS,
  52. opacity: { type: 'tween', duration: 750 }
  53. }
  54. }
  55. });
  56. };
  57. var applyTemplate = function applyTemplate(source, target) {
  58. // copy width and height
  59. target.width = source.width;
  60. target.height = source.height;
  61. // draw the template
  62. var ctx = target.getContext('2d');
  63. ctx.drawImage(source, 0, 0);
  64. };
  65. var createPosterOverlayView = function createPosterOverlayView(fpAPI) {
  66. return fpAPI.utils.createView({
  67. name: 'file-poster-overlay',
  68. tag: 'canvas',
  69. ignoreRect: true,
  70. create: function create(_ref) {
  71. var root = _ref.root,
  72. props = _ref.props;
  73. applyTemplate(props.template, root.element);
  74. },
  75. mixins: {
  76. styles: ['opacity'],
  77. animations: {
  78. opacity: { type: 'spring', mass: 25 }
  79. }
  80. }
  81. });
  82. };
  83. var getImageSize = function getImageSize(url, cb) {
  84. var image = new Image();
  85. image.onload = function() {
  86. var width = image.naturalWidth;
  87. var height = image.naturalHeight;
  88. image = null;
  89. cb(width, height);
  90. };
  91. image.src = url;
  92. };
  93. var easeInOutSine = function easeInOutSine(t) {
  94. return -0.5 * (Math.cos(Math.PI * t) - 1);
  95. };
  96. var addGradientSteps = function addGradientSteps(gradient, color) {
  97. var alpha =
  98. arguments.length > 2 && arguments[2] !== undefined ? arguments[2] : 1;
  99. var easeFn =
  100. arguments.length > 3 && arguments[3] !== undefined
  101. ? arguments[3]
  102. : easeInOutSine;
  103. var steps =
  104. arguments.length > 4 && arguments[4] !== undefined ? arguments[4] : 10;
  105. var offset =
  106. arguments.length > 5 && arguments[5] !== undefined ? arguments[5] : 0;
  107. var range = 1 - offset;
  108. var rgb = color.join(',');
  109. for (var i = 0; i <= steps; i++) {
  110. var p = i / steps;
  111. var stop = offset + range * p;
  112. gradient.addColorStop(
  113. stop,
  114. 'rgba('.concat(rgb, ', ').concat(easeFn(p) * alpha, ')')
  115. );
  116. }
  117. };
  118. var MAX_WIDTH = 10;
  119. var MAX_HEIGHT = 10;
  120. var calculateAverageColor = function calculateAverageColor(image) {
  121. var scalar = Math.min(MAX_WIDTH / image.width, MAX_HEIGHT / image.height);
  122. var canvas = document.createElement('canvas');
  123. var ctx = canvas.getContext('2d');
  124. var width = (canvas.width = Math.ceil(image.width * scalar));
  125. var height = (canvas.height = Math.ceil(image.height * scalar));
  126. ctx.drawImage(image, 0, 0, width, height);
  127. var data = null;
  128. try {
  129. data = ctx.getImageData(0, 0, width, height).data;
  130. } catch (e) {
  131. return null;
  132. }
  133. var l = data.length;
  134. var r = 0;
  135. var g = 0;
  136. var b = 0;
  137. var i = 0;
  138. for (; i < l; i += 4) {
  139. r += data[i] * data[i];
  140. g += data[i + 1] * data[i + 1];
  141. b += data[i + 2] * data[i + 2];
  142. }
  143. r = averageColor(r, l);
  144. g = averageColor(g, l);
  145. b = averageColor(b, l);
  146. return { r: r, g: g, b: b };
  147. };
  148. var averageColor = function averageColor(c, l) {
  149. return Math.floor(Math.sqrt(c / (l / 4)));
  150. };
  151. var drawTemplate = function drawTemplate(
  152. canvas,
  153. width,
  154. height,
  155. color,
  156. alphaTarget
  157. ) {
  158. canvas.width = width;
  159. canvas.height = height;
  160. var ctx = canvas.getContext('2d');
  161. var horizontalCenter = width * 0.5;
  162. var grad = ctx.createRadialGradient(
  163. horizontalCenter,
  164. height + 110,
  165. height - 100,
  166. horizontalCenter,
  167. height + 110,
  168. height + 100
  169. );
  170. addGradientSteps(grad, color, alphaTarget, undefined, 8, 0.4);
  171. ctx.save();
  172. ctx.translate(-width * 0.5, 0);
  173. ctx.scale(2, 1);
  174. ctx.fillStyle = grad;
  175. ctx.fillRect(0, 0, width, height);
  176. ctx.restore();
  177. };
  178. var hasNavigator = typeof navigator !== 'undefined';
  179. var width = 500;
  180. var height = 200;
  181. var overlayTemplateShadow = hasNavigator && document.createElement('canvas');
  182. var overlayTemplateError = hasNavigator && document.createElement('canvas');
  183. var overlayTemplateSuccess = hasNavigator && document.createElement('canvas');
  184. var itemShadowColor = [40, 40, 40];
  185. var itemErrorColor = [196, 78, 71];
  186. var itemSuccessColor = [54, 151, 99];
  187. if (hasNavigator) {
  188. drawTemplate(overlayTemplateShadow, width, height, itemShadowColor, 0.85);
  189. drawTemplate(overlayTemplateError, width, height, itemErrorColor, 1);
  190. drawTemplate(overlayTemplateSuccess, width, height, itemSuccessColor, 1);
  191. }
  192. var loadImage = function loadImage(url, crossOriginValue) {
  193. return new Promise(function(resolve, reject) {
  194. var img = new Image();
  195. if (typeof crossOrigin === 'string') {
  196. img.crossOrigin = crossOriginValue;
  197. }
  198. img.onload = function() {
  199. resolve(img);
  200. };
  201. img.onerror = function(e) {
  202. reject(e);
  203. };
  204. img.src = url;
  205. });
  206. };
  207. var createPosterWrapperView = function createPosterWrapperView(_) {
  208. // create overlay view
  209. var overlay = createPosterOverlayView(_);
  210. /**
  211. * Write handler for when preview container has been created
  212. */
  213. var didCreatePreviewContainer = function didCreatePreviewContainer(_ref) {
  214. var root = _ref.root,
  215. props = _ref.props;
  216. var id = props.id;
  217. // we need to get the file data to determine the eventual image size
  218. var item = root.query('GET_ITEM', id);
  219. if (!item) return;
  220. // get url to file
  221. var fileURL = item.getMetadata('poster');
  222. // image is now ready
  223. var previewImageLoaded = function previewImageLoaded(data) {
  224. // calculate average image color, is in try catch to circumvent any cors errors
  225. var averageColor = root.query(
  226. 'GET_FILE_POSTER_CALCULATE_AVERAGE_IMAGE_COLOR'
  227. )
  228. ? calculateAverageColor(data)
  229. : null;
  230. item.setMetadata('color', averageColor, true);
  231. // the preview is now ready to be drawn
  232. root.dispatch('DID_FILE_POSTER_LOAD', {
  233. id: id,
  234. data: data
  235. });
  236. };
  237. // determine image size of this item
  238. getImageSize(fileURL, function(width, height) {
  239. // we can now scale the panel to the final size
  240. root.dispatch('DID_FILE_POSTER_CALCULATE_SIZE', {
  241. id: id,
  242. width: width,
  243. height: height
  244. });
  245. // create fallback preview
  246. loadImage(
  247. fileURL,
  248. root.query('GET_FILE_POSTER_CROSS_ORIGIN_ATTRIBUTE_VALUE')
  249. ).then(previewImageLoaded);
  250. });
  251. };
  252. /**
  253. * Write handler for when the preview has been loaded
  254. */
  255. var didLoadPreview = function didLoadPreview(_ref2) {
  256. var root = _ref2.root;
  257. root.ref.overlayShadow.opacity = 1;
  258. };
  259. /**
  260. * Write handler for when the preview image is ready to be animated
  261. */
  262. var didDrawPreview = function didDrawPreview(_ref3) {
  263. var root = _ref3.root;
  264. var image = root.ref.image;
  265. // reveal image
  266. image.scaleX = 1.0;
  267. image.scaleY = 1.0;
  268. image.opacity = 1;
  269. };
  270. /**
  271. * Write handler for when the preview has been loaded
  272. */
  273. var restoreOverlay = function restoreOverlay(_ref4) {
  274. var root = _ref4.root;
  275. root.ref.overlayShadow.opacity = 1;
  276. root.ref.overlayError.opacity = 0;
  277. root.ref.overlaySuccess.opacity = 0;
  278. };
  279. var didThrowError = function didThrowError(_ref5) {
  280. var root = _ref5.root;
  281. root.ref.overlayShadow.opacity = 0.25;
  282. root.ref.overlayError.opacity = 1;
  283. };
  284. var didCompleteProcessing = function didCompleteProcessing(_ref6) {
  285. var root = _ref6.root;
  286. root.ref.overlayShadow.opacity = 0.25;
  287. root.ref.overlaySuccess.opacity = 1;
  288. };
  289. /**
  290. * Constructor
  291. */
  292. var create = function create(_ref7) {
  293. var root = _ref7.root,
  294. props = _ref7.props;
  295. // test if colors aren't default item overlay colors
  296. var itemShadowColorProp = root.query(
  297. 'GET_FILE_POSTER_ITEM_OVERLAY_SHADOW_COLOR'
  298. );
  299. var itemErrorColorProp = root.query(
  300. 'GET_FILE_POSTER_ITEM_OVERLAY_ERROR_COLOR'
  301. );
  302. var itemSuccessColorProp = root.query(
  303. 'GET_FILE_POSTER_ITEM_OVERLAY_SUCCESS_COLOR'
  304. );
  305. if (itemShadowColorProp && itemShadowColorProp !== itemShadowColor) {
  306. itemShadowColor = itemShadowColorProp;
  307. drawTemplate(
  308. overlayTemplateShadow,
  309. width,
  310. height,
  311. itemShadowColor,
  312. 0.85
  313. );
  314. }
  315. if (itemErrorColorProp && itemErrorColorProp !== itemErrorColor) {
  316. itemErrorColor = itemErrorColorProp;
  317. drawTemplate(overlayTemplateError, width, height, itemErrorColor, 1);
  318. }
  319. if (itemSuccessColorProp && itemSuccessColorProp !== itemSuccessColor) {
  320. itemSuccessColor = itemSuccessColorProp;
  321. drawTemplate(
  322. overlayTemplateSuccess,
  323. width,
  324. height,
  325. itemSuccessColor,
  326. 1
  327. );
  328. }
  329. // image view
  330. var image = createPosterView(_);
  331. // append image presenter
  332. root.ref.image = root.appendChildView(
  333. root.createChildView(image, {
  334. id: props.id,
  335. scaleX: 1.25,
  336. scaleY: 1.25,
  337. opacity: 0
  338. })
  339. );
  340. // image overlays
  341. root.ref.overlayShadow = root.appendChildView(
  342. root.createChildView(overlay, {
  343. template: overlayTemplateShadow,
  344. opacity: 0
  345. })
  346. );
  347. root.ref.overlaySuccess = root.appendChildView(
  348. root.createChildView(overlay, {
  349. template: overlayTemplateSuccess,
  350. opacity: 0
  351. })
  352. );
  353. root.ref.overlayError = root.appendChildView(
  354. root.createChildView(overlay, {
  355. template: overlayTemplateError,
  356. opacity: 0
  357. })
  358. );
  359. };
  360. return _.utils.createView({
  361. name: 'file-poster-wrapper',
  362. create: create,
  363. write: _.utils.createRoute({
  364. // image preview stated
  365. DID_FILE_POSTER_LOAD: didLoadPreview,
  366. DID_FILE_POSTER_DRAW: didDrawPreview,
  367. DID_FILE_POSTER_CONTAINER_CREATE: didCreatePreviewContainer,
  368. // file states
  369. DID_THROW_ITEM_LOAD_ERROR: didThrowError,
  370. DID_THROW_ITEM_PROCESSING_ERROR: didThrowError,
  371. DID_THROW_ITEM_INVALID: didThrowError,
  372. DID_COMPLETE_ITEM_PROCESSING: didCompleteProcessing,
  373. DID_START_ITEM_PROCESSING: restoreOverlay,
  374. DID_REVERT_ITEM_PROCESSING: restoreOverlay
  375. })
  376. });
  377. };
  378. /**
  379. * File Poster Plugin
  380. */
  381. var plugin = function plugin(fpAPI) {
  382. var addFilter = fpAPI.addFilter,
  383. utils = fpAPI.utils;
  384. var Type = utils.Type,
  385. createRoute = utils.createRoute;
  386. // filePosterView
  387. var filePosterView = createPosterWrapperView(fpAPI);
  388. // called for each view that is created right after the 'create' method
  389. addFilter('CREATE_VIEW', function(viewAPI) {
  390. // get reference to created view
  391. var is = viewAPI.is,
  392. view = viewAPI.view,
  393. query = viewAPI.query;
  394. // only hook up to item view and only if is enabled for this cropper
  395. if (!is('file') || !query('GET_ALLOW_FILE_POSTER')) return;
  396. // create the file poster plugin, but only do so if the item is an image
  397. var didLoadItem = function didLoadItem(_ref) {
  398. var root = _ref.root,
  399. props = _ref.props;
  400. updateItemPoster(root, props);
  401. };
  402. var didUpdateItemMetadata = function didUpdateItemMetadata(_ref2) {
  403. var root = _ref2.root,
  404. props = _ref2.props,
  405. action = _ref2.action;
  406. if (!/poster/.test(action.change.key)) return;
  407. updateItemPoster(root, props);
  408. };
  409. var updateItemPoster = function updateItemPoster(root, props) {
  410. var id = props.id;
  411. var item = query('GET_ITEM', id);
  412. // item could theoretically have been removed in the mean time
  413. if (!item || !item.getMetadata('poster') || item.archived) return;
  414. // don't update if is the same poster
  415. if (root.ref.previousPoster === item.getMetadata('poster')) return;
  416. root.ref.previousPoster = item.getMetadata('poster');
  417. // test if is filtered
  418. if (!query('GET_FILE_POSTER_FILTER_ITEM')(item)) return;
  419. if (root.ref.filePoster) {
  420. view.removeChildView(root.ref.filePoster);
  421. }
  422. // set preview view
  423. root.ref.filePoster = view.appendChildView(
  424. view.createChildView(filePosterView, { id: id })
  425. );
  426. // now ready
  427. root.dispatch('DID_FILE_POSTER_CONTAINER_CREATE', { id: id });
  428. };
  429. var didCalculatePreviewSize = function didCalculatePreviewSize(_ref3) {
  430. var root = _ref3.root,
  431. action = _ref3.action;
  432. // no poster set
  433. if (!root.ref.filePoster) return;
  434. // remember dimensions
  435. root.ref.imageWidth = action.width;
  436. root.ref.imageHeight = action.height;
  437. root.ref.shouldUpdatePanelHeight = true;
  438. root.dispatch('KICK');
  439. };
  440. var getPosterHeight = function getPosterHeight(_ref4) {
  441. var root = _ref4.root;
  442. var fixedPosterHeight = root.query('GET_FILE_POSTER_HEIGHT');
  443. // if fixed height: return fixed immediately
  444. if (fixedPosterHeight) {
  445. return fixedPosterHeight;
  446. }
  447. var minPosterHeight = root.query('GET_FILE_POSTER_MIN_HEIGHT');
  448. var maxPosterHeight = root.query('GET_FILE_POSTER_MAX_HEIGHT');
  449. // if natural height is smaller than minHeight: return min height
  450. if (minPosterHeight && root.ref.imageHeight < minPosterHeight) {
  451. return minPosterHeight;
  452. }
  453. var height =
  454. root.rect.element.width *
  455. (root.ref.imageHeight / root.ref.imageWidth);
  456. if (minPosterHeight && height < minPosterHeight) {
  457. return minPosterHeight;
  458. }
  459. if (maxPosterHeight && height > maxPosterHeight) {
  460. return maxPosterHeight;
  461. }
  462. return height;
  463. };
  464. // start writing
  465. view.registerWriter(
  466. createRoute(
  467. {
  468. DID_LOAD_ITEM: didLoadItem,
  469. DID_FILE_POSTER_CALCULATE_SIZE: didCalculatePreviewSize,
  470. DID_UPDATE_ITEM_METADATA: didUpdateItemMetadata
  471. },
  472. function(_ref5) {
  473. var root = _ref5.root,
  474. props = _ref5.props;
  475. // don't run without poster
  476. if (!root.ref.filePoster) return;
  477. // don't do anything while hidden
  478. if (root.rect.element.hidden) return;
  479. // should we redraw
  480. if (root.ref.shouldUpdatePanelHeight) {
  481. // time to resize the parent panel
  482. root.dispatch('DID_UPDATE_PANEL_HEIGHT', {
  483. id: props.id,
  484. height: getPosterHeight({ root: root })
  485. });
  486. // done!
  487. root.ref.shouldUpdatePanelHeight = false;
  488. }
  489. }
  490. )
  491. );
  492. });
  493. // expose plugin
  494. return {
  495. options: {
  496. // Enable or disable file poster
  497. allowFilePoster: [true, Type.BOOLEAN],
  498. // Fixed preview height
  499. filePosterHeight: [null, Type.INT],
  500. // Min image height
  501. filePosterMinHeight: [null, Type.INT],
  502. // Max image height
  503. filePosterMaxHeight: [null, Type.INT],
  504. // filters file items to determine which are shown as poster
  505. filePosterFilterItem: [
  506. function() {
  507. return true;
  508. },
  509. Type.FUNCTION
  510. ],
  511. // Enables or disables reading average image color
  512. filePosterCalculateAverageImageColor: [false, Type.BOOLEAN],
  513. // Allows setting the value of the CORS attribute (null is don't set attribute)
  514. filePosterCrossOriginAttributeValue: ['Anonymous', Type.STRING],
  515. // Colors used for item overlay gradient
  516. filePosterItemOverlayShadowColor: [null, Type.ARRAY],
  517. filePosterItemOverlayErrorColor: [null, Type.ARRAY],
  518. filePosterItemOverlaySuccessColor: [null, Type.ARRAY]
  519. }
  520. };
  521. };
  522. // fire pluginloaded event if running in browser, this allows registering the plugin when using async script tags
  523. var isBrowser =
  524. typeof window !== 'undefined' && typeof window.document !== 'undefined';
  525. if (isBrowser) {
  526. document.dispatchEvent(
  527. new CustomEvent('FilePond:pluginloaded', { detail: plugin })
  528. );
  529. }
  530. return plugin;
  531. });