master

分支 (1)

标签 (1)

管理

管理

master

v2.0

layui-official-website-static
/
util.html



<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8">
<title>工具集文档 - Layui</title>
<meta name="renderer" content="webkit">
  <meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1">
  <meta name="viewport" content="width=device-width, initial-scale=1, maximum-scale=1">
  <meta name="apple-mobile-web-app-status-bar-style" content="black">
  <meta name="apple-mobile-web-app-capable" content="yes">
  <meta name="format-detection" content="telephone=no">
  <script>
  ;!function(){self!==parent&&(location.href="https://www.baidu.com/")}();
  </script>
  <link rel="stylesheet" href="layui.css" tppabs="https://res.layui.com/layui/dist/css/layui.css?t=1632659138211"  media="all">
  <link rel="stylesheet" href="global.css" tppabs="https://res.layui.com/static/css/global.css?t=1632659138211-19" media="all">
</head>
<body>
  <style>
    .site-dir {
      z-index: 19891015;
      position: fixed;
      top: 513px;
      left: 88%;
      margin-left: -15px;
      display: block;box-shadow: none;
    border: 1px solid #d2d2d2;
    padding: 0.5%;
    }
  </style>

<div class="layui-header header header-doc">
  <div class="layui-container">
    <a class="logo" href="#" tppabs="https://www.layui.com/">
      <img src="logo.png" tppabs="https://res.layui.com/static/images/layui/logo.png" alt="layui">
    </a>
    <div class="layui-form layui-hide-xs component" lay-filter="LAY-site-header-component"></div>
    <div class="layui-hide-xs site-notice"></div>

    <ul class="layui-nav" id="LAY_NAV_TOP">
      <li class="layui-nav-item layui-this">
        <a href="index.html" tppabs="https://www.layui.com/doc/">文档</a>
      </li>
      <li class="layui-nav-item ">
        <a href="demo/index.htm" >示例</a>
      </li>


    </ul>
  </div>
</div>

<!-- 让IE8/9支持媒体查询，从而兼容栅格 -->
<!--[if lt IE 9]>
  <script src="html5.min.js" tppabs="https://cdn.staticfile.org/html5shiv/r29/html5.min.js"></script>
  <script src="respond.min.js" tppabs="https://cdn.staticfile.org/respond.js/1.4.2/respond.min.js"></script>
<![endif]-->

<ul class="site-dir">
    <div class="layui-layer-title" style="cursor: move;">目录</div>
  <li><a href="#fixbar"><cite>固定块</cite></a></li>
  <li><a href="#countdown"><cite>倒计时</cite></a></li>
  <li><a href="#method"><cite>其它方法</cite>  <span class="layui-badge-dot"></span></a></li>
</ul>
<div class="layui-container layui-row">

