pit-docs-mcp 1.0.2

package/docs/pitElementUi/timeline.md

@@ -0,0 +1,154 @@
+## Timeline 时间线
+
+可视化地呈现时间流信息。
+
+### 基础用法
+
+Timeline 可拆分成多个按照时间戳正序或倒序排列的 activity，时间戳是其区分于其他控件的重要特征，使⽤时注意与 Steps 步骤条等区分。
+
+:::demo
+```html
+<div class="block">
+  <div class="radio">
+    排序：
+    <el-radio-group v-model="reverse">
+      <el-radio :label="true">倒序</el-radio>
+      <el-radio :label="false">正序</el-radio>
+    </el-radio-group>
+  </div>
+
+  <el-timeline :reverse="reverse">
+    <el-timeline-item
+      v-for="(activity, index) in activities"
+      :key="index"
+      :timestamp="activity.timestamp">
+      {{activity.content}}
+    </el-timeline-item>
+  </el-timeline>
+</div>
+
+<script>
+  export default {
+    data() {
+      return {
+        reverse: true,
+        activities: [{
+          content: '活动按期开始',
+          timestamp: '2018-04-15'
+        }, {
+          content: '通过审核',
+          timestamp: '2018-04-13'
+        }, {
+          content: '创建成功',
+          timestamp: '2018-04-11'
+        }]
+      };
+    }
+  };
+</script>
+```
+:::
+
+### ⾃定义节点样式
+
+可根据实际场景⾃定义节点尺⼨、颜⾊，或直接使⽤图标。
+
+:::demo
+```html
+<div class="block">
+  <el-timeline>
+    <el-timeline-item
+      v-for="(activity, index) in activities"
+      :key="index"
+      :icon="activity.icon"
+      :type="activity.type"
+      :color="activity.color"
+      :size="activity.size"
+      :timestamp="activity.timestamp">
+      {{activity.content}}
+    </el-timeline-item>
+  </el-timeline>
+</div>
+
+<script>
+  export default {
+    data() {
+      return {
+        activities: [{
+          content: '支持使用图标',
+          timestamp: '2018-04-12 20:46',
+          size: 'large',
+          type: 'primary',
+          icon: 'el-icon-more'
+        }, {
+          content: '支持自定义颜色',
+          timestamp: '2018-04-03 20:46',
+          color: '#0bbd87'
+        }, {
+          content: '支持自定义尺寸',
+          timestamp: '2018-04-03 20:46',
+          size: 'large'
+        }, {
+          content: '默认样式的节点',
+          timestamp: '2018-04-03 20:46'
+        }]
+      };
+    }
+  };
+</script>
+```
+:::
+
+### ⾃定义时间戳
+
+当内容在垂直⽅向上过⾼时，可将时间戳置于内容之上。
+
+:::demo
+```html
+<div class="block">
+  <el-timeline>
+    <el-timeline-item timestamp="2018/4/12" rightTimestamp="2018/4/12" placement="top">
+      <el-card>
+        <h4>更新 Github 模板</h4>
+        <p>王小虎 提交于 2018/4/12 20:46</p>
+      </el-card>
+    </el-timeline-item>
+    <el-timeline-item timestamp="2018/4/3" placement="top">
+      <el-card>
+        <h4>更新 Github 模板</h4>
+        <p>王小虎 提交于 2018/4/3 20:46</p>
+      </el-card>
+    </el-timeline-item>
+    <el-timeline-item timestamp="2018/4/2" placement="top">
+      <el-card>
+        <h4>更新 Github 模板</h4>
+        <p>王小虎 提交于 2018/4/2 20:46</p>
+      </el-card>
+    </el-timeline-item>
+  </el-timeline>
+</div>
+```
+:::
+
+### Timeline Attributes
+| 参数      | 说明    | 类型      | 可选值       | 默认值   |
+|---------- |-------- |---------- |-------------  |-------- |
+| reverse | 指定节点排序方向，默认为正序 | boolean | — | false |
+
+### Timeline-item Attributes
+| 参数      | 说明    | 类型      | 可选值       | 默认值   |
+|---------- |-------- |---------- |-------------  |-------- |
+| timestamp     | 时间戳 | string  | - | — |
+| rightTimestamp     | 右侧时间戳 | string  | - | — |
+| hide-timestamp  | 是否隐藏时间戳 | boolean | — | false |
+| placement | 时间戳位置 | string | top / bottom | bottom |
+| type | 节点类型 | string | primary / success / warning / danger / info | - |
+| color | 节点颜色 | string | hsl / hsv / hex / rgb | - |
+| size | 节点尺寸 | string | normal / large | normal |
+| icon | 节点图标 | string | — | - |
+
+### Timeline-Item Slot
+| name | 说明 |
+|------|--------|
+| — | Timeline-Item 的内容 |
+| dot | 自定义节点 |

