Skip to content

快速上手 ​

ztool 是一个轻量、高效的前端工具库,提供了一系列经过实战验证的业务工具函数 —— 从数据格式化、类型判断到接口错误捕获,覆盖前端开发高频场景。开箱即用,无需额外配置。

安装 ​

bash
npm install @zlabnext/ztool
bash
yarn add @zlabnext/ztool
bash
pnpm add @zlabnext/ztool

NOTE

ztool 依赖 lodash-es(peerDependency),请确保项目中已安装:

bash
npm install lodash-es

引入方式 ​

支持按需导入,配合 ESM 构建工具可实现 tree-shaking:

js
import { Option, replaceEmpty } from "@zlabnext/ztool";

功能概览 ​

分类包含的函数
公共下拉选项Option
字符串处理replaceEmpty、fmtAddressStr、arrToStr、strToArr
数组处理arrayTojson、jsonToArray
文件处理downloadFileV2、convert2Webp、getFilenameFromUrl 等
颜色处理getRandomColor
日期区间splitDateRange、combineDateRange
接口错误捕获errorTrap、setErrorTrapGlobalConfig
分页处理calcPageAfterDelete

完整说明请查阅 API。

代码示例 ​

使用 公共下拉选项 来维护任务状态:

任务状态
请选择任务状态
No Data
vue
<script setup>
import { onMounted, reactive, ref } from "vue";
import { Option } from "@zlabnext/ztool";

/* 状态映射 */
const taskStatusMap = new Option({
  dataSource: [
    { label: "待提交", value: "1" },
    { label: "进行中", value: "2" },
    { label: "已完成", value: "3" },
  ],
});

/* 表格数据 */
const dataSource = [
  { taskName: "待办任务a", taskStatus: "1" },
  { taskName: "待办任务b", taskStatus: "2" },
  { taskName: "待办任务c", taskStatus: "3" },
];
const tableData = ref([]);

/* 查询表单逻辑 */
const formRef = ref();
const formData = reactive({});
const onQuery = () => {
  if (!formData.taskStatus) {
    tableData.value = dataSource;
    return;
  }
  tableData.value = dataSource.filter(
    (item) => item.taskStatus === formData.taskStatus
  );
};
const onReset = () => {
  formRef.value?.resetFields();
  onQuery();
};

onMounted(() => {
  onQuery();
});
</script>

<template>
  <el-card shadow="never">
    <el-form :model="formData" inline ref="formRef">
      <el-row :gutter="14">
        <el-col :span="12">
          <el-form-item label="任务状态" prop="taskStatus" style="width: 100%">
            <el-select
              v-model="formData.taskStatus"
              placeholder="请选择任务状态"
              clearable
            >
              <el-option
                v-for="item in taskStatusMap.options"
                :label="item.label"
                :value="item.value"
              ></el-option>
            </el-select>
          </el-form-item>
        </el-col>
        <el-col :span="12">
          <el-form-item>
            <el-button type="primary" @click="onQuery">查询</el-button>
            <el-button @click="onReset">重置</el-button>
          </el-form-item>
        </el-col>
      </el-row>
    </el-form>
    <el-alert :closable="false"
      >当前选中对象:
      {{
        taskStatusMap.getItemByValue(formData.taskStatus) || "暂无"
      }}</el-alert
    >
    <el-table :data="tableData">
      <el-table-column label="序号" type="index" :width="60"></el-table-column>
      <el-table-column label="任务名称" property="taskName"></el-table-column>
      <el-table-column label="任务状态" property="taskStatus">
        <template #default="scope">
          <el-tag>{{
            taskStatusMap.getLabelTextByValue(scope.row.taskStatus, true)
          }}</el-tag>
        </template>
      </el-table-column>
    </el-table>
  </el-card>
</template>