feffery_utils_components 0.0.21 → 0.0.22

package/feffery_utils_components/metadata.json

@@ -884,6 +884,76 @@
       }
     }
   },
+  "src/lib/components/FefferyCountDown.react.js": {
+    "description": "",
+    "displayName": "FefferyCountDown",
+    "methods": [],
+    "props": {
+      "id": {
+        "type": {
+          "name": "string"
+        },
+        "required": false,
+        "description": ""
+      },
+      "delay": {
+        "type": {
+          "name": "number"
+        },
+        "required": false,
+        "description": ""
+      },
+      "interval": {
+        "type": {
+          "name": "number"
+        },
+        "required": false,
+        "description": "",
+        "defaultValue": {
+          "value": "1",
+          "computed": false
+        }
+      },
+      "countdown": {
+        "type": {
+          "name": "number"
+        },
+        "required": false,
+        "description": ""
+      },
+      "setProps": {
+        "type": {
+          "name": "func"
+        },
+        "required": false,
+        "description": "Dash-assigned callback that should be called to report property changes\r\nto Dash, to make them available for callbacks."
+      },
+      "loading_state": {
+        "type": {
+          "name": "shape",
+          "value": {
+            "is_loading": {
+              "name": "bool",
+              "description": "Determines if the component is loading or not",
+              "required": false
+            },
+            "prop_name": {
+              "name": "string",
+              "description": "Holds which property is loading",
+              "required": false
+            },
+            "component_name": {
+              "name": "string",
+              "description": "Holds the name of the component that is loading",
+              "required": false
+            }
+          }
+        },
+        "required": false,
+        "description": ""
+      }
+    }
+  },
   "src/lib/components/FefferyExecuteJs.react.js": {
     "description": "",
     "displayName": "FefferyExecuteJs",

package/feffery_utils_components/package-info.json

@@ -1,6 +1,6 @@
 {
   "name": "feffery_utils_components",
-  "version": "0.0.21",
+  "version": "0.0.22",
   "description": "Build more utility components for Plotly Dash.",
   "repository": {
     "type": "git",

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "feffery_utils_components",
-  "version": "0.0.21",
+  "version": "0.0.22",
   "description": "Build more utility components for Plotly Dash.",
   "repository": {
     "type": "git",

package/src/FefferyUtilsComponents.jl

@@ -3,7 +3,7 @@ module FefferyUtilsComponents
 using Dash
 
 const resources_path = realpath(joinpath( @__DIR__, "..", "deps"))
-const version = "0.0.21"
+const version = "0.0.22"
 
 include("jl/''_fefferyblockcolorpicker.jl")
 include("jl/''_fefferycirclecolorpicker.jl")
@@ -15,6 +15,7 @@ include("jl/''_fefferywheelcolorpicker.jl")
 include("jl/''_fefferyexternalcss.jl")
 include("jl/''_fefferysettitle.jl")
 include("jl/''_fefferycaptcha.jl")
+include("jl/''_fefferycountdown.jl")
 include("jl/''_fefferyexecutejs.jl")
 include("jl/''_fefferyextraspinner.jl")
 include("jl/''_fefferyguide.jl")
@@ -48,14 +49,14 @@ function __init__()
             [
                 DashBase.Resource(
     relative_package_path = "feffery_utils_components.min.js",
-    external_url = "https://unpkg.com/feffery_utils_components@0.0.21/feffery_utils_components/feffery_utils_components.min.js",
+    external_url = "https://unpkg.com/feffery_utils_components@0.0.22/feffery_utils_components/feffery_utils_components.min.js",
     dynamic = nothing,
     async = nothing,
     type = :js
 ),
 DashBase.Resource(
     relative_package_path = "feffery_utils_components.min.js.map",
-    external_url = "https://unpkg.com/feffery_utils_components@0.0.21/feffery_utils_components/feffery_utils_components.min.js.map",
+    external_url = "https://unpkg.com/feffery_utils_components@0.0.22/feffery_utils_components/feffery_utils_components.min.js.map",
     dynamic = true,
     async = nothing,
     type = :js

package/src/jl/''_fefferycountdown.jl

@@ -0,0 +1,26 @@
+# AUTO GENERATED FILE - DO NOT EDIT
+
+export ''_fefferycountdown
+
+"""
+    ''_fefferycountdown(;kwargs...)
+
+A FefferyCountDown component.
+
+Keyword arguments:
+- `id` (String; optional)
+- `countdown` (Real; optional)
+- `delay` (Real; optional)
+- `interval` (Real; optional)
+- `loading_state` (optional): . loading_state has the following type: lists containing elements 'is_loading', 'prop_name', 'component_name'.
+Those elements have the following types:
+  - `is_loading` (Bool; optional): Determines if the component is loading or not
+  - `prop_name` (String; optional): Holds which property is loading
+  - `component_name` (String; optional): Holds the name of the component that is loading
+"""
+function ''_fefferycountdown(; kwargs...)
+        available_props = Symbol[:id, :countdown, :delay, :interval, :loading_state]
+        wild_props = Symbol[]
+        return Component("''_fefferycountdown", "FefferyCountDown", "feffery_utils_components", available_props, wild_props; kwargs...)
+end
+

package/src/lib/components/FefferyCountDown.react.js

@@ -0,0 +1,92 @@
+import { useEffect, useState } from 'react';
+import { useCountDown } from 'ahooks';
+import PropTypes from 'prop-types';
+
+// 定义倒计时执行组件FefferyCountDown
+const FefferyCountDown = (props) => {
+
+    const {
+        id,
+        delay,
+        interval,
+        setProps,
+        loading_state
+    } = props;
+
+    const [targetDate, setTargetDate] = useState(null);
+
+    useEffect(() => {
+        if (delay) {
+            setTargetDate(Date.now() + 1000 * delay)
+        }
+    }, [delay])
+
+    const [_countdown] = useCountDown({
+        targetDate: targetDate,
+        interval: interval * 1000,
+        onEnd: () => {
+            setProps({
+                delay: undefined,
+                countdown: 0
+            })
+        }
+    });
+
+    useEffect(() => {
+        if (_countdown && delay) {
+            setProps({
+                countdown: Math.round(_countdown / 1000)
+            })
+        }
+    }, [_countdown])
+
+    return (<div
+        id={id}
+        data-dash-is-loading={
+            (loading_state && loading_state.is_loading) || undefined
+        } />);
+}
+
+// 定义参数或属性
+FefferyCountDown.propTypes = {
+    // 部件id
+    id: PropTypes.string,
+
+    // 用于设置距离下一次超时事件触发的倒计时间隔（单位：秒）
+    // 每次有效的delay对应超时事件结束后都会被重置为undefined
+    delay: PropTypes.number,
+
+    // 设置倒计时时间间隔（单位：秒），默认为1
+    interval: PropTypes.number,
+
+    // 监听当前剩余时间秒数，默认为0
+    countdown: PropTypes.number,
+
+    /**
+     * Dash-assigned callback that should be called to report property changes
+     * to Dash, to make them available for callbacks.
+     */
+    setProps: PropTypes.func,
+
+    loading_state: PropTypes.shape({
+        /**
+         * Determines if the component is loading or not
+         */
+        is_loading: PropTypes.bool,
+        /**
+         * Holds which property is loading
+         */
+        prop_name: PropTypes.string,
+        /**
+         * Holds the name of the component that is loading
+         */
+        component_name: PropTypes.string
+    })
+};
+
+// 设置默认参数
+FefferyCountDown.defaultProps = {
+    interval: 1
+}
+
+export default React.memo(FefferyCountDown);

package/src/lib/index.js

@@ -32,6 +32,7 @@ import FefferyIdle from "./components/listeners/FefferyIdle.react";
 import FefferyWindowSize from "./components/listeners/FefferyWindowSize.react";
 import FefferyKeyPress from "./components/listeners/FefferyKeyPress.react";
 import FefferyTimeout from "./components/FefferyTimeout.react";
+import FefferyCountDown from "./components/FefferyCountDown.react";
 
 /* 
 忽略部分设计React中规范的console警告信息
@@ -88,5 +89,6 @@ export {
     FefferyIdle,
     FefferyWindowSize,
     FefferyKeyPress,
-    FefferyTimeout
+    FefferyTimeout,
+    FefferyCountDown
 };

package/tests/FefferyCountDownTest/app.py

@@ -0,0 +1,53 @@
+if True:
+    import sys
+    import time
+    sys.path.append('../..')
+    import dash
+    from dash import html, dcc
+    import feffery_utils_components as fuc
+    from dash.dependencies import Input, Output, State
+
+
+app = dash.Dash(__name__)
+
+app.layout = html.Div(
+    [
+        fuc.FefferyCountDown(
+            id='count-down-demo',
+            interval=2
+        ),
+        html.Button(
+            '设置10秒倒计时',
+            id='set-10s-count-down'
+        ),
+        html.Div(id='count-down-output')
+    ],
+    style={
+        'height': '2000px'
+    }
+)
+
+
+@app.callback(
+    Output('count-down-demo', 'delay'),
+    Input('set-10s-count-down', 'n_clicks')
+)
+def demo1(n_clicks):
+
+    if n_clicks:
+        return 10
+
+
+@app.callback(
+    Output('count-down-output', 'children'),
+    Input('count-down-demo', 'countdown')
+)
+def demo2(countdown):
+
+    print(countdown)
+
+    return countdown
+
+
+if __name__ == '__main__':
+    app.run(debug=True)