<div class="layui-col-md3">
  <div class="layui-panel site-menu">
    <ul class="layui-menu layui-menu-lg">
      <li class="layui-menu-item-group" lay-options="{type: 'group', isAllowSpread: true}">
        <div class="layui-menu-body-title">
          基础说明
        </div>
        <hr>
        <ul>
          <li class="">
            <div class="layui-menu-body-title">
              <a href="index.html" tppabs="https://www.layui.com/doc/">
                <span>开始使用 </span>
                <span class="layui-font-12 layui-font-gray">Getting Started</span>
              </a>

            </div>
          </li>
          <li class="">
            <div class="layui-menu-body-title">
              <a href="infrastructure.html" tppabs="https://www.layui.com/doc/base/infrastructure.html">
                <span>底层方法 </span>
                <span class="layui-font-12 layui-font-gray">基础支撑</span>
              </a>
            </div>
          </li>
          <li class="">
            <div class="layui-menu-body-title">
              <a href="element.html" tppabs="https://www.layui.com/doc/base/element.html">
                <span>页面元素 </span>
                <span class="layui-font-12 layui-font-gray">规范 公共类 属性</span>
              </a>
            </div>
          </li>
          <li class="">
            <div class="layui-menu-body-title">
              <a href="modules.html" tppabs="https://www.layui.com/doc/base/modules.html">
                <span>模块规范 </span>
                <span class="layui-font-12 layui-font-gray">使用 扩展</span>
              </a>
            </div>
          </li>
          <li class="">
            <div class="layui-menu-body-title">
              <a href="faq.html" tppabs="https://www.layui.com/doc/base/faq.html">
                <span>常见问题 </span>
                <span class="layui-font-12 layui-font-gray">FAQ</span>
              </a>
            </div>
          </li>
          <li class="">
            <div class="layui-menu-body-title">
              <a href="changelog.html" tppabs="https://www.layui.com/doc/base/changelog.html">
                <span>更新日志 </span>
                <span class="layui-font-12 layui-font-gray">changelog</span>

                  <span class="layui-badge-dot"></span>

              </a>
            </div>
          </li>
        </ul>
      </li>

      <li class="layui-menu-item-group" lay-options="{type: 'group', isAllowSpread: true}">
        <div class="layui-menu-body-title">
          页面元素
        </div>
        <hr>
        <ul>
          <li class="">
            <div class="layui-menu-body-title">
              <a href="layout.html" tppabs="https://www.layui.com/doc/element/layout.html">
                <span>布局 </span>
                <span class="layui-font-12 layui-font-gray">栅格 后台管理布局</span>
              </a>
            </div>
          </li>
          <li class="">
            <div class="layui-menu-body-title">
              <a href="color.html" tppabs="https://www.layui.com/doc/element/color.html">
                <span>颜色 </span>
                <span class="layui-font-12 layui-font-gray">主色调 颜色搭配</span>
              </a>
            </div>
          </li>
          <li class="">
            <div class="layui-menu-body-title">
              <a href="icon.html" tppabs="https://www.layui.com/doc/element/icon.html">
                <span>图标 </span>
                <span class="layui-font-12 layui-font-gray">iconfont 字体图标</span>
              </a>
            </div>
          </li>
          <li class="">
            <div class="layui-menu-body-title">
              <a href="anim.html" tppabs="https://www.layui.com/doc/element/anim.html">
                <span>动画 </span>
                <span class="layui-font-12 layui-font-gray">内置 CSS3 动画</span>
              </a>
            </div>
          </li>
          <li class="">
            <div class="layui-menu-body-title">
              <a href="button.html" tppabs="https://www.layui.com/doc/element/button.html">
                <span>按钮 </span>
                <span class="layui-font-12 layui-font-gray">button</span>
              </a>
            </div>
          </li>
          <li class="">
            <div class="layui-menu-body-title">
              <a href="form.html" tppabs="https://www.layui.com/doc/element/form.html">
                <span>表单 </span>
                <span class="layui-font-12 layui-font-gray">form 元素集合</span>
              </a>
            </div>
          </li>
          <li class="">
            <div class="layui-menu-body-title">
              <a href="nav.html" tppabs="https://www.layui.com/doc/element/nav.html">
                <span>导航 </span>
                <span class="layui-font-12 layui-font-gray">nav 面包屑</span>
              </a>
            </div>
          </li>
          <li class="">
            <div class="layui-menu-body-title">
              <a href="menu.html" tppabs="https://www.layui.com/doc/element/menu.html">
                <span>菜单 </span>
                <span class="layui-font-12 layui-font-gray">menu 基础菜单</span>

                  <span class="layui-badge-dot"></span>

              </a>
            </div>
          </li>
          <li class="">
            <div class="layui-menu-body-title">
              <a href="tab.html" tppabs="https://www.layui.com/doc/element/tab.html">
                <span>选项卡 </span>
                <span class="layui-font-12 layui-font-gray">Tabs 切换</span>
              </a>
            </div>
          </li>
          <li class="">
            <div class="layui-menu-body-title">
              <a href="progress.html" tppabs="https://www.layui.com/doc/element/progress.html">
                <span>进度条 </span>
                <span class="layui-font-12 layui-font-gray">progress</span>
              </a>
            </div>
          </li>
          <li class="">
            <div class="layui-menu-body-title">
              <a href="panel.html" tppabs="https://www.layui.com/doc/element/panel.html">
                <span>面板 </span>
                <span class="layui-font-12 layui-font-gray">panel 卡片 折叠</span>
              </a>
            </div>
          </li>
          <li class="">
            <div class="layui-menu-body-title">
              <a href="table.html" tppabs="https://www.layui.com/doc/element/table.html">
                <span>表格 </span>
                <span class="layui-font-12 layui-font-gray">静态 table</span>
              </a>
            </div>
          </li>
          <li class="">
            <div class="layui-menu-body-title">
              <a href="badge.html" tppabs="https://www.layui.com/doc/element/badge.html">
                <span>徽章 </span>
                <span class="layui-font-12 layui-font-gray">小圆点  小边框</span>
              </a>
            </div>
          </li>
          <li class="">
            <div class="layui-menu-body-title">
              <a href="timeline.html" tppabs="https://www.layui.com/doc/element/timeline.html">
                <span>时间线 </span>
                <span class="layui-font-12 layui-font-gray">timeline</span>
              </a>
            </div>
          </li>
          <li class="">
            <div class="layui-menu-body-title">
              <a href="auxiliar.html" tppabs="https://www.layui.com/doc/element/auxiliar.html">
                <span>辅助 </span>
                <span class="layui-font-12 layui-font-gray">引用 字段集 横线等</span>
              </a>
            </div>
          </li>
        </ul>
      </li>

      <li class="layui-menu-item-group" lay-options="{type: 'group', isAllowSpread: true}">
        <div class="layui-menu-body-title">
          内置模块
        </div>
        <hr>
        <ul>
          <li class="">
            <div class="layui-menu-body-title">
              <a href="layer.html" tppabs="https://www.layui.com/doc/modules/layer.html">
                <span>弹出层 </span>
                <span class="layui-font-12 layui-font-gray">layer</span>
              </a>
            </div>
          </li>
          <li class="">
            <div class="layui-menu-body-title">
              <a href="laydate.html" tppabs="https://www.layui.com/doc/modules/laydate.html">
                <span>日期与时间选择 </span>
                <span class="layui-font-12 layui-font-gray">laydate</span>
              </a>
            </div>
          </li>
          <li class="">
            <div class="layui-menu-body-title">
              <a href="laypage.html" tppabs="https://www.layui.com/doc/modules/laypage.html">
                <span>分页 </span>
                <span class="layui-font-12 layui-font-gray">laypage</span>
              </a>
            </div>
          </li>
          <li class="">
            <div class="layui-menu-body-title">
              <a href="laytpl.html" tppabs="https://www.layui.com/doc/modules/laytpl.html">
                <span>模板引擎 </span>
                <span class="layui-font-12 layui-font-gray">laytpl</span>
              </a>
            </div>
          </li>
          <li class="">
            <div class="layui-menu-body-title">
              <a href="table-1.html" tppabs="https://www.layui.com/doc/modules/table.html">
                <span>数据表格 </span>
                <span class="layui-font-12 layui-font-gray">table</span>
              </a>
            </div>
          </li>
          <li class="">
            <div class="layui-menu-body-title">
              <a href="form-1.html" tppabs="https://www.layui.com/doc/modules/form.html">
                <span>表单 </span>
                <span class="layui-font-12 layui-font-gray">form</span>
              </a>
            </div>
          </li>
          <li class="">
            <div class="layui-menu-body-title">
              <a href="upload.html" tppabs="https://www.layui.com/doc/modules/upload.html">
                <span>文件上传 </span>
                <span class="layui-font-12 layui-font-gray">upload</span>
              </a>
            </div>
          </li>
          <li class="">
            <div class="layui-menu-body-title">
              <a href="dropdown.html" tppabs="https://www.layui.com/doc/modules/dropdown.html">
                <span>下拉菜单 </span>
                <span class="layui-font-12 layui-font-gray">dropdown</span>

                  <span class="layui-badge-dot"></span>

              </a>
            </div>
          </li>
          <li class="">
            <div class="layui-menu-body-title">
              <a href="transfer.html" tppabs="https://www.layui.com/doc/modules/transfer.html">
                <span>穿梭框 </span>
                <span class="layui-font-12 layui-font-gray">transfer</span>
              </a>
            </div>
          </li>
          <li class="">
            <div class="layui-menu-body-title">
              <a href="tree.html" tppabs="https://www.layui.com/doc/modules/tree.html">
                <span>树形组件 </span>
                <span class="layui-font-12 layui-font-gray">tree</span>
              </a>
            </div>
          </li>
          <li class="">
            <div class="layui-menu-body-title">
              <a href="colorpicker.html" tppabs="https://www.layui.com/doc/modules/colorpicker.html">
                <span>颜色选择器 </span>
                <span class="layui-font-12 layui-font-gray">colorpicker</span>
              </a>
            </div>
          </li>
          <li class="">
            <div class="layui-menu-body-title">
              <a href="element-1.html" tppabs="https://www.layui.com/doc/modules/element.html">
                <span>常用元素操作 </span>
                <span class="layui-font-12 layui-font-gray">element</span>
              </a>
            </div>
          </li>
          <li class="">
            <div class="layui-menu-body-title">
              <a href="slider.html" tppabs="https://www.layui.com/doc/modules/slider.html">
                <span>滑块 </span>
                <span class="layui-font-12 layui-font-gray">slider</span>
              </a>
            </div>
          </li>
          <li class="">
            <div class="layui-menu-body-title">
              <a href="rate.html" tppabs="https://www.layui.com/doc/modules/rate.html">
                <span>评分 </span>
                <span class="layui-font-12 layui-font-gray">rate</span>
              </a>
            </div>
          </li>
          <li class="">
            <div class="layui-menu-body-title">
              <a href="carousel.html" tppabs="https://www.layui.com/doc/modules/carousel.html">
                <span>轮播 </span>
                <span class="layui-font-12 layui-font-gray">carousel</span>
              </a>
            </div>
          </li>
          <li class="">
            <div class="layui-menu-body-title">
              <a href="flow.html" tppabs="https://www.layui.com/doc/modules/flow.html">
                <span>流加载 </span>
                <span class="layui-font-12 layui-font-gray">flow</span>
              </a>
            </div>
          </li>
          <li class="layui-menu-item-checked2">
            <div class="layui-menu-body-title">
              <a href="util.html" tppabs="https://www.layui.com/doc/modules/util.html">
                <span>工具组件 </span>
                <span class="layui-font-12 layui-font-gray">util</span>
              </a>
            </div>
          </li>
          <li class="">
            <div class="layui-menu-body-title">
              <a href="code.html" tppabs="https://www.layui.com/doc/modules/code.html">
                <span>代码高亮显示 </span>
                <span class="layui-font-12 layui-font-gray">code</span>
              </a>
            </div>
          </li>
        </ul>
      </li>
    </ul>
  </div>
  <div class="layui-hide-v"> - </div>
