quanyawei
2023-10-20 d8b41fff43a2cee6a8f714ffa807623b15803786
uni_modules/uview-ui/components/u-calendar/u-calendar.vue
New file
@@ -0,0 +1,384 @@
<template>
   <u-popup
      :show="show"
      mode="bottom"
      closeable
      @close="close"
      :round="round"
      :closeOnClickOverlay="closeOnClickOverlay"
   >
      <view class="u-calendar">
         <uHeader
            :title="title"
            :subtitle="subtitle"
            :showSubtitle="showSubtitle"
            :showTitle="showTitle"
         ></uHeader>
         <scroll-view
            :style="{
                    height: $u.addUnit(listHeight)
                }"
            scroll-y
            @scroll="onScroll"
            :scroll-top="scrollTop"
            :scrollIntoView="scrollIntoView"
         >
            <uMonth
               :color="color"
               :rowHeight="rowHeight"
               :showMark="showMark"
               :months="months"
               :mode="mode"
               :maxCount="maxCount"
               :startText="startText"
               :endText="endText"
               :defaultDate="defaultDate"
               :minDate="innerMinDate"
               :maxDate="innerMaxDate"
               :maxMonth="monthNum"
               :readonly="readonly"
               :maxRange="maxRange"
               :rangePrompt="rangePrompt"
               :showRangePrompt="showRangePrompt"
               :allowSameDay="allowSameDay"
               ref="month"
               @monthSelected="monthSelected"
               @updateMonthTop="updateMonthTop"
            ></uMonth>
         </scroll-view>
         <slot name="footer" v-if="showConfirm">
            <view class="u-calendar__confirm">
               <u-button
                  shape="circle"
                  :text="
                            buttonDisabled ? confirmDisabledText : confirmText
                        "
                  :color="color"
                  @click="confirm"
                  :disabled="buttonDisabled"
               ></u-button>
            </view>
         </slot>
      </view>
   </u-popup>
</template>
<script>
import uHeader from './header.vue'
import uMonth from './month.vue'
import props from './props.js'
import util from './util.js'
import dayjs from '../../libs/util/dayjs.js'
import Calendar from '../../libs/util/calendar.js'
/**
 * Calendar 日历
 * @description  此组件用于单个选择日期,范围选择日期等,日历被包裹在底部弹起的容器中.
 * @tutorial https://www.uviewui.com/components/calendar.html
 *
 * @property {String}            title            标题内容 (默认 日期选择 )
 * @property {Boolean}            showTitle         是否显示标题  (默认 true )
 * @property {Boolean}            showSubtitle      是否显示副标题   (默认 true )
 * @property {String}            mode            日期类型选择  single-选择单个日期,multiple-可以选择多个日期,range-选择日期范围 ( 默认 'single' )
 * @property {String}            startText         mode=range时,第一个日期底部的提示文字  (默认 '开始' )
 * @property {String}            endText            mode=range时,最后一个日期底部的提示文字 (默认 '结束' )
 * @property {Array}            customList         自定义列表
 * @property {String}            color            主题色,对底部按钮和选中日期有效  (默认 ‘#3c9cff' )
 * @property {String | Number}      minDate            最小的可选日期    (默认 0 )
 * @property {String | Number}      maxDate            最大可选日期  (默认 0 )
 * @property {Array | String| Date}   defaultDate         默认选中的日期,mode为multiple或range是必须为数组格式
 * @property {String | Number}      maxCount         mode=multiple时,最多可选多少个日期  (默认    Number.MAX_SAFE_INTEGER  )
 * @property {String | Number}      rowHeight         日期行高 (默认 56 )
 * @property {Function}            formatter         日期格式化函数
 * @property {Boolean}            showLunar         是否显示农历  (默认 false )
 * @property {Boolean}            showMark         是否显示月份背景色 (默认 true )
 * @property {String}            confirmText         确定按钮的文字 (默认 '确定' )
 * @property {String}            confirmDisabledText   确认按钮处于禁用状态时的文字 (默认 '确定' )
 * @property {Boolean}            show            是否显示日历弹窗 (默认 false )
 * @property {Boolean}            closeOnClickOverlay   是否允许点击遮罩关闭日历 (默认 false )
 * @property {Boolean}            readonly           是否为只读状态,只读状态下禁止选择日期 (默认 false )
 * @property {String | Number}      maxRange           日期区间最多可选天数,默认无限制,mode = range时有效
 * @property {String}            rangePrompt           范围选择超过最多可选天数时的提示文案,mode = range时有效
 * @property {Boolean}            showRangePrompt       范围选择超过最多可选天数时,是否展示提示文案,mode = range时有效 (默认 true )
 * @property {Boolean}            allowSameDay       是否允许日期范围的起止时间为同一天,mode = range时有效 (默认 false )
 * @property {Number|String}       round            圆角值,默认无圆角  (默认 0 )
 * @property {Number|String}       monthNum         最多展示的月份数量  (默认 3 )
 *
 * @event {Function()} confirm       点击确定按钮时触发      选择日期相关的返回参数
 * @event {Function()} close       日历关闭时触发         可定义页面关闭时的回调事件
 * @example <u-calendar  :defaultDate="defaultDateMultiple" :show="show" mode="multiple" @confirm="confirm">
   </u-calendar>
 * */
