element-ui Steps步骤条组件源码分析整理笔记（九）
Steps步骤条组件源码：
steps.vue
<template>
<!--设置 simple 可应用简洁风格，该条件下 align-center / description / direction / space 都将失效。-->
<div
class="el-steps"
:class="[
!simple && 'el-steps--' + direction,
simple && 'el-steps--simple'
]">
<slot></slot>
</div>
</template>
<script>
import Migrating from 'element-ui/src/mixins/migrating';
export default {
name: 'ElSteps',
mixins: [Migrating],
props: {
space: [Number, String], //每个 step 的间距，不填写将自适应间距。支持百分比。
active: Number, //设置当前激活步骤
direction: { //显示方向
type: String,
default: 'horizontal'
},
alignCenter: Boolean, //进行居中对齐
simple: Boolean, // 是否应用简洁风格
finishStatus: { //设置结束步骤的状态
type: String,
default: 'finish'
},
processStatus: { //设置当前步骤的状态
type: String,
default: 'process'
}
},
data() {
return {
steps: [], //记录步骤数数组
stepOffset: 0
};
},
methods: {
// 属性迁移
getMigratingConfig() {
return {
props: {
'center': 'center is removed.'
}
};
}
},
watch: {
active(newVal, oldVal) {
// 当前激活步骤改变时，触发父组件的change方法，将改变前和改变后的步骤作为参数传递出去
this.$emit('change', newVal, oldVal);
},
steps(steps) {
steps.forEach((child, index) => {
child.index = index;
});
}
}
};
</script>
step.vue
<template>
<!--每一步骤的最外层包裹div-->
<div
class="el-step"
:style="style"
:class="[
!isSimple && `is-${$parent.direction}`,
isSimple && 'is-simple',
isLast && !space && !isCenter && 'is-flex',
isCenter && !isVertical && !isSimple && 'is-center'
]">
<!-- 步骤的数字图标和步骤条直线 -->
<div class="el-step__head" :class="`is-${currentStatus}`">
<!--步骤条直线-->
<!--如果是最后一步，margin-right不存在；如果不是，则为0-->
<div class="el-step__line" :style="isLast ? '' : { marginRight: $parent.stepOffset + 'px' }">
<i class="el-step__line-inner" :style="lineStyle"></i>
</div>
<!--步骤条的数字图标-->
<div class="el-step__icon" :class="`is-${icon ? 'icon' : 'text'}`">
<!--如果当前状态为：wait、process、finish-->
<slot v-if="currentStatus !== 'success' && currentStatus !== 'error'" name="icon">
<!--如果是图标则显示对应的图标-->
<i v-if="icon" class="el-step__icon-inner" :class="[icon]"></i>
<!--如果图标和未设置isSimple简洁风格时，则显示步骤文字-->
<div class="el-step__icon-inner" v-if="!icon && !isSimple">{{ index + 1 }}</div>
</slot>
<!--如果当前状态为：success、error-->
<i v-else :class="['el-icon-' + (currentStatus === 'success' ? 'check' : 'close')]" class="el-step__icon-inner is-status"></i>
</div>
</div>
<!-- 步骤条下面每一步的标题和描述 -->
<div class="el-step__main">
<!--每一步的标题-->
<div class="el-step__title" ref="title" :class="['is-' + currentStatus]">
<slot name="title">{{ title }}</slot>
</div>
<!--简洁模式下会有>图标-->
<div v-if="isSimple" class="el-step__arrow"></div>
<!--每一步的描述-->
<div v-else class="el-step__description" :class="['is-' + currentStatus]">
<slot name="description">{{ description }}</slot>
</div>
</div>
</div>
</template>
<script>
export default {
name: 'ElStep',
props: {
title: String, //标题
icon: String, //图标
description: String, //描述性文字
status: String //设置当前步骤的状态，不设置则根据 steps 确定状态。 wait（灰色）/ process（黑色）/ finish（蓝色）/ error / success（绿色）
},
data() {
return {
index: -1,
lineStyle: {}, //步骤条直线的样式
internalStatus: ''
};
},
beforeCreate() {
this.$parent.steps.push(this);
},
mounted() {
const unwatch = this.$watch('index', val => {
this.$watch('$parent.active', this.updateStatus, { immediate: true });
unwatch();
});
},
beforeDestroy() {
const steps = this.$parent.steps;
const index = steps.indexOf(this);
if (index >= 0) {
steps.splice(index, 1);
}
},
computed: {
// 返回当前步骤的状态
currentStatus() {
return this.status || this.internalStatus;
},
prevStatus() {
const prevStep = this.$parent.steps[this.index - 1];
return prevStep ? prevStep.currentStatus : 'wait';
},
// 返回是否是居中对齐
isCenter() {
return this.$parent.alignCenter;
},
// 返回显示的方向:竖直(false)或者水平(true)
isVertical() {
return this.$parent.direction === 'vertical';
},
// 返回是否应用简洁风格
isSimple() {
return this.$parent.simple;
},
// 判断当前是不是最后步骤
isLast() {
const parent = this.$parent;
return parent.steps[parent.steps.length - 1] === this;
},
// 返回总步骤数
stepsCount() {
return this.$parent.steps.length;
},
// 返回每个step的间距。
space() {
const { isSimple, $parent: { space } } = this;
// isSimple为true时，space将失效
return isSimple ? '' : space ;
},
style: function() {
const style = {};
const parent = this.$parent;
const len = parent.steps.length; //总步骤
// 每个step的间距
const space = (typeof this.space === 'number' //如果设置的space是number
? this.space + 'px' //space等于设置的space
: this.space ? this.space : 100 / (len - (this.isCenter ? 0 : 1)) + '%'); //如果未设置space，未设置居中，则等于100除以（总步骤数-1）；设置居中显示，则等于00除以总步骤数。
// flex-basis 属性用于设置或检索弹性盒伸缩基准值。
style.flexBasis = space;
//如果是水平方向则直接返回设置的样式
if (this.isVertical) return style;
//如果是最后的步骤，设置最大宽度等于(100/总步骤数)%
if (this.isLast) {
style.maxWidth = 100 / this.stepsCount + '%';
} else {
//如果不是最后的步骤，marginRight为0
style.marginRight = -this.$parent.stepOffset + 'px';
}
return style;
}
},
methods: {
updateStatus(val) {
const prevChild = this.$parent.$children[this.index - 1];
if (val > this.index) { //如果是下一步
// internalStatus 等于用户设置的结束步骤状态
this.internalStatus = this.$parent.finishStatus;
} else if (val === this.index && this.prevStatus !== 'error') {
// internalStatus 等于用户设置的当前步骤状态
this.internalStatus = this.$parent.processStatus;
} else {
this.internalStatus = 'wait';
}
if (prevChild) prevChild.calcProgress(this.internalStatus);
},
//设置步骤间直线的样式
calcProgress(status) {
let step = 100;
const style = {};
// transitionDelay在过渡效果开始前等待的秒数：
style.transitionDelay = 150 * this.index + 'ms';
if (status === this.$parent.processStatus) {
step = this.currentStatus !== 'error' ? 0 : 0;
} else if (status === 'wait') {
step = 0;
//为负数的时候过渡的动作会从该时间点开始显示，之前的动作被截断；为正数的时候过渡的动作会延迟触发。
style.transitionDelay = (-150 * this.index) + 'ms';
}
style.borderWidth = step ? '1px' : 0;
this.$parent.direction === 'vertical'
? style.height = step + '%'
: style.width = step + '%';
this.lineStyle = style;
}
}
};
</script>