</div>


  <div class="layui-col-md9 site-content">
    <h1 class="site-h1"><i class="layui-icon">&#xe631;</i> 工具集文档 - layui.util</h1>
    <blockquote class="site-text layui-elem-quote">
      我们将一些工具性元素放入 <em>util</em> 模块中，以供选择性使用。其内部由多个小工具组件组成，他们也许不是必须的，但很多时候却能为你的页面提供良好的辅助作用。
    </blockquote>
     <blockquote class="site-text layui-elem-quote">
      模块加载名称：<em>util</em>
    </blockquote>


    <fieldset class="layui-elem-field layui-field-title site-title">
      <legend><a name="fixbar">固定块</a></legend>
    </fieldset>
    <div class="site-text">
      <p>
        语法：<em>util.fixbar(options)</em>
        <br>其中参数 <em>options</em> 是一个对象，可支持的key如下表：
      </p>
      <table class="layui-table">
        <colgroup>
          <col width="120">
          <col width="120">
          <col>
        </colgroup>
        <thead>
          <tr>
            <th>参数</th>
            <th>类型</th>
            <th>描述</th>
          </tr>
        </thead>
        <tbody>
          <tr>
            <td>bar1</td>
            <td>Boolean/String</td>
            <td>默认false。如果值为true，则显示第一个bar，带有一个默认图标。<br>如果值为图标字符，则显示第一个bar，并覆盖默认图标</td>
          </tr>
          <tr>
            <td>bar2</td>
            <td>Boolean/String</td>
            <td>默认false。如果值为true，则显示第二个bar，带有一个默认图标。<br>如果值为图标字符，则显示第二个bar，并覆盖默认图标</td>
          </tr>
          <tr>
            <td>bgcolor</td>
            <td>String</td>
            <td>自定义区块背景色</td>
          </tr>
          <tr>
            <td>showHeight</td>
            <td>Number</td>
            <td>用于控制出现TOP按钮的滚动条高度临界值。默认：200</td>
          </tr>
          <tr>
            <td>css</td>
            <td>Object</td>
            <td>你可以通过重置bar的位置，比如 css: {right: 100, bottom: 100}</td>
          </tr>
          <tr>
            <td>click</td>
            <td>Function</td>
            <td>点击bar的回调，函数返回一个type参数，用于区分bar类型。<br>支持的类型有：bar1、bar2、top</td>
          </tr>
          <tr>
        </tbody>
      </table>
      <pre class="layui-code" lay-title="例子">