export default {
   name: 'u-calendar',
   mixins: [uni.$u.mpMixin, uni.$u.mixin, props],
   components: {
      uHeader,
      uMonth
   },
   data() {
      return {
         // 需要显示的月份的数组
         months: [],
         // 在月份滚动区域中,当前视图中月份的index索引
         monthIndex: 0,
         // 月份滚动区域的高度
         listHeight: 0,
         // month组件中选择的日期数组
         selected: [],
         scrollIntoView: '',
         scrollTop:0,
         // 过滤处理方法
         innerFormatter: (value) => value
      }
   },
   watch: {
      selectedChange: {
         immediate: true,
         handler(n) {
            this.setMonth()
         }
      },
      // 打开弹窗时,设置月份数据
      show: {
         immediate: true,
         handler(n) {
            this.setMonth()
         }
      }
   },
   computed: {
      // 由于maxDate和minDate可以为字符串(2021-10-10),或者数值(时间戳),但是dayjs如果接受字符串形式的时间戳会有问题,这里进行处理
      innerMaxDate() {
         return uni.$u.test.number(this.maxDate)
            ? Number(this.maxDate)
            : this.maxDate
      },
      innerMinDate() {
         return uni.$u.test.number(this.minDate)
            ? Number(this.minDate)
            : this.minDate
      },
      // 多个条件的变化,会引起选中日期的变化,这里统一管理监听
      selectedChange() {
         return [this.innerMinDate, this.innerMaxDate, this.defaultDate]
      },
      subtitle() {
         // 初始化时,this.months为空数组,所以需要特别判断处理
         if (this.months.length) {
            return `${this.months[this.monthIndex].year}年${
               this.months[this.monthIndex].month
            }月`
         } else {
            return ''
         }
      },
      buttonDisabled() {
         // 如果为range类型,且选择的日期个数不足1个时,让底部的按钮出于disabled状态
         if (this.mode === 'range') {
            if (this.selected.length <= 1) {
               return true
            } else {
               return false
            }
         } else {
            return false
         }
      }
   },
   mounted() {
      this.start = Date.now()
      this.init()
   },
   methods: {
      // 在微信小程序中,不支持将函数当做props参数,故只能通过ref形式调用
      setFormatter(e) {
         this.innerFormatter = e
      },
      // month组件内部选择日期后,通过事件通知给父组件
      monthSelected(e) {
         this.selected = e
         if (!this.showConfirm) {
            // 在不需要确认按钮的情况下,如果为单选,或者范围多选且已选长度大于2,则直接进行返还
            if (
               this.mode === 'multiple' ||
               this.mode === 'single' ||
               (this.mode === 'range' && this.selected.length >= 2)
            ) {
               this.$emit('confirm', this.selected)
            }
         }
      },
      init() {
         // 校验maxDate,不能小于minDate
         if (
            this.innerMaxDate &&
            this.innerMinDate &&
            new Date(this.innerMaxDate).getTime() < new Date(this.innerMinDate).getTime()
         ) {
            return uni.$u.error('maxDate不能小于minDate')
         }
         // 滚动区域的高度
         this.listHeight = this.rowHeight * 5 + 30
         this.setMonth()
      },
      close() {
         this.$emit('close')
      },
      // 点击确定按钮
      confirm() {
         if (!this.buttonDisabled) {
            this.$emit('confirm', this.selected)
         }
      },
      // 获得两个日期之间的月份数
      getMonths(minDate, maxDate) {
         const minYear = dayjs(minDate).year()
         const minMonth = dayjs(minDate).month() + 1
         const maxYear = dayjs(maxDate).year()
         const maxMonth = dayjs(maxDate).month() + 1
         return (maxYear - minYear) * 12 + (maxMonth - minMonth) + 1
      },
      // 设置月份数据
      setMonth() {
         // 最小日期的毫秒数
         const minDate = this.innerMinDate || dayjs().valueOf()
         // 如果没有指定最大日期,则往后推3个月
         const maxDate =
            this.innerMaxDate ||
            dayjs(minDate)
               .add(this.monthNum - 1, 'month')
               .valueOf()
         // 最大最小月份之间的共有多少个月份,
         const months = uni.$u.range(
            1,
            this.monthNum,
            this.getMonths(minDate, maxDate)
         )
         // 先清空数组
         this.months = []
         for (let i = 0; i < months; i++) {
            this.months.push({
               date: new Array(
                  dayjs(minDate).add(i, 'month').daysInMonth()
               )
                  .fill(1)
                  .map((item, index) => {
                     // 日期,取值1-31
                     let day = index + 1
                     // 星期,0-6,0为周日
                     const week = dayjs(minDate)
                        .add(i, 'month')
                        .date(day)
                        .day()
                     const date = dayjs(minDate)
                        .add(i, 'month')
                        .date(day)
                        .format('YYYY-MM-DD')
                     let bottomInfo = ''
                     if (this.showLunar) {
                        // 将日期转为农历格式
                        const lunar = Calendar.solar2lunar(
                           dayjs(date).year(),
                           dayjs(date).month() + 1,
                           dayjs(date).date()
                        )
                        bottomInfo = lunar.IDayCn
                     }
                     let config = {
                        day,
                        week,
                        // 小于最小允许的日期,或者大于最大的日期,则设置为disabled状态
                        disabled:
                           dayjs(date).isBefore(
                              dayjs(minDate).format('YYYY-MM-DD')
                           ) ||
                           dayjs(date).isAfter(
                              dayjs(maxDate).format('YYYY-MM-DD')
                           ),
                        // 返回一个日期对象,供外部的formatter获取当前日期的年月日等信息,进行加工处理
                        date: new Date(date),
                        bottomInfo,
                        dot: false,
                        month:
                           dayjs(minDate).add(i, 'month').month() + 1
                     }
                     const formatter =
                        this.formatter || this.innerFormatter
                     return formatter(config)
                  }),
               // 当前所属的月份
               month: dayjs(minDate).add(i, 'month').month() + 1,
               // 当前年份
               year: dayjs(minDate).add(i, 'month').year()
            })
         }
      },
      // 滚动到默认设置的月份
      scrollIntoDefaultMonth(selected) {
         // 查询默认日期在可选列表的下标
         const _index = this.months.findIndex(({
              year,
              month
           }) => {
            month = uni.$u.padZero(month)
            return `${year}-${month}` === selected
         })
         if (_index !== -1) {
            // #ifndef MP-WEIXIN
            this.$nextTick(() => {
               this.scrollIntoView = `month-${_index}`
            })
            // #endif
            // #ifdef MP-WEIXIN
            this.scrollTop = this.months[_index].top || 0;
            // #endif
         }
      },
      // scroll-view滚动监听
      onScroll(event) {
         // 不允许小于0的滚动值,如果scroll-view到顶了,继续下拉,会出现负数值
         const scrollTop = Math.max(0, event.detail.scrollTop)
         // 将当前滚动条数值,除以滚动区域的高度,可以得出当前滚动到了哪一个月份的索引
         for (let i = 0; i < this.months.length; i++) {
            if (scrollTop >= (this.months[i].top || this.listHeight)) {
               this.monthIndex = i
            }
         }
      },
      // 更新月份的top值
      updateMonthTop(topArr = []) {
         // 设置对应月份的top值,用于onScroll方法更新月份
         topArr.map((item, index) => {
            this.months[index].top = item
         })
         // 获取默认日期的下标
         if (!this.defaultDate) {
            // 如果没有设置默认日期,则将当天日期设置为默认选中的日期
            const selected = dayjs().format("YYYY-MM")
            this.scrollIntoDefaultMonth(selected)
            return
         }
         let selected = dayjs().format("YYYY-MM");
         // 单选模式,可以是字符串或数组,Date对象等
         if (!uni.$u.test.array(this.defaultDate)) {
            selected = dayjs(this.defaultDate).format("YYYY-MM")
         } else {
            selected = dayjs(this.defaultDate[0]).format("YYYY-MM");
         }
         this.scrollIntoDefaultMonth(selected)
      }
   }
}
</script>
<style lang="scss" scoped>
@import '../../libs/css/components.scss';
.u-calendar {
   &__confirm {
      padding: 7px 18px;
   }
}
</style>