ScrollBehaviorMixin revert

zdhxiong · Feb 18, 2024 · 6d4ad19 · 6d4ad19
1 parent abb0b71
commit 6d4ad19
Show file tree

Hide file tree

Showing 3 changed files with 19 additions and 17 deletions.
diff --git a/docs/en.json b/docs/en.json
@@ -186,6 +186,7 @@
         }
       },
       "tagNames": [
+        "mdui-button-icon",
         "mdui-card",
         "mdui-list-item",
         "mdui-menu-item",
@@ -203,6 +204,7 @@
         }
       },
       "tagNames": [
+        "mdui-button-icon",
         "mdui-card",
         "mdui-checkbox",
         "mdui-list-item",
@@ -214,8 +216,8 @@
         "mdui-select",
         "mdui-slider",
         "mdui-switch",
-        "mdui-text-field",
-        "mdui-tab"
+        "mdui-tab",
+        "mdui-text-field"
       ],
       "methods": {
         "click": "Simulates a mouse click on the element.",
@@ -2177,12 +2179,7 @@
         "description": "Shrinks the app bar to `small` style. Only applicable for `medium` or `large` variants."
       },
       "scrollBehavior": {
-        "description": "Defines the scroll behavior. Accepts multiple space-separated values. Possible values:\n\n* `hide`: Hides when scrolling.\n* `shrink`: Shrinks when scrolling for medium to large app bars.\n* `elevate`: Increases elevation when scrolling.",
-        "enum": {
-          "hide": "Hides when scrolling.",
-          "shrink": "Shrinks when scrolling for medium to large app bars",
-          "elevate": "Increases elevation when scrolling."
-        }
+        "description": "Defines the scroll behavior. Accepts multiple space-separated values. Possible values:\n\n* `hide`: Hides when scrolling.\n* `shrink`: Shrinks when scrolling for medium to large app bars.\n* `elevate`: Increases elevation when scrolling."
       }
     },
     "events": {

diff --git a/docs/zh-cn.json b/docs/zh-cn.json
@@ -186,6 +186,7 @@
         }
       },
       "tagNames": [
+        "mdui-button-icon",
         "mdui-card",
         "mdui-list-item",
         "mdui-menu-item",
@@ -203,6 +204,7 @@
         }
       },
       "tagNames": [
+        "mdui-button-icon",
         "mdui-card",
         "mdui-checkbox",
         "mdui-list-item",
@@ -2177,12 +2179,7 @@
         "description": "是否缩小为 `variant=\"small\"` 的样式，仅在 `variant=\"medium\"` 或 `variant=\"large\"` 时生效"
       },
       "scrollBehavior": {
-        "description": "滚动行为。可同时使用多个值，用空格分隔。可选值包括：\n\n* `hide`：滚动时隐藏\n* `shrink`：在中型、大型应用栏中可使用，滚动时缩小成小型应用栏的样式\n* `elevate`：滚动时添加阴影",
-        "enum": {
-          "hide": "滚动时隐藏",
-          "shrink": "在中型、大型应用栏中可使用，滚动时缩小成小型应用栏的样式",
-          "elevate": "滚动时添加阴影"
-        }
+        "description": "滚动行为。可同时使用多个值，用空格分隔。可选值包括：\n\n* `hide`：滚动时隐藏\n* `shrink`：在中型、大型应用栏中可使用，滚动时缩小成小型应用栏的样式\n* `elevate`：滚动时添加阴影"
       }
     },
     "events": {

diff --git a/packages/shared/src/mixins/scrollBehavior.ts b/packages/shared/src/mixins/scrollBehavior.ts
@@ -42,6 +42,17 @@ export const ScrollBehaviorMixin = <T extends Constructor<LitElement>>(
     @property({ attribute: 'scroll-target' })
     public scrollTarget?: string | HTMLElement | JQ<HTMLElement>;
 
+    /**
+     * 滚动行为。可选值为：
+     * * `hide`：滚动时隐藏
+     * * `shrink`：滚动时缩小
+     * * `elevate`：滚动时增加阴影
+     *
+     * todo: 生成 custom-elements.json 时，属性名的注释用了父类的，属性枚举值的类型和注释用了该类的。期望都使用父类的。
+     */
+    @property({ reflect: true, attribute: 'scroll-behavior' })
+    public scrollBehavior?: 'hide' | 'shrink' | 'elevate';
+
     /**
      * 在滚动多少距离之后触发滚动行为，单位为 `px`
      */
@@ -90,7 +101,6 @@ export const ScrollBehaviorMixin = <T extends Constructor<LitElement>>(
         this.updateContainerPadding();
       }
 
-      // @ts-ignore
       if (!this.scrollBehavior) {
         return;
       }
@@ -122,7 +132,6 @@ export const ScrollBehaviorMixin = <T extends Constructor<LitElement>>(
         return;
       }
 
-      // @ts-ignore
       if (this.scrollBehavior) {
         this.updateScrollTop(listening);
 
@@ -157,7 +166,6 @@ export const ScrollBehaviorMixin = <T extends Constructor<LitElement>>(
     protected hasScrollBehavior(
       behavior: ScrollBehavior | ScrollBehavior[],
     ): boolean {
-      // @ts-ignore
       const behaviors = (this.scrollBehavior?.split(' ') ??
         []) as ScrollBehavior[];