add comment about the base-z = 3000 consideration

loadingio · Jan 5, 2023 · 33c0c8f · 33c0c8f
1 parent ab5cf18
commit 33c0c8f
Show file tree

Hide file tree

Showing 3 changed files with 42 additions and 0 deletions.
diff --git a/dist/index.js b/dist/index.js
diff --git a/src/index.ls b/src/index.ls
@@ -11,6 +11,20 @@ ldcvmgr = (opt={}) ->
   @error-handling = false
   @prepare-proxy = proxise (n) ->
   if opt.zmgr => @zmgr opt.zmgr
+  /*
+  originally we use `modal` for base-z if zmgr is provided.
+  this scope the zmgr into `modal`, which may have issues if we want to
+  manage z-index along with loaders or other elements.
+  additionally, user will have to remember to config their manually
+  created ldcover with `modal` `base-z`, otherwise the z-index won't
+  align.
+
+  this really causes some issue so instead of hard code a default `modal`,
+  we use 3000 as default value for user to overwrite.
+
+  there may stlil be issues if we change ldcover's default base-z,
+  which is unlikely to happen anyway.
+  */
   @base-z = opt.base-z or 3000
   if opt.auto-init => @init!
   @

diff --git a/web/static/assets/lib/ldcvmgr/dev/index.js b/web/static/assets/lib/ldcvmgr/dev/index.js