@opentiny/vue-search-box 0.0.1

package/types/utils/date.d.ts

@@ -0,0 +1,234 @@
+/**
+ * Copyright (c) 2022 - present TinyVue Authors.
+ * Copyright (c) 2022 - present Huawei Cloud Computing Technologies Co., Ltd.
+ *
+ * Use of this source code is governed by an MIT-style license.
+ *
+ * THE OPEN SOURCE SOFTWARE IN THIS PRODUCT IS DISTRIBUTED IN THE HOPE THAT IT WILL BE USEFUL,
+ * BUT WITHOUT ANY WARRANTY, WITHOUT EVEN THE IMPLIED WARRANTY OF MERCHANTABILITY OR FITNESS FOR
+ * A PARTICULAR PURPOSE. SEE THE APPLICABLE LICENSES FOR MORE DETAILS.
+ *
+ */
+/**
+ * 填充字符串，根据填充模式参数，在字符串前面或后面补充字附到指定的长度。
+ *
+ *     fillChar('1', 3)            // "001"
+ *     fillChar('1', 3, true)      // "100"
+ *     fillChar('1', 3, true, ' ') // "1  "
+ *
+ * @param {String} string 被填充的字符串
+ * @param {Number} length 填充到某个长度
+ * @param {Boolean} [append=false] 是否在后面填充，默认为在前面填充
+ * @param {String} [chr="0"] 填充的字符，默认为0
+ * @returns {String}
+ */
+export declare const fillChar: (string: any, length: any, append: any, chr?: string) => string;
+export declare const toString: () => string;
+export declare const hasOwn: (v: PropertyKey) => boolean;
+/** 判断是否为 null / undefined */
+export declare const isNull: (x: any) => boolean;
+/**
+ * 返回 JavaScript 对象的类型。
+ *
+ * 如果对象是 undefined 或 null，则返回相应的'undefined'或'null'。
+ *
+ * 其他一切都将返回它的类型'object'。
+ *
+ *     typeOf( undefined ) === 'undefined'
+ *     typeOf() === 'undefined'
+ *     typeOf( window.notDefined ) === 'undefined'
+ *     typeOf( null ) === 'null'
+ *     typeOf( true ) === 'boolean'
+ *     typeOf( 3 ) === 'number'
+ *     typeOf( "test" ) === 'string'
+ *     typeOf( function (){} ) === 'function'
+ *     typeOf( [] ) === 'array'
+ *     typeOf( new Date() ) === 'date'
+ *     typeOf( new Error() ) === 'error'
+ *     typeOf( /test/ ) === 'regExp'
+ *
+ */
+export declare const typeOf: (obj: any) => string;
+/**
+ * 判断对象是否为 object 类型。
+ *
+ *     isObject({}) // true
+ */
+export declare const isObject: (obj: any) => boolean;
+/**
+ * 判断对象是否为 function 类型。
+ *
+ *     isObject(function (){) // true
+
+ */
+export declare const isFunction: (fn: any) => boolean;
+/**
+ * 判断对象是否为简单对象。
+ *
+ * 即不是 HTML 节点对象，也不是 window 对象，而是纯粹的对象（通过 '{}' 或者 'new Object' 创建的）。
+ *
+ *     let obj = {}
+ *     isPlainObject(obj) //true
+ */
+export declare const isPlainObject: (obj: any) => boolean;
+/**
+ * 检查对象是否为空（不包含任何属性）。
+ *
+ *     let obj = {}
+ *     isEmptyObject(obj) // true
+ */
+export declare const isEmptyObject: (obj: any) => boolean;
+/**
+ * 判断对象是否为数字类型。
+ *
+ *     isNumber(369) // true
+ */
+export declare const isNumber: (value: any) => boolean;
+/**
+ * 判断对象是否代表一个数值。
+ *
+ *     isNumeric('-10')     // true
+ *     isNumeric(16)        // true
+ *     isNumeric(0xFF)      // true
+ *     isNumeric('0xFF')    // true
+ *     isNumeric('8e5')     // true
+ *     isNumeric(3.1415)    // true
+ *     isNumeric(+10)       // true
+ *     isNumeric('')        // false
+ *     isNumeric({})        // false
+ *     isNumeric(NaN)       // false
+ *     isNumeric(null)      // false
+ *     isNumeric(true)      // false
+ *     isNumeric(Infinity)  // false
+ *     isNumeric(undefined) // false
+ */
+export declare const isNumeric: (value: any) => boolean;
+/**
+ * 判断对象是否为日期类型。
+ *
+ *     let date = new Date()
+ *     isDate(date)  // true
+ */
+export declare const isDate: (value: any) => boolean;
+/**
+ * 判断两个值是否值相同且类型相同。
+ *
+ * 注：在 JavaScript 里 NaN === NaN 为 false，因此不能简单的用 === 来判断。
+ *
+ *     isSame(1, 1)     // true
+ *     isSame(NaN, NaN) // true
+ */
+export declare const isSame: (x: any, y: any) => boolean;
+/** 判断是否是正则表达式 */
+export declare const isRegExp: (value: any) => boolean;
+export declare const isPromise: (val: any) => boolean;
+/**
+ * 判断年份是否为闰年。
+ *
+ *     isLeapYear(2017)  // false
+ *     isLeapYear(2000)  // true
+ *
+ * @param {Number} year 年份
+ * @returns {Boolean}
+ */
+export declare const isLeapYear: (year: any) => boolean;
+/**
+ * 将字符串或数字转换成 Date 类型。
+ *
+ *     toDate('2008/02/02')             // new Date(2008, 1, 2)
+ *     toDate(Date.UTC(2008, 1, 2))     // new Date(Date.UTC(2008, 1, 2))
+ *     toDate('2008/2/2', 'yyyy/M/d')   // new Date(2008, 1, 2)
+ *     toDate('2008/02')                // new Date(2008, 1, 1)
+ *     toDate('02/2008')                // new Date(2008, 1, 1)
+ *     toDate('2008-02-01T20:08+08:00') // new Date(Date.UTC(2008, 0, 31, 16))
+ *     toDate('2008-02-01T04:08-08:00') // new Date(Date.UTC(2008, 1, 1, 8))
+ *
+ * @param {String|Number} value 日期类型字符串或数字
+ * @param {String} [dateFormat] 转换格式
+ *
+ * 当 value 为字符串类型时，如果不提供，则尽可能按常见格式去解析。
+ * 常见格式为 yyyy[/-]MM[/-]dd hh:mm:ss.SSS， MM[/-]dd [/-]yyyy hh:mm:ss.SSS 及 ISO8601 时间格式。
+ *
+ * 如果提供，则按具体格式严格匹配解析，并且年份必须为4位。
+ *  - yyyy 代表年份
+ *  - M 或 MM 代表1位或2位的月份
+ *  - d 或 dd 代表1位或2位的天数
+ *  - h 或 hh 代表24小时的1位或2位的小时
+ *  - m 或 mm 代表1位或2位的分钟，
+ *  - s 或 ss 代表1位或2位的秒
+ *  - S 或 SS 或 SSS 代表1位或2位或3位的毫秒
+ *
+ * @param {String} [minDate] 最小时间，默认为 0001-01-01 00:00:00.000
+ * @returns {Date}
+ */
+export declare const toDate: (value: any, dateFormat: any, minDate: any) => any;
+/**
+ * 将 Date 实例转换成日期字符串。
+ * 当 date 为日期字符串时，如果只有2个参数，则第2个参数为格式化后的格式化字符串
+ * 如果有3个参数，则第2个参数为转换的格式化参数，第3个参数为格式化后的格式化参数
+ *
+ *     let date = new Date(2014, 4, 4, 1, 2, 3, 4)
+ *     format(date)                                     // "2014/05/04 01:02:03"
+ *     format(date, 'yyyy/MM/dd hh:mm:ss.SSS')          // "2014/05/04 01:02:03.004"
+ *     format(date, 'yyyy/MM/dd hh:mm:ss.SSSZ')         // "2014/05/04 01:02:03.004+0800"
+ *     format(date, 'yyyy年MM月dd日 hh时mm分ss秒SSS毫秒')  // "2014年05月04日 01时02分03秒004毫秒"
+ *     format('2008/01/02', 'yyyy/MM/dd hh:mm:ss.SSS')  // "2008/02/02 00:00:00.000"
+ *     format('2014/01/02/03/04/05/06', 'yyyy/MM/dd/hh/mm/ss', 'yyyy年MM月dd日 hh时mm分ss秒') // "2014年01月02日 03时04分05秒006毫秒"
+ *
+ * @param {Date|String} date Date 实例或日期字符串
+ * @param {String} [dateFormat='yyyy/MM/dd hh:mm:ss'] 转换格式
+ *
+ * 常见格式为 yyyy[/-]MM[/-]dd hh:mm:ss.SSS， MM[/-]dd [/-]yyyy hh:mm:ss.SSS 及 ISO8601 时间格式。
+ *
+ * 如果提供，则按具体格式严格匹配解析，并且年份必须为4位。
+ *  - yyyy 代表年份
+ *  - M 或 MM 代表1位或2位的月份
+ *  - d 或 dd 代表1位或2位的天数
+ *  - h 或 hh 代表24小时的1位或2位的小时
+ *  - m 或 mm 代表1位或2位的分钟，
+ *  - s 或 ss 代表1位或2位的秒
+ *  - S 或 SS 或 SSS 代表1位或2位或3位的毫秒
+ *
+ * @returns {String}
+ */
+export declare const format: (date: any, dateFormat?: string) => any;
+/**
+ * 将当前操作的时间变更时区，主要用于转换一个其他时区的时间。
+ *
+ *     var date = new Date(2017, 0, 1)
+ *     getDateWithNewTimezone(date, 0, -2)
+ *
+ * @param {Date} date Date 实例或日期字符串
+ * @param {Number} otz 原时区 -12~13
+ * @param {Number} ntz 目标时区 -12~13 默认为当前时区
+ * @param {Boolean} TimezoneOffset 时区偏移量
+ * @returns {Date}
+ */
+export declare const getDateWithNewTimezone: (date: any, otz: any, ntz: any, timezoneOffset?: number) => Date;
+/**
+ * 按时区将 Date 实例转换成字符串。
+ *
+ *     toDateStr(new Date(2017, 0, 1, 12, 30), 'yyyy/MM/dd hh:mm', 3) // "2017/01/01 15:30"
+ *     toDateStr('2008/01/02', 'yyyy/MM/dd hh:mm', 3)                 // "2008/01/02 03:00"
+ *
+ * @param {Date|String} date Date 实例或日期字符串
+ * @param {String} dateFormat 转换格式
+ * @param {Number} [timezone] 时区
+ * @returns {String}
+ */
+export declare const toDateStr: (date: any, dateFormat: any, timezone: any) => any;
+/**
+ * 获取日期所在周的第一天，默认周一为第一天（可扩展周日为第一天）。
+ *
+ *     getWeekOfFirstDay()                            // 返回当前日期所在周的周一同一时间
+ *     getWeekOfFirstDay(true)                        // 返回当前日期所在周的周日同一时间
+ *     getWeekOfFirstDay(new Date(2019, 8, 5))        // new Date(2019, 8, 2)
+ *     getWeekOfFirstDay(new Date(2019, 8, 5)), true) // new Date(2019, 8, 1)
+ *
+ * @param {Date} [date=new Date()] date 日期实例，默认当天
+ * @param {Boolean} [isSunFirst] 是否设置周日为第一天，非必填
+ * @returns {Date}
+ */
+export declare const getWeekOfFirstDay: (date: any, isSunFirst: any) => Date;
+export declare const getLocalTimezone: () => number;
+export declare const getStrTimezone: (value: any) => any;

