refactor: move 'restoreScrollPosition' to the 'features' option

qq15725 · Apr 10, 2024 · 313b131 · 313b131
1 parent 0a09e9a
commit 313b131
Show file tree

Hide file tree

Showing 3 changed files with 11 additions and 9 deletions.
diff --git a/src/clone-node.ts b/src/clone-node.ts
@@ -41,7 +41,7 @@ async function appendChildNode<T extends Node>(
 
   const childCloned = await cloneNode(child, context)
 
-  if (context.restoreScrollPosition) {
+  if (context.isEnable('restoreScrollPosition')) {
     restoreScrollPosition(node, childCloned)
   }
 

diff --git a/src/create-context.ts b/src/create-context.ts
@@ -59,7 +59,6 @@ export async function createContext<T extends Node>(node: T, options?: Options &
     onCreateForeignObjectSvg: null,
     includeStyleProperties: null,
     autoDestruct: false,
-    restoreScrollPosition: false,
     ...options,
 
     // InternalContext
@@ -114,6 +113,9 @@ export async function createContext<T extends Node>(node: T, options?: Options &
 
     features,
     isEnable: (key: string): boolean => {
+      if (key === 'restoreScrollPosition') {
+        return typeof features === 'boolean' ? false : (features as any)[key] ?? false
+      }
       if (typeof features === 'boolean') {
         return features
       }

diff --git a/src/options.ts b/src/options.ts
@@ -166,6 +166,13 @@ export interface Options {
      * default: true
      */
     fixSvgXmlDecode?: boolean
+
+    /**
+     * Render scrolled children with scrolled content
+     *
+     * default: false
+     */
+    restoreScrollPosition?: boolean
   }
 
   /**
@@ -208,11 +215,4 @@ export interface Options {
    * This can be useful for performance-critical scenarios.
    */
   includeStyleProperties?: string[] | null
-
-  /**
-   * Render scrolled children with scrolled content
-   *
-   * default: false
-   */
-  restoreScrollPosition?: boolean
 }