Fix `Util.reflow` function and add documentation (#34543)

* add documentation to reflow function

* refactor to void as it should be

Co-authored-by: XhmikosR <[email protected]>

1 files changed, 12 insertions, 1 deletions

diff --git a/js/src/util/index.js b/js/src/util/index.js
index a1af87aa4..f81d64837 100644
--- a/js/src/util/index.js
+++ b/js/src/util/index.js
@@ -188,7 +188,18 @@ const findShadowRoot = element => {
 
 const noop = () => {}
 
-const reflow = element => element.offsetHeight
+/**
+ * Trick to restart an element's animation
+ *
+ * @param {HTMLElement} element
+ * @return void
+ *
+ * @see https://www.charistheo.io/blog/2021/02/restart-a-css-animation-with-javascript/#restarting-a-css-animation
+ */
+const reflow = element => {
+  // eslint-disable-next-line no-unused-expressions
+  element.offsetHeight
+}
 
 const getjQuery = () => {
   const { jQuery } = window