@tdesign/uniapp 0.0.1-alpha.1 → 0.7.0

package/dist/steps/README.md

@@ -0,0 +1,157 @@
+---
+title: Steps 步骤条
+description: 用于任务步骤展示或任务进度展示。
+spline: navigation
+isComponent: true
+---
+
+
+## 引入
+
+可在 `main.ts` 或在需要使用的页面或组件中引入。
+
+```js
+import TSteps from '@tdesign/uniapp/steps/steps.vue';
+import TStepsItem from '@tdesign/uniapp/steps-item/steps-item.vue';
+```
+
+## 代码演示
+
+步骤条，方向可以横向和纵向，可以自定义步骤条显示内容以及是否可写
+
+<a href="https://developers.weixin.qq.com/s/3H9EuimQ7JS0" title="在开发者工具中预览效果" target="_blank" rel="noopener noreferrer"> 在开发者工具中预览效果 </a>
+
+<blockquote style="background-color: #d9e1ff; font-size: 15px; line-height: 26px;margin: 16px 0 0;padding: 16px; border-radius: 6px; color: #0052d9" >
+<p>Tips: 请确保开发者工具为打开状态。导入开发者工具后，依次执行：npm i > 构建npm包 > 勾选 "将JS编译成ES5"</p>
+</blockquote>
+
+### 组件类型
+
+#### 水平步骤条
+
+支持三种类型：序号、图标、简略
+
+{{ horizontal }}
+
+#### 垂直步骤条
+
+支持三种类型：序号、图标、简略
+
+{{ vertical }}
+
+### 组件状态
+
+#### 选项卡状态
+
+共支持 4 种状态：未完成（default）、已完成（finish）、进行中（process）、错误（error）
+
+{{ status }}
+
+### 特殊类型
+
+通过已有特性，改造出两种常见类型：
+
+- 垂直自定义（在 Cascader 中使用）
+- 纯展示步骤条
+
+可以参考以下代码实现
+
+{{ special }}
+
+## API
+
+### Steps Props
+
+名称 | 类型 | 默认值 | 描述 | 必传
+-- | -- | -- | -- | --
+custom-style | Object | - | 自定义样式 | N
+current | String / Number | - | 当前步骤，即整个步骤条进度。默认根据步骤下标判断步骤的完成状态，当前步骤为进行中，当前步骤之前的步骤为已完成，当前步骤之后的步骤为未开始。如果每个步骤没有设置 value，current 值为步骤长度则表示所有步骤已完成。如果每个步骤设置了自定义 value，则 current = 'FINISH' 表示所有状态完成。支持语法糖 `v-model:current` | N
+default-current | String / Number | - | 当前步骤，即整个步骤条进度。默认根据步骤下标判断步骤的完成状态，当前步骤为进行中，当前步骤之前的步骤为已完成，当前步骤之后的步骤为未开始。如果每个步骤没有设置 value，current 值为步骤长度则表示所有步骤已完成。如果每个步骤设置了自定义 value，则 current = 'FINISH' 表示所有状态完成。非受控属性 | N
+current-status | String | process | 用于控制 current 指向的步骤条的状态。可选项：default/process/finish/error | N
+layout | String | horizontal | 步骤条方向，有两种：横向和纵向。可选项：horizontal/vertical | N
+readonly | Boolean | undefined | 只读状态 | N
+sequence | String | positive | 步骤条顺序。可选项：positive/reverse | N
+theme | String | default | 步骤条风格。可选项：default/dot | N
+
+### Steps Events
+
+名称 | 参数 | 描述
+-- | -- | --
+change | `(context: {current: string \| number, previous: string \| number})` | 当前步骤发生变化时触发
+
+### Steps Slots
+
+名称 | 描述
+-- | --
+\- | 默认插槽，自定义步骤条内容
+
+### Steps External Classes
+
+类名 | 描述
+-- | --
+t-class | 根节点样式类
+
+
+### StepItem Props
+
+名称 | 类型 | 默认值 | 描述 | 必传
+-- | -- | -- | -- | --
+custom-style | Object | - | 自定义样式 | N
+content | String | '' | 步骤描述 | N
+extra | String | - | 步骤条自定义内容 | N
+icon | String | - | 图标。传入 slot 代表使用插槽，其他字符串代表使用内置图标 | N
+status | String | default | 当前步骤的状态：默认状态（未开始）、进行中状态、完成状态、错误状态。可选项：default/process/finish/error。TS 类型：`StepStatus` `type StepStatus = 'default' \| 'process' \| 'finish' \| 'error'`。[详细类型定义](https://github.com/Tencent/tdesign-miniprogram/tree/develop/packages/uniapp-components/step-item/type.ts) | N
+sub-step-items | Array | [] | 已废弃。子步骤条，仅支持 layout  = 'vertical' 时。TS 类型：`SubStepItem[]` `interface SubStepItem { status: StepStatus, title: string }`。[详细类型定义](https://github.com/Tencent/tdesign-miniprogram/tree/develop/packages/uniapp-components/step-item/type.ts) | N
+title | String | '' | 标题 | N
+
+### StepItem Slots
+
+名称 | 描述
+-- | --
+\- | 默认插槽，自定义步骤内容
+content | 自定义 `content` 显示内容
+extra | 自定义 `extra` 显示内容
+icon | 自定义 `icon` 显示内容
+title | 自定义 `title` 显示内容
+
+### StepItem External Classes
+
+类名 | 描述
+-- | --
+t-class | 根节点样式类
+t-class-content | 内容样式类
+t-class-description | 描述样式类
+t-class-extra | 额外样式类
+t-class-title | 标题样式类
+
+### CSS Variables
+
+组件提供了下列 CSS 变量，可用于自定义样式。
+名称 | 默认值 | 描述 
+-- | -- | --
+--td-step-item-circle-size | 44rpx | -
+--td-step-item-circle-text-font | @font-body-medium | -
+--td-step-item-default-circle-bg | @bg-color-secondarycontainer | -
+--td-step-item-default-circle-color | @text-color-placeholder | -
+--td-step-item-default-dot-border-color | @component-border | -
+--td-step-item-default-icon-color | @text-color-placeholder | -
+--td-step-item-default-title-color | @text-color-placeholder | -
+--td-step-item-description-color | @text-color-placeholder | -
+--td-step-item-dot-size | 16rpx | -
+--td-step-item-error-circle-bg | @error-color-1 | -
+--td-step-item-error-circle-color | @error-color | -
+--td-step-item-error-dot-border-color | @error-color | -
+--td-step-item-error-icon-color | @error-color | -
+--td-step-item-error-title-color | @error-color | -
+--td-step-item-finish-circle-bg | @brand-color-light | -
+--td-step-item-finish-circle-color | @brand-color | -
+--td-step-item-finish-dot-border-color | @brand-color | -
+--td-step-item-finish-icon-color | @brand-color | -
+--td-step-item-finish-line-color | @brand-color | -
+--td-step-item-finish-title-color | @text-color-primary | -
+--td-step-item-line-color | @component-border | -
+--td-step-item-process-circle-bg | @brand-color | -
+--td-step-item-process-circle-color | @text-color-anti | -
+--td-step-item-process-dot-border-color | @brand-color | -
+--td-step-item-process-icon-color | @brand-color | -
+--td-step-item-process-title-color | @brand-color | -

package/dist/steps/props.ts

@@ -0,0 +1,63 @@
+/* eslint-disable */
+
+/**
+ * 该文件为脚本自动生成文件，请勿随意修改。如需修改请联系 PMC
+ * */
+
+import type { TdStepsProps } from './type';
+export default {
+  /** 当前步骤，即整个步骤条进度。默认根据步骤下标判断步骤的完成状态，当前步骤为进行中，当前步骤之前的步骤为已完成，当前步骤之后的步骤为未开始。如果每个步骤没有设置 value，current 值为步骤长度则表示所有步骤已完成。如果每个步骤设置了自定义 value，则 current = 'FINISH' 表示所有状态完成 */
+  current: {
+    type: [String, Number],
+  },
+  /** 当前步骤，即整个步骤条进度。默认根据步骤下标判断步骤的完成状态，当前步骤为进行中，当前步骤之前的步骤为已完成，当前步骤之后的步骤为未开始。如果每个步骤没有设置 value，current 值为步骤长度则表示所有步骤已完成。如果每个步骤设置了自定义 value，则 current = 'FINISH' 表示所有状态完成，非受控属性 */
+  defaultCurrent: {
+    type: [String, Number],
+  },
+  /** 用于控制 current 指向的步骤条的状态 */
+  currentStatus: {
+    type: String,
+    default: 'process' as TdStepsProps['currentStatus'],
+    validator(val: TdStepsProps['currentStatus']): boolean {
+      if (!val) return true;
+      return ['default', 'process', 'finish', 'error'].includes(val);
+    },
+  },
+  /** 步骤条方向，有两种：横向和纵向 */
+  layout: {
+    type: String,
+    default: 'horizontal' as TdStepsProps['layout'],
+    validator(val: TdStepsProps['layout']): boolean {
+      if (!val) return true;
+      return ['horizontal', 'vertical'].includes(val);
+    },
+  },
+  /** 只读状态 */
+  readonly: {
+    type: Boolean,
+    default: undefined,
+  },
+  /** 步骤条顺序 */
+  sequence: {
+    type: String,
+    default: 'positive' as TdStepsProps['sequence'],
+    validator(val: TdStepsProps['sequence']): boolean {
+      if (!val) return true;
+      return ['positive', 'reverse'].includes(val);
+    },
+  },
+  /** 步骤条风格 */
+  theme: {
+    type: String,
+    default: 'default' as TdStepsProps['theme'],
+    validator(val: TdStepsProps['theme']): boolean {
+      if (!val) return true;
+      return ['default', 'dot'].includes(val);
+    },
+  },
+  /** 当前步骤发生变化时触发 */
+  onChange: {
+    type: Function,
+    default: () => ({}),
+  },
+};

package/dist/steps/steps.css

@@ -0,0 +1,19 @@
+:host {
+  display: flex;
+}
+.t-step--vertical {
+  padding-right: 32rpx;
+}
+.t-steps {
+  display: flex;
+  width: 100%;
+}
+.t-steps--vertical {
+  flex-direction: column;
+}
+.t-steps--reverse {
+  flex-direction: row-reverse;
+}
+.t-steps--vertical.t-steps--reverse {
+  flex-direction: column-reverse;
+}

package/dist/steps/steps.vue

@@ -0,0 +1,122 @@
+<template>
+  <view
+    :style="tools._style([customStyle])"
+    :class="tools.cls(classPrefix, [layout, ['readonly', readonly], sequence]) + ' ' + tClass"
+  >
+    <slot />
+  </view>
+</template>
+<script>
+import { uniComponent } from '../common/src/index';
+import { prefix } from '../common/config';
+import props from './props';
+import tools from '../common/utils.wxs';
+import { ParentMixin, RELATION_MAP } from '../common/relation';
+
+
+const name = `${prefix}-steps`;
+
+
+export default uniComponent({
+  name,
+  options: {
+    styleIsolation: 'shared',
+  },
+  controlledProps: [
+    {
+      key: 'current',
+      event: 'change',
+    },
+  ],
+  externalClasses: [
+    `${prefix}-class`,
+  ],
+  mixins: [ParentMixin(RELATION_MAP.StepItem)],
+  props: {
+    ...props,
+  },
+  data() {
+    return {
+      prefix,
+      classPrefix: name,
+      tools,
+
+      dataCurrent: this.current,
+    };
+  },
+  watch: {
+    current: {
+      handler(v) {
+        this.dataCurrent = v;
+      },
+      immediate: true,
+    },
+    dataCurrent: {
+      handler() {
+        this.updateChildren();
+      },
+      immediate: true,
+    },
+    theme: 'updateChildren',
+    sequence: 'updateChildren',
+  },
+  mounted() {
+
+  },
+  methods: {
+    innerAfterLinked(child) {
+      this.updateChildren();
+
+      const { readonly } = this;
+
+      child.readonly = readonly;
+    },
+    innerAfterUnlinked() {
+      this.updateLastChid();
+    },
+    updateChildren() {
+      const items = this.children;
+      const {
+        dataCurrent, currentStatus, theme, layout, sequence,
+      } = this;
+
+      items?.forEach((item, index) => {
+        item.updateStatus({
+          index,
+          items,
+
+          current: dataCurrent,
+          currentStatus,
+          theme,
+          layout,
+          sequence,
+        });
+      });
+    },
+    updateLastChid() {
+      const items = this.children;
+
+      items.forEach((child, index) => child.isLastChild = index === items.length - 1);
+    },
+    handleClick(index) {
+      if (!this.readonly) {
+        const preIndex = this.dataCurrent;
+        this._trigger('change', {
+          previous: preIndex,
+          current: index,
+        });
+      }
+    },
+  },
+});
+</script>
+<style scoped>
+@import './steps.css';
+
+/* #ifndef MP-WEIXIN */
+/* 适配 qq 小程序等 */
+:deep(t-step-item) {
+  flex: 1;
+}
+/* #endif */
+</style>

package/dist/steps/type.ts

@@ -0,0 +1,44 @@
+/* eslint-disable */
+
+/**
+ * 该文件为脚本自动生成文件，请勿随意修改。如需修改请联系 PMC
+ * */
+
+export interface TdStepsProps {
+  /**
+   * 当前步骤，即整个步骤条进度。默认根据步骤下标判断步骤的完成状态，当前步骤为进行中，当前步骤之前的步骤为已完成，当前步骤之后的步骤为未开始。如果每个步骤没有设置 value，current 值为步骤长度则表示所有步骤已完成。如果每个步骤设置了自定义 value，则 current = 'FINISH' 表示所有状态完成
+   */
+  current?: string | number;
+  /**
+   * 当前步骤，即整个步骤条进度。默认根据步骤下标判断步骤的完成状态，当前步骤为进行中，当前步骤之前的步骤为已完成，当前步骤之后的步骤为未开始。如果每个步骤没有设置 value，current 值为步骤长度则表示所有步骤已完成。如果每个步骤设置了自定义 value，则 current = 'FINISH' 表示所有状态完成，非受控属性
+   */
+  defaultCurrent?: string | number;
+  /**
+   * 用于控制 current 指向的步骤条的状态
+   * @default process
+   */
+  currentStatus?: 'default' | 'process' | 'finish' | 'error';
+  /**
+   * 步骤条方向，有两种：横向和纵向
+   * @default horizontal
+   */
+  layout?: 'horizontal' | 'vertical';
+  /**
+   * 只读状态
+   */
+  readonly?: boolean;
+  /**
+   * 步骤条顺序
+   * @default positive
+   */
+  sequence?: 'positive' | 'reverse';
+  /**
+   * 步骤条风格
+   * @default default
+   */
+  theme?: 'default' | 'dot';
+  /**
+   * 当前步骤发生变化时触发
+   */
+  onChange?: (context: { current: string | number; previous: string | number }) => void;
+}

package/dist/sticky/README.en-US.md

@@ -0,0 +1,32 @@
+:: BASE_DOC ::
+
+## API
+
+### Sticky Props
+
+name | type | default | description | required
+-- | -- | -- | -- | --
+custom-style | Object | - | CSS(Cascading Style Sheets) | N
+container | Function | - | \- | N
+disabled | Boolean | false | \- | N
+offset-top | String / Number | 0 | \- | N
+z-index | Number | 99 | \- | N
+
+### Sticky Events
+
+name | params | description
+-- | -- | --
+scroll | `(context: { scrollTop: number, isFixed: boolean })` | \-
+
+### Sticky Slots
+
+name | Description
+-- | --
+\- | \-
+
+### Sticky External Classes
+
+className | Description
+-- | --
+t-class | \-
+t-class-content | \-

package/dist/sticky/README.md

@@ -0,0 +1,66 @@
+---
+title: Sticky 吸顶
+description: 用于常驻页面顶部的信息、操作展示。
+spline: data
+isComponent: true
+---
+
+
+## 引入
+
+可在 `main.ts` 或在需要使用的页面或组件中引入。
+
+```js
+import TSticky from '@tdesign/uniapp/sticky/sticky.vue';
+```
+
+## 代码演示
+
+将内容包裹在 `Sticky` 组件内
+
+
+### 基础吸顶
+
+{{ base }}
+
+
+### 吸顶距离
+
+{{ offset }}
+
+### 指定容器
+
+{{ container }}
+
+
+
+## API
+
+### Sticky Props
+
+名称 | 类型 | 默认值 | 描述 | 必传
+-- | -- | -- | -- | --
+custom-style | Object | - | 自定义样式 | N
+container | Function | - | 函数返回容器对应的 NodesRef 节点，将对应节点指定为组件的外部容器，滚动时组件会始终保持在容器范围内，当组件即将超出容器底部时，会返回原位置 | N
+disabled | Boolean | false | 是否禁用组件 | N
+offset-top | String / Number | 0 | 吸顶时与顶部的距离，单位`px` | N
+z-index | Number | 99 | 吸顶时的 z-index | N
+
+### Sticky Events
+
+名称 | 参数 | 描述
+-- | -- | --
+scroll | `(context: { scrollTop: number, isFixed: boolean })` | 滚动时触发，scrollTop: 距离顶部位置，isFixed: 是否吸顶
+
+### Sticky Slots
+
+名称 | 描述
+-- | --
+\- | 默认插槽，自定义内容区域内容
+
+### Sticky External Classes
+
+类名 | 描述
+-- | --
+t-class | 根节点样式类
+t-class-content | 内容样式类

package/dist/sticky/props.ts

@@ -0,0 +1,30 @@
+/* eslint-disable */
+
+/**
+ * 该文件为脚本自动生成文件，请勿随意修改。如需修改请联系 PMC
+ * */
+
+import type { TdStickyProps } from './type';
+export default {
+  /** 函数返回容器对应的 NodesRef 节点，将对应节点指定为组件的外部容器，滚动时组件会始终保持在容器范围内，当组件即将超出容器底部时，会返回原位置 */
+  container: {
+    type: Function,
+  },
+  /** 是否禁用组件 */
+  disabled: Boolean,
+  /** 吸顶时与顶部的距离，单位`px` */
+  offsetTop: {
+    type: [String, Number],
+    default: 0 as TdStickyProps['offsetTop'],
+  },
+  /** 吸顶时的 z-index */
+  zIndex: {
+    type: Number,
+    default: 99,
+  },
+  /** 滚动时触发，scrollTop: 距离顶部位置，isFixed: 是否吸顶 */
+  onScroll: {
+    type: Function,
+    default: () => ({}),
+  },
+};

package/dist/sticky/sticky.css

@@ -0,0 +1,3 @@
+.t-sticky {
+  position: relative;
+}

package/dist/sticky/sticky.vue

@@ -0,0 +1,144 @@
+<template>
+  <view
+    :class="classPrefix + ' ' + tClass"
+    :style="tools._style(['z-index:' + zIndex, containerStyle, customStyle])"
+  >
+    <view
+      :class="classPrefix + '__content ' + tClassContent"
+      :style="tools._style(['z-index:' + zIndex, contentStyle])"
+    >
+      <slot />
+    </view>
+  </view>
+</template>
+<script>
+import { uniComponent } from '../common/src/index';
+import props from './props';
+import { prefix } from '../common/config';
+import pageScrollMixin from '../mixins/page-scroll';
+import { getRect, nextTick } from '../common/utils';
+import tools from '../common/utils.wxs';
+
+
+const name = `${prefix}-sticky`;
+const ContainerClass = `.${name}`;
+
+
+export default uniComponent({
+  name,
+  options: {
+    styleIsolation: 'shared',
+  },
+  externalClasses: [
+    `${prefix}-class`,
+    `${prefix}-class-content`,
+  ],
+  mixins: [pageScrollMixin()],
+  props: {
+    ...props,
+  },
+  data() {
+    return {
+      prefix,
+      classPrefix: name,
+      containerStyle: '',
+      contentStyle: '',
+      tools,
+    };
+  },
+  watch: {
+    offsetTop: 'onScroll',
+    disabled: 'onScroll',
+    container: 'onScroll',
+  },
+  mounted() {
+    this.onScroll();
+  },
+  methods: {
+    onScroll(event) {
+      const { scrollTop } = event || {};
+      const { container, offsetTop, disabled } = this;
+
+      if (disabled) {
+        this.setDataAfterDiff({
+          isFixed: false,
+          transform: 0,
+        });
+        return;
+      }
+
+      this.scrollTop = scrollTop || this.scrollTop;
+
+      if (typeof container === 'function') {
+        Promise.all([getRect(this, ContainerClass), this.getContainerRect()]).then(([root, container]) => {
+          if (!root || !container) return;
+          if (offsetTop + root.height > container.height + container.top) {
+            this.setDataAfterDiff({
+              isFixed: false,
+              transform: container.height - root.height,
+            });
+          } else if (offsetTop >= root.top) {
+            this.setDataAfterDiff({
+              isFixed: true,
+              height: root.height,
+              transform: 0,
+            });
+          } else {
+            this.setDataAfterDiff({ isFixed: false, transform: 0 });
+          }
+        });
+
+        return;
+      }
+
+      getRect(this, ContainerClass).then((root) => {
+        if (!root) return;
+        if (offsetTop >= root.top) {
+          this.setDataAfterDiff({ isFixed: true, height: root.height });
+          this.transform = 0;
+        } else {
+          this.setDataAfterDiff({ isFixed: false });
+        }
+      });
+    },
+
+    setDataAfterDiff(data) {
+      const { offsetTop } = this;
+      const { containerStyle: prevContainerStyle, contentStyle: prevContentStyle } = this;
+      const { isFixed, height, transform } = data;
+      nextTick().then(() => {
+        let containerStyle = '';
+        let contentStyle = '';
+
+        if (isFixed) {
+          containerStyle += `height:${height}px;`;
+          contentStyle += `position:fixed;top:${offsetTop}px;left:0;right:0;`;
+        }
+        if (transform) {
+          const translate = `translate3d(0, ${transform}px, 0)`;
+          contentStyle += `-webkit-transform:${translate};transform:${translate};`;
+        }
+
+        if (prevContainerStyle !== containerStyle || prevContentStyle !== contentStyle) {
+          this.containerStyle = containerStyle;
+          this.contentStyle = contentStyle;
+        }
+
+        this.$emit('scroll', {
+          scrollTop: this.scrollTop,
+          isFixed,
+        });
+      });
+    },
+
+    getContainerRect() {
+      const nodesRef = this.container();
+      return new Promise(resolve => nodesRef.boundingClientRect(resolve).exec());
+    },
+  },
+});
+
+</script>
+<style scoped>
+@import './sticky.css';
+</style>