WRR-387: Updated documentation for Panels arranger

Enact-DCO-1.0-Signed-off-by: Jiye Kim (jiye.kim@lge.com)
enactjs · Nov 18, 2024 · 8e5369d · 8e5369d
1 parent 3ad4630
commit 8e5369d
Showing 1 changed file with 3 additions and 0 deletions.
diff --git a/internal/Panels/Arrangers.js b/internal/Panels/Arrangers.js
@@ -129,6 +129,9 @@ const deferArrange = (config, keyframes, options) => {
 /**
  * Arranger that slides panels in from the right and out to the left.
  *
+ * This arranger is visually same as {@link ui/ViewManager.SlideLeftArranger} when transition but uses transform percentages instead of pixel values.
+ * Because BasicArranger is an optimized version of {@link ui/ViewManager.SlideLeftArranger}, {@link ui/ViewManager.SlideLeftArranger} can be written in documentation instead of BasicArranger in unavoidable case.
+ *
  * @type {Arranger}
  * @private
  */