@next-bricks/form 0.19.3 → 0.19.5

package/dist-types/bootstrap.d.ts

@@ -15,3 +15,4 @@ import "./upload/upload-file/index.js";
 import "./auto-complete/index.js";
 import "./time-picker/index.js";
 import "./date-picker/index.js";
+import "./time-range-picker/index.js";

package/dist-types/time-range-picker/i18n.d.ts

@@ -0,0 +1,21 @@
+export declare enum K {
+    TODAY = "TODAY",
+    THIS_WEEK = "THIS_WEEK",
+    THIS_MONTH = "THIS_MONTH",
+    THIS_QUARTER = "THIS_QUARTER",
+    THIS_YEAR = "THIS_YEAR",
+    START_TIME_END_TIME_CANNOT_EQUAL = "START_TIME_END_TIME_CANNOT_EQUAL",
+    START_TIME_REQUIRED = "START_TIME_REQUIRED",
+    END_TIME_REQUIRED = "END_TIME_REQUIRED"
+}
+export declare const NS = "bricks/form/eo-time-range-picker";
+export declare const locales: {
+    en: Locale;
+    zh: Locale;
+};
+type Locale = {
+    [k in K]: string;
+} & {
+    [k in K as `${k}_plural`]?: string;
+};
+export {};

package/dist-types/time-range-picker/index.d.ts

@@ -0,0 +1,80 @@
+import React from "react";
+import { FormItemElementBase, MessageBody } from "@next-shared/form";
+import type { FormItemProps } from "../form-item/index.jsx";
+import "@next-core/theme";
+import "dayjs/locale/zh-cn.js";
+export declare enum presetRangeType {
+    Today = "\u4ECA\u5929",
+    ThisWeek = "\u672C\u5468",
+    ThisMonth = "\u672C\u6708",
+    ThisQuarter = "\u672C\u5B63\u5EA6",
+    ThisYear = "\u4ECA\u5E74"
+}
+export interface TimeRange {
+    startTime: string;
+    endTime: string;
+}
+type PickerType = "date" | "week" | "month" | "quarter" | "year";
+type OtherPickerType = "dateTime" | "hmTime" | "time";
+export type RangeType = PickerType & OtherPickerType;
+export interface EoTimeRangePickerProps extends FormItemProps {
+    shadowRoot?: ShadowRoot | null;
+    value?: TimeRange;
+    format: string;
+    rangeType?: RangeType;
+    onChange?: (range: TimeRange) => void;
+    emitChangeOnInit?: boolean;
+    selectNearDays?: number;
+    presetRanges?: presetRangeType[];
+}
+type RealTimeRangePickerProps = Omit<EoTimeRangePickerProps, keyof FormItemProps>;
+/**
+ * 构件 `eo-time-range-picker`
+ */
+export declare class EoTimeRangePicker extends FormItemElementBase {
+    #private;
+    /**
+     * 时间段选择器字段名
+     */
+    accessor name: string | undefined;
+    /**
+     * 时间段选择器说明
+     */
+    accessor label: string | undefined;
+    /**
+     *时间段选择器的初始值
+     * @default { "startTime": "00:00:00", "endTime": "23:59:59" }
+     */
+    accessor value: TimeRange | undefined;
+    /**
+     * 是否必填
+     */
+    accessor required: boolean | undefined;
+    /**
+     * 时间段类型
+     */
+    accessor rangeType: RangeType | undefined;
+    /**
+     * 只有rangeType在`date` 和 `dateTime`下， 才支持只选择最近n天(当前时间向前n天)
+     */
+    accessor selectNearDays: number | undefined;
+    /**
+     * @default  true
+     * 是否在初始化完成后额外触发一次`time.range.change`, 这里因为历史原因之前默认行为就是在初始化后会触发该事件，这里为了兼容之前的行为，默认值只能设置为 true。
+     */
+    accessor emitChangeOnInit: boolean | undefined;
+    /**
+     * @default  []
+     * 预设时间范围快捷选择；设置了属性selectNearDays时，属性presetRanges不生效；属性rangeType为week时，presetRanges的值只能为本周、本月、本季度、今年，属性rangeType为month、quarter、year时，以此类推
+     */
+    accessor presetRanges: presetRangeType[] | undefined;
+    accessor validator: ((value: any) => MessageBody | string) | undefined;
+    handleChange: (value: TimeRange) => void;
+    unequal: (value: TimeRange) => string;
+    startTimeRequired: (value: TimeRange) => string;
+    endTimeRequired: (value: TimeRange) => string;
+    render(): JSX.Element;
+}
+export declare function RealTimeRangePicker(props: RealTimeRangePickerProps): React.ReactElement;
+export declare function EoTimeRangePickerComponent(props: EoTimeRangePickerProps): JSX.Element;
+export {};

package/dist-types/time-range-picker/index.spec.d.ts

@@ -0,0 +1 @@
+import "./";

package/docs/eo-time-range-picker.md

@@ -0,0 +1,108 @@
+构件 `eo-time-range-picker`
+
+## Examples
+
+### Basic
+
+```yaml preview
+- brick: eo-time-range-picker
+  properties:
+    label: hello
+    name: time
+```
+
+### rangeType
+
+```yaml preview
+- brick: eo-radio
+  properties:
+    options:
+      - time
+      - date
+      - dateTime
+      - hmTime
+      - week
+      - month
+      - quarter
+      - year
+  events:
+    change:
+      - target: "#rangePicker"
+        properties:
+          rangeType: <% EVENT.detail.value %>
+- brick: eo-time-range-picker
+  properties:
+    label: hello
+    name: time
+    id: rangePicker
+    rangeType: date
+```
+
+### presetRanges
+
+```yaml preview
+- brick: eo-time-range-picker
+  properties:
+    label: hello
+    name: time
+    rangeType: week
+    required: true
+    presetRanges:
+      - 本周
+      - 本月
+      - 本季度
+      - 今年
+```
+
+### validate
+
+```yaml preview
+- brick: eo-form
+  events:
+    values.change:
+      - action: console.log
+    validate.success:
+      - action: message.success
+        args:
+          - 表单提交成功
+    validate.error:
+      - action: message.error
+        args:
+          - 表单校验失败
+  slots:
+    "":
+      bricks:
+        - brick: eo-time-range-picker
+          events:
+            change:
+              action: console.log
+          properties:
+            label: hello
+            name: time
+            required: true
+        - brick: eo-submit-buttons
+```
+
+### selectNearDays
+
+```yaml preview
+- brick: eo-time-range-picker
+  events:
+    - action: console.log
+  properties:
+    label: hello
+    name: time
+    selectNearDays: 10
+    rangeType: date
+```
+
+### Events
+
+```yaml preview
+- brick: eo-time-range-picker
+  events:
+    - action: console.log
+  properties:
+    label: hello
+    name: time
+```

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@next-bricks/form",
-  "version": "0.19.3",
+  "version": "0.19.5",
   "homepage": "https://github.com/easyops-cn/next-bricks/tree/master/bricks/form",
   "repository": {
     "type": "git",
@@ -37,5 +37,5 @@
     "@next-core/build-next-bricks": "^1.14.2",
     "@next-core/test-next": "^1.0.10"
   },
-  "gitHead": "fd6478366e59628c3382b0488fa856421bb410e9"
+  "gitHead": "6bb93b55108ae2a4a415b6d26306c4f01434d659"
 }