package/docs/pitElementUi/tooltip.md

@@ -0,0 +1,177 @@
+## Tooltip 文字提示
+
+常用于展示鼠标 hover 时的提示信息。
+
+### 基础用法
+
+在这里我们提供 9 种不同方向的展示方式，可以通过以下完整示例来理解，选择你要的效果。
+
+:::demo 使用`content`属性来决定`hover`时的提示信息。由`placement`属性决定展示效果：`placement`属性值为：`方向-对齐位置`；四个方向：`top`、`left`、`right`、`bottom`；三种对齐位置：`start`, `end`，默认为空。如`placement="left-end"`，则提示信息出现在目标元素的左侧，且提示信息的底部与目标元素的底部对齐。
+
+```html
+<div class="box">
+  <div class="top">
+    <el-tooltip class="item" effect="dark" content="Top Left 提示文字" placement="top-start">
+      <el-button>上左</el-button>
+    </el-tooltip>
+    <el-tooltip class="item" effect="dark" content="Top Center 提示文字" placement="top">
+      <el-button>上边</el-button>
+    </el-tooltip>
+    <el-tooltip class="item" effect="dark" content="Top Right 提示文字" placement="top-end">
+      <el-button>上右</el-button>
+    </el-tooltip>
+  </div>
+  <div class="left">
+    <el-tooltip class="item" effect="dark" content="Left Top 提示文字" placement="left-start">
+      <el-button>左上</el-button>
+    </el-tooltip>
+    <el-tooltip class="item" effect="dark" content="Left Center 提示文字" placement="left">
+      <el-button>左边</el-button>
+    </el-tooltip>
+    <el-tooltip class="item" effect="dark" content="Left Bottom 提示文字" placement="left-end">
+      <el-button>左下</el-button>
+    </el-tooltip>
+  </div>
+
+  <div class="right">
+    <el-tooltip class="item" effect="dark" content="Right Top 提示文字" placement="right-start">
+      <el-button>右上</el-button>
+    </el-tooltip>
+    <el-tooltip class="item" effect="dark" content="Right Center 提示文字" placement="right">
+      <el-button>右边</el-button>
+    </el-tooltip>
+    <el-tooltip class="item" effect="dark" content="Right Bottom 提示文字" placement="right-end">
+      <el-button>右下</el-button>
+    </el-tooltip>
+  </div>
+  <div class="bottom">
+    <el-tooltip class="item" effect="dark" content="Bottom Left 提示文字" placement="bottom-start">
+      <el-button>下左</el-button>
+    </el-tooltip>
+    <el-tooltip class="item" effect="dark" content="Bottom Center 提示文字" placement="bottom">
+      <el-button>下边</el-button>
+    </el-tooltip>
+    <el-tooltip class="item" effect="dark" content="Bottom Right 提示文字" placement="bottom-end">
+      <el-button>下右</el-button>
+    </el-tooltip>
+  </div>
+</div>
+
+<style>
+  .box {
+    width: 400px;
+
+    .top {
+      text-align: center;
+    }
+
+    .left {
+      float: left;
+      width: 60px;
+    }
+
+    .right {
+      float: right;
+      width: 60px;
+    }
+
+    .bottom {
+      clear: both;
+      text-align: center;
+    }
+
+    .item {
+      margin: 4px;
+    }
+
+    .left .el-tooltip__popper,
+    .right .el-tooltip__popper {
+      padding: 8px 10px;
+    }
+  }
+</style>
+```
+:::
+
+### 主题
+
+Tooltip 组件提供了两个不同的主题：`dark`和`light`。
+
+
+:::demo 通过设置`effect`属性来改变主题，默认为`dark`。
+```html
+<el-tooltip content="Top center" placement="top">
+  <el-button>Dark</el-button>
+</el-tooltip>
+<el-tooltip content="Bottom center" placement="bottom" effect="light">
+  <el-button>Light</el-button>
+</el-tooltip>
+```
+:::
+
+### 更多 Content
+
+展示多行文本或者是设置文本内容的格式
+
+:::demo 用具名 slot 分发`content`，替代`tooltip`中的`content`属性。
+```html
+<el-tooltip placement="top">
+  <div slot="content">多行信息<br/>第二行信息</div>
+  <el-button>Top center</el-button>
+</el-tooltip>
+```
+:::
+
+### 高级扩展
+
+除了这些基本设置外，还有一些属性可以让使用者更好的定制自己的效果：
+
+`transition` 属性可以定制显隐的动画效果，默认为`fade-in-linear`。
+如果需要关闭 `tooltip` 功能，`disabled` 属性可以满足这个需求，它接受一个`Boolean`，设置为`true`即可。
+
+事实上，这是基于 [Vue-popper](https://github.com/element-component/vue-popper) 的扩展，你可以自定义任意 Vue-popper 中允许定义的字段。
+当然 Tooltip 组件实际上十分强大，文末的API文档会做一一说明。
+
+:::demo
+```html
+<template>
+  <el-tooltip :disabled="disabled" content="点击关闭 tooltip 功能" placement="bottom" effect="light">
+    <el-button @click="disabled = !disabled">点击{{disabled ? '开启' : '关闭'}} tooltip 功能</el-button>
+  </el-tooltip>
+</template>
+<script>
+  export default {
+    data() {
+      return {
+        disabled: false
+      };
+    }
+  };
+</script>
+```
+:::
+
+:::tip
+tooltip 内不支持 `router-link` 组件，请使用 `vm.$router.push` 代替。
+
+tooltip 内不支持 disabled form 元素，参考[MDN](https://developer.mozilla.org/en-US/docs/Web/Events/mouseenter)，请在 disabled form 元素外层添加一层包裹元素。
+:::
+
+### Attributes
+| 参数               | 说明                                                     | 类型              | 可选值      | 默认值 |
+|--------------------|----------------------------------------------------------|-------------------|-------------|--------|
+|  effect        |  默认提供的主题  | String            | dark/light | dark  |
+|  content        |  显示的内容，也可以通过 `slot#content` 传入 DOM  | String            | — | — |
+|  placement        |  Tooltip 的出现位置  | String           |  top/top-start/top-end/bottom/bottom-start/bottom-end/left/left-start/left-end/right/right-start/right-end |  bottom |
+|  value / v-model |  状态是否可见  | Boolean           | — |  false |
+|  disabled       |  Tooltip 是否可用  | Boolean           | — |  false |
+|  offset        |  出现位置的偏移量  | Number           | — |  0 |
+|  transition     |  定义渐变动画      | String             | — | el-fade-in-linear |
+|  visible-arrow   |  是否显示 Tooltip 箭头，更多参数可见[Vue-popper](https://github.com/element-component/vue-popper) | Boolean | — | true |
+|  popper-options        | [popper.js](https://popper.js.org/documentation.html) 的参数 | Object            | 参考 [popper.js](https://popper.js.org/documentation.html) 文档 | { boundariesElement: 'body', gpuAcceleration: false } |
+| open-delay | 延迟出现，单位毫秒 | Number | — | 0 |
+| manual | 手动控制模式，设置为 true 后，mouseenter 和 mouseleave 事件将不会生效 | Boolean | — | false |
+| popper-class | 为 Tooltip 的 popper 添加类名 | String | — | — |
+| enterable | 鼠标是否可进入到 tooltip 中 | Boolean | — | true |
+| hide-after | Tooltip 出现后自动隐藏延时，单位毫秒，为 0 则不会自动隐藏 | number | — | 0 |
+| tabindex   | Tooltip 组件的 [tabindex](https://developer.mozilla.org/en-US/docs/Web/HTML/Global_attributes/tabindex) | number | — | 0 |

package/docs/pitElementUi/transfer.md

@@ -0,0 +1,249 @@
+## Transfer 穿梭框
+
+### 基础用法
+:::demo Transfer 的数据通过 `data` 属性传入。数据需要是一个对象数组，每个对象有以下属性：`key` 为数据的唯一性标识，`label` 为显示文本，`disabled` 表示该项数据是否禁止转移。目标列表中的数据项会同步到绑定至 `v-model` 的变量，值为数据项的 `key` 所组成的数组。当然，如果希望在初始状态时目标列表不为空，可以像本例一样为 `v-model` 绑定的变量赋予一个初始值。
+```html
+<template>
+  <el-transfer v-model="value" :data="data"></el-transfer>
+</template>
+
+<script>
+  export default {
+    data() {
+      const generateData = _ => {
+        const data = [];
+        for (let i = 1; i <= 15; i++) {
+          data.push({
+            key: i,
+            label: `备选项 ${ i }`,
+            disabled: i % 4 === 0
+          });
+        }
+        return data;
+      };
+      return {
+        data: generateData(),
+        value: [1, 4]
+      };
+    }
+  };
+</script>
+```
+:::
+
+### 可搜索
+
+在数据很多的情况下，可以对数据进行搜索和过滤。
+
+:::demo 设置 `filterable` 为 `true` 即可开启搜索模式。默认情况下，若数据项的 `label` 属性包含搜索关键字，则会在搜索结果中显示。你也可以使用 `filter-method` 定义自己的搜索逻辑。`filter-method` 接收一个方法，当搜索关键字变化时，会将当前的关键字和每个数据项传给该方法。若方法返回 `true`，则会在搜索结果中显示对应的数据项。
+```html
+<template>
+  <el-transfer
+    filterable
+    :filter-method="filterMethod"
+    filter-placeholder="请输入城市拼音"
+    v-model="value"
+    :data="data">
+  </el-transfer>
+</template>
+
+<script>
+  export default {
+    data() {
+      const generateData = _ => {
+        const data = [];
+        const cities = ['上海', '北京', '广州', '深圳', '南京', '西安', '成都'];
+        const pinyin = ['shanghai', 'beijing', 'guangzhou', 'shenzhen', 'nanjing', 'xian', 'chengdu'];
+        cities.forEach((city, index) => {
+          data.push({
+            label: city,
+            key: index,
+            pinyin: pinyin[index]
+          });
+        });
+        return data;
+      };
+      return {
+        data: generateData(),
+        value: [],
+        filterMethod(query, item) {
+          return item.pinyin.indexOf(query) > -1;
+        }
+      };
+    }
+  };
+</script>
+```
+:::
+
+### 可自定义
+
+可以对列表标题文案、按钮文案、数据项的渲染函数、列表底部的勾选状态文案、列表底部的内容区等进行自定义。
+
+:::demo 可以使用 `titles`、`button-texts`、`render-content` 和 `format` 属性分别对列表标题文案、按钮文案、数据项的渲染函数和列表顶部的勾选状态文案进行自定义。数据项的渲染还可以使用 `scoped-slot` 进行自定义。对于列表底部的内容区，提供了两个具名 slot：`left-footer` 和 `right-footer`。此外，如果希望某些数据项在初始化时就被勾选，可以使用 `left-default-checked` 和 `right-default-checked` 属性。最后，本例还展示了 `change` 事件的用法。注意：由于 jsfiddle 不支持 JSX 语法，所以使用 `render-content` 自定义数据项的例子在 jsfiddle 中无法运行。但是在实际的项目中，只要正确地配置了相关依赖，就可以正常运行。
+```html
+<template>
+  <p style="text-align: center; margin: 0 0 20px">使用 render-content 自定义数据项</p>
+  <div style="text-align: center">
+    <el-transfer
+      style="text-align: left; display: inline-block"
+      v-model="value"
+      filterable
+      :left-default-checked="[2, 3]"
+      :right-default-checked="[1]"
+      :render-content="renderFunc"
+      :titles="['Source', 'Target']"
+      :button-texts="['到左边', '到右边']"
+      :format="{
+        noChecked: '${total}',
+        hasChecked: '${checked}/${total}'
+      }"
+      @change="handleChange"
+      :data="data">
+      <el-button class="transfer-footer" slot="left-footer" size="small">操作</el-button>
+      <el-button class="transfer-footer" slot="right-footer" size="small">操作</el-button>
+    </el-transfer>
+  </div>
+  <p style="text-align: center; margin: 50px 0 20px">使用 scoped-slot 自定义数据项</p>
+  <div style="text-align: center">
+    <el-transfer
+      style="text-align: left; display: inline-block"
+      v-model="value4"
+      filterable
+      :left-default-checked="[2, 3]"
+      :right-default-checked="[1]"
+      :titles="['Source', 'Target']"
+      :button-texts="['到左边', '到右边']"
+      :format="{
+        noChecked: '${total}',
+        hasChecked: '${checked}/${total}'
+      }"
+      @change="handleChange"
+      :data="data">
+      <span slot-scope="{ option }">{{ option.key }} - {{ option.label }}</span>
+      <el-button class="transfer-footer" slot="left-footer" size="small">操作</el-button>
+      <el-button class="transfer-footer" slot="right-footer" size="small">操作</el-button>
+    </el-transfer>
+  </div>
+</template>
+
+<style>
+  .transfer-footer {
+    margin-left: 20px;
+    padding: 6px 5px;
+  }
+</style>
+
+<script>
+  export default {
+    data() {
+      const generateData = _ => {
+        const data = [];
+        for (let i = 1; i <= 15; i++) {
+          data.push({
+            key: i,
+            label: `备选项 ${ i }`,
+            disabled: i % 4 === 0
+          });
+        }
+        return data;
+      };
+      return {
+        data: generateData(),
+        value: [1],
+        value4: [1],
+        renderFunc(h, option) {
+          return <span>{ option.key } - { option.label }</span>;
+        }
+      };
+    },
+
+    methods: {
+      handleChange(value, direction, movedKeys) {
+        console.log(value, direction, movedKeys);
+      }
+    }
+  };
+</script>
+```
+:::
+
+### 数据项属性别名
+
+默认情况下，Transfer 仅能识别数据项中的 `key`、`label` 和 `disabled` 字段。如果你的数据的字段名不同，可以使用 `props` 属性为它们设置别名。
+:::demo 本例中的数据源没有 `key` 和 `label` 字段，在功能上与它们相同的字段名为 `value` 和 `desc`。因此可以使用`props` 属性为 `key` 和 `label` 设置别名。
+```html
+<template>
+  <el-transfer
+    v-model="value"
+    :props="{
+      key: 'value',
+      label: 'desc'
+    }"
+    :data="data">
+  </el-transfer>
+</template>
+
+<script>
+  export default {
+    data() {
+      const generateData = _ => {
+        const data = [];
+        for (let i = 1; i <= 15; i++) {
+          data.push({
+            value: i,
+            desc: `备选项 ${ i }`,
+            disabled: i % 4 === 0
+          });
+        }
+        return data;
+      };
+      return {
+        data: generateData(),
+        value: []
+      };
+    }
+  };
+</script>
+```
+:::
+
+### Attributes
+| 参数      | 说明    | 类型      | 可选值       | 默认值   |
+|---------- |-------- |---------- |-------------  |-------- |
+| value / v-model | 绑定值 | array | — | — |
+| data | Transfer 的数据源 | array[{ key, label, disabled }] | — | [ ] |
+| filterable | 是否可搜索 | boolean | — | false |
+| filter-placeholder | 搜索框占位符 | string | — | 请输入搜索内容 |
+| filter-method | 自定义搜索方法 | function | — | — |
+| target-order | 右侧列表元素的排序策略：若为 `original`，则保持与数据源相同的顺序；若为 `push`，则新加入的元素排在最后；若为 `unshift`，则新加入的元素排在最前 | string | original / push / unshift | original |
+| titles | 自定义列表标题 | array | — | ['列表 1', '列表 2'] |
+| button-texts | 自定义按钮文案 | array | — | [ ] |
+| render-content | 自定义数据项渲染函数 | function(h, option) | — | — |
+| format | 列表顶部勾选状态文案 | object{noChecked, hasChecked} | — | { noChecked: '${checked}/${total}', hasChecked: '${checked}/${total}' } |
+| props | 数据源的字段别名 | object{key, label, disabled} | — | — |
+| left-default-checked | 初始状态下左侧列表的已勾选项的 key 数组 | array | — | [ ] |
+| right-default-checked | 初始状态下右侧列表的已勾选项的 key 数组 | array | — | [ ] |
+
+### Slot
+| name | 说明 |
+|------|--------|
+| left-footer | 左侧列表底部的内容 |
+| right-footer | 右侧列表底部的内容 |
+
+### Scoped Slot
+| name | 说明 |
+|------|--------|
+| — | 自定义数据项的内容，参数为 { option } |
+
+### Methods
+| 方法名 | 说明 | 参数 |
+| ---- | ---- | ---- |
+| clearQuery | 清空某个面板的搜索关键词 | 'left' / 'right'，指定需要清空的面板 |
+
+### Events
+| 事件名称      | 说明    | 回调参数      |
+|---------- |-------- |---------- |
+| change | 右侧列表元素变化时触发 | 当前值、数据移动的方向（'left' / 'right'）、发生移动的数据 key 数组 |
+| left-check-change | 左侧列表元素被用户选中 / 取消选中时触发 | 当前被选中的元素的 key 数组、选中状态发生变化的元素的 key 数组 |
+| right-check-change | 右侧列表元素被用户选中 / 取消选中时触发 | 当前被选中的元素的 key 数组、选中状态发生变化的元素的 key 数组 |