layui.use('util', function(){
  var util = layui.util;

  //执行
  util.fixbar({
    bar1: true
    ,click: function(type){
      console.log(type);
      if(type === 'bar1'){
        alert('点击了bar1')
      }
    }
  });
});
      </pre>
    </div>

    <fieldset class="layui-elem-field layui-field-title site-title">
      <legend><a name="countdown">倒计时</a></legend>
    </fieldset>
    <div class="site-text">
      <p>这是一个精致的封装，它并不负责视图的呈现，而仅返回倒计时数值，这意味着你可以将它应用在任何倒计时相关的业务中。</p>
      <p>
        语法：<em>util.countdown(endTime, serverTime, callback)</em>
      </p>
      <table class="layui-table">
        <colgroup>
          <col width="120">
          <col>
        </colgroup>
        <thead>
          <tr>
            <th>参数</th>
            <th>说明</th>
          </tr>
        </thead>
        <tbody>
          <tr>
            <td>endTime</td>
            <td>结束时间戳或Date对象，如：4073558400000，或：new Date(2099,1,1).</td>
          </tr>
          <tr>
            <td>serverTime</td>
            <td>当前服务器时间戳或Date对象</td>
          </tr>
          <tr>
            <td>callback</td>
            <td>
              回调函数。如果倒计时尚在运行，则每一秒都会执行一次。并且返回三个参数：
              <em>date</em>（包含天/时/分/秒的对象）、 <em>serverTime</em>（当前服务器时间戳或Date对象）, <em>timer</em>（计时器返回的ID值，用于clearTimeout）
            </td>
          </tr>
        </tbody>
      </table>
      <pre class="layui-code" lay-title="例子">