package/types/utils/dropdown.d.ts

@@ -0,0 +1,12 @@
+/**
+ * 下拉框显隐
+ * @param state 组件响应式数据
+ * @param isShow 是否展示下拉框, 默认展示
+ */
+export declare const showDropdown: (state: any, isShow?: boolean) => void;
+/**
+ * 编辑下拉框显隐
+ * @param state 组件响应式数据
+ * @param isShow 是否展示编辑下拉框, 默认展示
+ */
+export declare const showPopover: (state: any, isShow?: boolean) => void;

package/types/utils/en_US.d.ts

@@ -0,0 +1,41 @@
+export declare const enUS: {
+    tvp: {
+        tvpSearchbox: {
+            defaultPlaceholder: string;
+            addPlaceholder: string;
+            tagPlaceholder: string;
+            dynamicPlaceholder: string;
+            attributeType: string;
+            propertyValue: string;
+            matched: string;
+            allValues: string;
+            allProperty: string;
+            operator: string;
+            clearAll: string;
+            emptyValue: string;
+            help: string;
+            switchText: string;
+            tagKey: string;
+            tagValue: string;
+            minValueText: string;
+            maxValueText: string;
+            rangeMinArr: string;
+            rangeMaxArr: string;
+            rangeNumberTitle: string;
+            rangeDateTitle: string;
+            timeLengthTitle: string;
+            rangeBeginLabel: string;
+            rangeEndLabel: string;
+            rulekeyword1: string;
+            notBeNull: string;
+            noData: string;
+            selectAll: string;
+            confirm: string;
+            cancel: string;
+            equal: string;
+            notEqual: string;
+            contain: string;
+            notContain: string;
+        };
+    };
+};