&lt;div id="test">&lt;/div>

&lt;script&gt;
layui.use('util', function(){
  var util = layui.util;

  //示例
  var endTime = new Date(2099,1,1).getTime() //假设为结束日期
  ,serverTime = new Date().getTime(); //假设为当前服务器时间，这里采用的是本地时间，实际使用一般是取服务端的

  util.countdown(endTime, serverTime, function(date, serverTime, timer){
    var str = date[0] + '天' + date[1] + '时' +  date[2] + '分' + date[3] + '秒';
    layui.$('#test').html('距离2099年1月1日还有：'+ str);
  });
});
&lt;/script&gt;
      </pre>
    </div>

    <fieldset class="layui-elem-field layui-field-title site-title">
      <legend><a name="method">其它方法</a></legend>
    </fieldset>
    <table class="layui-table">
      <colgroup>
        <col width="220">
        <col>
      </colgroup>
      <thead>
        <tr>
          <th>方法</th>
          <th>说明</th>
        </tr>
      </thead>
      <tbody>
        <tr>
          <td>util.timeAgo(time, onlyDate)</td>
          <td>
            某个时间在当前时间的多久前。
            <br>参数 <em>time</em>：即为某个时间的时间戳或日期对象
            <br>参数 <em>onlyDate</em>：是否在超过30天后，只返回日期字符，而不返回时分秒
            <br>
            <br>如果在3分钟以内，返回：<em>刚刚</em>
            <br>如果在30天以内，返回：<em>若干分钟前</em>、<em>若干小时前</em>、<em>若干天前</em>，如：5分钟前
            <br>如果在30天以上，返回：<em>日期字符</em>，如：2017-01-01
          </td>
        </tr>
        <tr>
          <td>util.toDateString(time, format)</td>
          <td>
            转化时间戳或日期对象为日期格式字符
            <br>参数 <em>time</em>：可以是日期对象，也可以是毫秒数
            <br>参数 <em>format</em>：日期字符格式（默认：yyyy-MM-dd HH:mm:ss），可随意定义，如：yyyy年MM月dd日
          </td>
        </tr>
        <tr>
          <td>util.digit(num, length)</td>
          <td>
            数字前置补零
            <br>参数 <em>num</em>：原始数字
            <br>参数 <em>length</em>：数字长度，如果原始数字长度小于 length，则前面补零，如：util.digit(7, 3) //007
          </td>
        </tr>
        <tr>
          <td>util.escape(str)</td>
          <td>
            转义 xss 字符
            <br>参数 <em>str</em>：任意字符
          </td>
        </tr>
        <tr>
          <td>util.event(attr, obj, eventType)</td>
          <td>
            用于更好地批量处理事件。
            <br>参数 <em>attr</em>：绑定需要监听事件的元素属性
            <br>参数 <em>obj</em>：事件回调链
            <br>参数 <em>eventType</em>：事件类型（默认 click）
            <br><br>示例：
            <pre class="layui-code">