package/types/utils/index.d.ts

@@ -0,0 +1 @@
+export declare const debounce: (func: Function, delay?: number) => (this: any, ...args: any) => void;

package/types/utils/tag.d.ts

@@ -0,0 +1,46 @@
+import { ISearchBoxNewTag } from '../index.type';
+/**
+ * 判断是否已选择此标签
+ * @param state searchbox的state变量
+ * @param itemValue 标签的value值
+ * @param itemLabel 标签的label值，可选参数，默认为空字符串，一般用于当prevItem.label为空时
+ * @return 已选择则返回true，未选择则相反
+ */
+export declare const hasTagItem: (state: any, itemValue: any, itemLabel?: string) => any;
+/**
+ * 清空输入框的值
+ * @param state searchbox的state变量
+ */
+export declare const resetInput: (state: any) => void;
+/**
+ * update:modelValue和change事件
+ * @param emits vue的api
+ * @param state searchbox的state变量
+ * @param args 其他可选参数：
+ * @param tagList 尾部添加的新标签数组
+ * @param index 替换某标签的索引
+ * @param newTag 表示替换的新标签，主要和索引共用
+ * @param newValue 表示替换全部的model-value值
+ * @param oldValue 表示旧的model-value值
+ */
+export declare const emitChangeModelEvent: ({ emits, state, ...args }: {
+    [x: string]: any;
+    emits: any;
+    state: any;
+}) => void;
+/**
+ * 创建新标签，防止多个地方创建的标签不一致，缺少某些属性
+ * @param newTag 新标签对象
+ * @return 生成的新标签对象
+ */
+export declare const createNewTag: (newTag: ISearchBoxNewTag) => ISearchBoxNewTag;
+/**
+ * 获取元素的唯一标识
+ * @param props 组件入参对象
+ * @param prevItem 当前标签父级对象
+ * @param item 要生成的新标签对象
+ * @return 此标签的唯一标识
+ */
+export declare const getTagId: (props: any, prevItem: any, item: any) => {
+    [x: number]: any;
+};