HTML：
&lt;button class="layui-btn" lay-active="e1">事件1&lt;/button>
&lt;button class="layui-btn" lay-active="e2">事件2&lt;/button>
&lt;button class="layui-btn" lay-active="e3">事件3&lt;/button>

JavaScript：
&lt;script>
layui.use('util', function(){
  var util = layui.util;

  //处理属性 为 lay-active 的所有元素事件
  util.event('lay-active', {
    e1: function(othis){
      alert('触发了事件1');
    }
    ,e2: function(othis){
      alert('触发了事件2');
    }
    ,e3: function(othis){
      alert('触发了事件3');
    }
  });
});
&lt;/script>
            </pre>
          </td>
        </tr>
      </tbody>
    </table>

    <fieldset class="layui-elem-field layui-field-title site-title">
      <legend><a name="other">结语</a></legend>
    </fieldset>
    <div class="site-text">
      <p>工具模块往往应用在边边角角，将不定期增加。</p>
    </div>

    <div class="layui-elem-quote">
  <p>layui - 在每一个细节中，用心与你沟通</p>
</div>

  </div>
</div>


<div class="layui-footer footer footer-doc">
    <p>致敬layui</p>


</div>
<script>
window.global = {
  pageType: 'doc'
  ,preview: function(){
    var preview = document.getElementById('LAY_preview');
    return preview ? preview.innerHTML : '';
  }()
};
</script>

<div class="site-tree-mobile layui-hide">
  <i class="layui-icon layui-icon-spread-left"></i>
</div>
<div class="site-mobile-shade"></div>

<script src="https://cdn.bootcdn.net/ajax/libs/layui/2.6.8/layui.js"></script>


</body>
</html>