package/types/utils/type.d.ts

@@ -0,0 +1,6 @@
+/**
+ * 判断input输入对象是否为数字类型。
+ * isNumber(369) // true
+ * isNumber('') // false
+ */
+export declare const isNumber: (value: any) => boolean;

package/types/utils/validate.d.ts

@@ -0,0 +1,31 @@
+/**
+ * 校验正常标签的值，并返回相应的新标签
+ * @param instance searchbox 的 instance
+ * @param state searchbox 的 state
+ * @param props searchbox 的 props
+ * @return 验证通过则返回新标签对象，否则返回null
+ */
+export declare const getVerifyTag: (instance: any, state: any, props: any) => Promise<any>;
+/**
+ * 校验 numRange 的值，并返回相应的新标签
+ * @param instance searchbox 的 instance
+ * @param state searchbox 的 state
+ * @param props searchbox 的 props
+ * @return 验证通过则返回新标签对象，否则返回null
+ */
+export declare const getVerifyNumTag: (instance: any, state: any, props: any) => Promise<any>;
+/**
+ * 校验 dateRange datetimeRange 的值，并返回相应的新标签
+ * @param instance searchbox 的 instance
+ * @param state searchbox 的 state
+ * @param props searchbox 的 props
+ * @param isDateTimeType 是否 datetimeRange
+ * @return 验证通过则返回新标签对象，否则返回null
+ */
+export declare const getVerifyDateTag: (instance: any, state: any, props: any, isDateTimeType: any) => Promise<any>;
+/**
+ * 按需加载 state 里 numRange 类型的变量，按需加载校验规则
+ * @param state searchbox 的 state
+ * @param item 当前选择的 item 值
+ */
+export declare const setStateNumRange: (state: any, item: any, t: any) => void;

package/types/utils/zh_CN.d.ts

@@ -0,0 +1,41 @@
+export declare const zhCN: {
+    tvp: {
+        tvpSearchbox: {
+            defaultPlaceholder: string;
+            addPlaceholder: string;
+            tagPlaceholder: string;
+            dynamicPlaceholder: string;
+            attributeType: string;
+            propertyValue: string;
+            matched: string;
+            allValues: string;
+            allProperty: string;
+            operator: string;
+            clearAll: string;
+            emptyValue: string;
+            help: string;
+            switchText: string;
+            tagKey: string;
+            tagValue: string;
+            minValueText: string;
+            maxValueText: string;
+            rangeMinArr: string;
+            rangeMaxArr: string;
+            rangeNumberTitle: string;
+            rangeDateTitle: string;
+            timeLengthTitle: string;
+            rangeBeginLabel: string;
+            rangeEndLabel: string;
+            rulekeyword1: string;
+            notBeNull: string;
+            noData: string;
+            selectAll: string;
+            confirm: string;
+            cancel: string;
+            equal: string;
+            notEqual: string;
+            contain: string;
+            notContain: string;
+        };
+    };
+};