hy-app 0.2.12 → 0.2.14

package/components/hy-button/props.ts

@@ -1,34 +1,159 @@
 import type { HyButtonProps } from './typing'
+import { HyApp } from 'hy-app/typing/modules/common'
+import type { CSSProperties, PropType } from 'vue'
+import HyIconProps from '@/package/components/hy-icon/typing'
 
-const defaultProps: HyButtonProps = {
-  hairline: false,
-  type: 'primary',
-  size: 'medium',
-  shape: 'square',
-  plain: false,
-  disabled: false,
-  loading: false,
-  loadingText: '',
-  loadingMode: 'spinner',
-  loadingSize: 13,
-  openType: '',
-  formType: '',
-  appParameter: '',
-  hoverStopPropagation: true,
-  lang: 'en',
-  sessionFrom: '',
-  sendMessageTitle: '',
-  sendMessagePath: '',
-  sendMessageImg: '',
-  showMessageCard: false,
-  dataName: '',
-  throttleTime: 0,
-  hoverStartTime: 0,
-  hoverStayTime: 200,
-  text: '',
-  icon: {},
-  color: '',
-  stop: true,
-}
-
-export default defaultProps
+export const defaultProps = {
+  /** 是否显示按钮的细边框 */
+  hairline: {
+    type: Boolean,
+    default: false,
+  },
+  /** 按钮的预置样式 */
+  type: {
+    type: String as PropType<HyApp.ThemeType>,
+    default: 'primary',
+    validator: (v) => ['info', 'primary', 'error', 'warning', 'success'].includes(v),
+  },
+  /** 按钮尺寸 */
+  size: {
+    type: String as PropType<HyApp.SizeType | 'mini'>,
+    default: 'medium',
+    validator: (v) => ['large', 'medium', 'small', 'mini'].includes(v),
+  },
+  /** 按钮形状 */
+  shape: {
+    type: String as PropType<HyApp.ShapeType>,
+    default: 'square',
+    validator: (v) => ['circle', 'square'].includes(v),
+  },
+  /** 按钮是否镂空，背景色透明  */
+  plain: {
+    type: Boolean,
+    default: false,
+  },
+  /** 是否禁用 */
+  disabled: {
+    type: Boolean,
+    default: false,
+  },
+  /** 按钮名称前是否带 loading 图标 */
+  loading: {
+    type: Boolean,
+    default: false,
+  },
+  /** 加载中提示文字 */
+  loadingText: {
+    type: String,
+    default: '',
+  },
+  /** 加载状态图标类型 */
+  loadingMode: {
+    type: String as PropType<HyApp.LoadingMode>,
+    default: 'spinner',
+    validator: (v) => ['spinner', 'circle', 'semicircle'].includes(v),
+  },
+  /** 加载图标大小 */
+  loadingSize: {
+    type: Number,
+    default: 13,
+  },
+  /** 开放能力，具体请看uniapp稳定关于button组件部分说明 */
+  openType: {
+    type: String,
+    default: '',
+  },
+  /** 用于 <form> 组件，点击分别会触发 <form> 组件的 submit/reset 事件 */
+  formType: {
+    type: String,
+    default: '',
+  },
+  /** 打开 APP 时，向 APP 传递的参数，open-type=launchApp时有效 （注：只微信小程序、QQ小程序有效） */
+  appParameter: {
+    type: String,
+    default: '',
+  },
+  /** 指定是否阻止本节点的祖先节点出现点击态，微信小程序有效 */
+  hoverStopPropagation: {
+    type: Boolean,
+    default: true,
+  },
+  /** 指定返回用户信息的语言，zh_CN 简体中文，zh_TW 繁体中文，en 英文（默认 en ） */
+  lang: {
+    type: String,
+    default: 'en',
+  },
+  /** 会话来源，openType="contact"时有效 */
+  sessionFrom: {
+    type: String,
+    default: '',
+  },
+  /** 会话内消息卡片标题，openType="contact"时有效 */
+  sendMessageTitle: {
+    type: String,
+    default: '',
+  },
+  /** 会话内消息卡片点击跳转小程序路径，openType="contact"时有效 */
+  sendMessagePath: {
+    type: String,
+    default: '',
+  },
+  /** 会话内消息卡片图片，openType="contact"时有效 */
+  sendMessageImg: {
+    type: String,
+    default: '',
+  },
+  /** 是否显示会话内消息卡片，设置此参数为 true，用户进入客服会话会在右下角显示"可能要发送的小程序"提示，用户点击后可以快速发送小程序消息，openType="contact"时有效 */
+  showMessageCard: {
+    type: Boolean,
+    default: false,
+  },
+  /** 额外传参参数，用于小程序的data-xxx属性，通过target.dataset.name获取 */
+  dataName: {
+    type: String,
+    default: '',
+  },
+  /** 节流时间，一定时间内只能触发一次 */
+  throttleTime: {
+    type: Number,
+    default: 0,
+  },
+  /** 按住后多久出现点击态，单位毫秒 */
+  hoverStartTime: {
+    type: Number,
+    default: 0,
+  },
+  /** 手指松开后点击态保留时间，单位毫秒 */
+  hoverStayTime: {
+    type: Number,
+    default: 200,
+  },
+  /** 按钮文字，之所以通过props传入，是因为slot传入的话（注：nvue中无法控制文字的样式） */
+  text: {
+    type: String,
+    default: '',
+  },
+  /** 按钮图标api集合 */
+  icon: {
+    type: Object as PropType<HyIconProps>,
+    default: () => ({}),
+  },
+  /** 按钮颜色，支持传入linear-gradient渐变色 */
+  color: {
+    type: String,
+    default: '',
+  },
+  /** 阻止事件冒泡 */
+  stop: {
+    type: Boolean,
+    default: true,
+  },
+  /** 阻止事件冒泡 */
+  customStyle: {
+    type: Object as PropType<CSSProperties>,
+  },
+  /** 阻止事件冒泡 */
+  customClass: {
+    type: String,
+  },
+} as const

package/components/hy-button/typing.d.ts

@@ -1,25 +1,27 @@
 import type { CSSProperties } from 'vue'
 import type HyIconProps from '../hy-icon/typing'
+import HyApp from 'hy-app'
 
 export interface HyButtonProps {
   /**
-   * 是否显示按钮的细边框 (默认 true )
+   * 是否显示按钮的细边框
+   * @default true
+   * @type {boolean}
    * */
   hairline?: boolean
   /**
    * 按钮的预置样式
-   * @type ThemeType
+   * @type {ThemeType}
    * @default 'primary'
-   * @enum {string}      // 声明为枚举类型
    * @values info, primary, error, warning, success
    * */
-  type?: 'info' | 'primary' | 'error' | 'warning' | 'success'
+  type?: HyApp.ThemeType
   /**
    * 按钮尺寸
    * @type {'large' | 'medium' | 'small' | 'mini'}
    * @default 'medium'
    * */
-  size?: HyApp.SizeType | 'mini'
+  size?: 'large' | 'medium' | 'small' | 'mini'
   /**
    * 按钮形状，circle（两边为半圆），square（带圆角） （默认 'square' ）
    * */
@@ -137,23 +139,27 @@ export interface IButtonEmits {
    * */
   (e: 'click', event: Event): void
   /**
-   * 点击按钮事件
+   * 仅限微信小程序，当使用开放能力时，发生错误的回调
+   * */
+  (e: 'error', event: Event): void
+  /**
+   * 微信小程序获取手机号
    * */
   (e: 'getphonenumber', event: Event): void
   /**
-   * 点击按钮事件
+   * 微信小程序用户点击该按钮时，会返回获取到的用户信息，从返回参数的detail中获取到的值同uni.getUserInfo
    * */
   (e: 'getuserinfo', event: Event): void
   /**
-   * 点击按钮事件
+   * 仅限微信小程序，在打开授权设置页并关闭后回调
    * */
   (e: 'opensetting', event: Event): void
   /**
-   * 点击按钮事件
+   * 仅限微信小程序，打开 APP 成功的回调
    * */
   (e: 'launchapp', event: Event): void
   /**
-   * 点击按钮事件
+   * 仅限微信小程序，用户同意隐私协议事件回调，open-type="agreePrivacyAuthorization"时有效
    * */
   (e: 'agreeprivacyauthorization', event: Event): void
 }

package/components/index.ts

@@ -1,133 +1,125 @@
-import HyTabBr from "./hy-tabBar/hy-tabBar.vue";
-import Dialog from "./dialog";
-/* #ifdef H5 */
-import DialogService from "./message";
-/* #endif */
-
+import HyTabBr from './hy-tabBar/hy-tabBar.vue'
+import Dialog from './dialog'
 // 组件库
-import HyAddressPicker from "./hy-address-picker/hy-address-picker.vue";
-import HyAvatar from "./hy-avatar/hy-avatar.vue";
-import HyBackTop from "./hy-back-top/hy-back-top.vue";
-import HyBadge from "./hy-badge/hy-badge.vue";
-import HyButton from "./hy-button/hy-button.vue";
-import HyCard from "./hy-card/hy-card.vue";
-import HyCell from "./hy-cell/hy-cell.vue";
-import HyCheckButton from "./hy-check-button/hy-check-button.vue";
-import HyCheckbox from "./hy-checkbox/hy-checkbox.vue";
-import HyCountDown from "./hy-count-down/hy-count-down.vue";
-import HyCountTo from "./hy-count-to/hy-count-to.vue";
-import HyDatetimePicker from "./hy-datetime-picker/hy-datetime-picker.vue";
-import HyDivider from "./hy-divider/hy-divider.vue";
-import HyDropdown from "./hy-dropdown/hy-dropdown.vue";
-import HyDropdownItem from "./hy-dropdown-item/hy-dropdown-item.vue";
-import YkEmpty from "./hy-empty/hy-empty.vue";
-import YkFloatButton from "./hy-float-button/hy-float-button.vue";
-import HyFoldingPanel from "./hy-folding-panel/hy-folding-panel.vue";
-import HyForm from "./hy-form/hy-form.vue";
-import HyGrid from "./hy-grid/hy-grid.vue";
-import HyIcon from "./hy-icon/hy-icon.vue";
-import HyImage from "./hy-image/hy-image.vue";
-import HyInput from "./hy-input/hy-input.vue";
-import HyLine from "./hy-line/hy-line.vue";
-import HyLineProgress from "./hy-line-progress/hy-line-progress.vue";
-import HyList from "./hy-list/hy-list.vue";
-import HyLoading from "./hy-loading/hy-loading.vue";
-import YkLogin from "./hy-login/hy-login.vue";
-import HyModal from "./hy-modal/hy-modal.vue";
-import HyNavbar from "./hy-navbar/hy-navbar.vue";
-import HyNoticeBar from "./hy-notice-bar/hy-notice-bar.vue";
-import HyNumberStep from "./hy-number-step/hy-number-step.vue";
-import HyOverlay from "./hy-overlay/hy-overlay.vue";
-import YkPrice from "./hy-price/hy-price.vue";
-import HyPicker from "./hy-picker/hy-picker.vue";
-import HyPopup from "./hy-popup/hy-popup.vue";
-import HyQrcode from "./hy-qrcode/hy-qrcode.vue";
-import HyRadio from "./hy-radio/hy-radio.vue";
-import HyRate from "./hy-rate/hy-rate.vue";
-import HyReadMore from "./hy-read-more/hy-read-more.vue";
+import HyAddressPicker from './hy-address-picker/hy-address-picker.vue'
+import HyAvatar from './hy-avatar/hy-avatar.vue'
+import HyBackTop from './hy-back-top/hy-back-top.vue'
+import HyBadge from './hy-badge/hy-badge.vue'
+import HyButton from './hy-button/hy-button.vue'
+import HyCard from './hy-card/hy-card.vue'
+import HyCell from './hy-cell/hy-cell.vue'
+import HyCheckButton from './hy-check-button/hy-check-button.vue'
+import HyCheckbox from './hy-checkbox/hy-checkbox.vue'
+import HyCountDown from './hy-count-down/hy-count-down.vue'
+import HyCountTo from './hy-count-to/hy-count-to.vue'
+import HyDatetimePicker from './hy-datetime-picker/hy-datetime-picker.vue'
+import HyDivider from './hy-divider/hy-divider.vue'
+import HyDropdown from './hy-dropdown/hy-dropdown.vue'
+import HyDropdownItem from './hy-dropdown-item/hy-dropdown-item.vue'
+import YkEmpty from './hy-empty/hy-empty.vue'
+import YkFloatButton from './hy-float-button/hy-float-button.vue'
+import HyFoldingPanel from './hy-folding-panel/hy-folding-panel.vue'
+import HyForm from './hy-form/hy-form.vue'
+import HyGrid from './hy-grid/hy-grid.vue'
+import HyIcon from './hy-icon/hy-icon.vue'
+import HyImage from './hy-image/hy-image.vue'
+import HyInput from './hy-input/hy-input.vue'
+import HyLine from './hy-line/hy-line.vue'
+import HyLineProgress from './hy-line-progress/hy-line-progress.vue'
+import HyList from './hy-list/hy-list.vue'
+import HyLoading from './hy-loading/hy-loading.vue'
+import YkLogin from './hy-login/hy-login.vue'
+import HyModal from './hy-modal/hy-modal.vue'
+import HyNavbar from './hy-navbar/hy-navbar.vue'
+import HyNoticeBar from './hy-notice-bar/hy-notice-bar.vue'
+import HyNumberStep from './hy-number-step/hy-number-step.vue'
+import HyOverlay from './hy-overlay/hy-overlay.vue'
+import YkPrice from './hy-price/hy-price.vue'
+import HyPicker from './hy-picker/hy-picker.vue'
+import HyPopup from './hy-popup/hy-popup.vue'
+import HyQrcode from './hy-qrcode/hy-qrcode.vue'
+import HyRadio from './hy-radio/hy-radio.vue'
+import HyRate from './hy-rate/hy-rate.vue'
+import HyReadMore from './hy-read-more/hy-read-more.vue'
 // import HySafeBottom from "./hy-safe-bottom/hy-safe-bottom.vue";
-import HyScrollList from "./hy-scroll-list/hy-scroll-list.vue";
-import HySearch from "./hy-search/hy-search.vue";
-import HySlider from "./hy-slider/hy-slider.vue";
-import HyStatusBar from "./hy-status-bar/hy-status-bar.vue";
-import HySteps from "./hy-steps/hy-steps.vue";
-import HySubsection from "./hy-subsection/hy-subsection.vue";
-import HySwiper from "./hy-swiper/hy-swiper.vue";
-import HySwitch from "./hy-switch/hy-switch.vue";
-import HyTabs from "./hy-tabs/hy-tabs.vue";
-import HyTag from "./hy-tag/hy-tag.vue";
-import HyTextarea from "./hy-textarea/hy-textarea.vue";
-import HyTooltip from "./hy-tooltip/hy-tooltip.vue";
-import HyTransition from "./hy-transition/hy-transition.vue";
-import HyUpload from "./hy-upload/hy-upload.vue";
-import HyWarn from "./hy-warn/hy-warn.vue";
+import HyScrollList from './hy-scroll-list/hy-scroll-list.vue'
+import HySearch from './hy-search/hy-search.vue'
+import HySlider from './hy-slider/hy-slider.vue'
+import HyStatusBar from './hy-status-bar/hy-status-bar.vue'
+import HySteps from './hy-steps/hy-steps.vue'
+import HySubsection from './hy-subsection/hy-subsection.vue'
+import HySwiper from './hy-swiper/hy-swiper.vue'
+import HySwitch from './hy-switch/hy-switch.vue'
+import HyTabs from './hy-tabs/hy-tabs.vue'
+import HyTag from './hy-tag/hy-tag.vue'
+import HyTextarea from './hy-textarea/hy-textarea.vue'
+import HyTooltip from './hy-tooltip/hy-tooltip.vue'
+import HyTransition from './hy-transition/hy-transition.vue'
+import HyUpload from './hy-upload/hy-upload.vue'
+import HyWarn from './hy-warn/hy-warn.vue'
 
 const install = (Vue: any) => {
-  Vue.component("hy-tabBar", HyTabBr);
+  Vue.component('hy-tabBar', HyTabBr)
 
-  Vue.component("HyAddressPicker", HyAddressPicker);
-  Vue.component("HyAvatar", HyAvatar);
-  Vue.component("HyBackTop", HyBackTop);
-  Vue.component("HyBadge", HyBadge);
-  Vue.component("HyButton", HyButton);
-  Vue.component("HyCard", HyCard);
-  Vue.component("HyCell", HyCell);
-  Vue.component("HyCheckButton", HyCheckButton);
-  Vue.component("HyCheckbox", HyCheckbox);
-  Vue.component("HyCountDown", HyCountDown);
-  Vue.component("HyCountTo", HyCountTo);
-  Vue.component("HyDatetimePicker", HyDatetimePicker);
-  Vue.component("HyDivider", HyDivider);
-  Vue.component("HyDropdown", HyDropdown);
-  Vue.component("HyDropdownItem", HyDropdownItem);
-  Vue.component("YkEmpty", YkEmpty);
-  Vue.component("YkFloatButton", YkFloatButton);
-  Vue.component("HyFoldingPanel", HyFoldingPanel);
-  Vue.component("HyForm", HyForm);
-  Vue.component("HyGrid", HyGrid);
-  Vue.component("HyIcon", HyIcon);
-  Vue.component("HyImage", HyImage);
-  Vue.component("HyInput", HyInput);
-  Vue.component("HyLine", HyLine);
-  Vue.component("HyLineProgress", HyLineProgress);
-  Vue.component("HyList", HyList);
-  Vue.component("HyLoading", HyLoading);
+  Vue.component('HyAddressPicker', HyAddressPicker)
+  Vue.component('HyAvatar', HyAvatar)
+  Vue.component('HyBackTop', HyBackTop)
+  Vue.component('HyBadge', HyBadge)
+  Vue.component('HyButton', HyButton)
+  Vue.component('HyCard', HyCard)
+  Vue.component('HyCell', HyCell)
+  Vue.component('HyCheckButton', HyCheckButton)
+  Vue.component('HyCheckbox', HyCheckbox)
+  Vue.component('HyCountDown', HyCountDown)
+  Vue.component('HyCountTo', HyCountTo)
+  Vue.component('HyDatetimePicker', HyDatetimePicker)
+  Vue.component('HyDivider', HyDivider)
+  Vue.component('HyDropdown', HyDropdown)
+  Vue.component('HyDropdownItem', HyDropdownItem)
+  Vue.component('YkEmpty', YkEmpty)
+  Vue.component('YkFloatButton', YkFloatButton)
+  Vue.component('HyFoldingPanel', HyFoldingPanel)
+  Vue.component('HyForm', HyForm)
+  Vue.component('HyGrid', HyGrid)
+  Vue.component('HyIcon', HyIcon)
+  Vue.component('HyImage', HyImage)
+  Vue.component('HyInput', HyInput)
+  Vue.component('HyLine', HyLine)
+  Vue.component('HyLineProgress', HyLineProgress)
+  Vue.component('HyList', HyList)
+  Vue.component('HyLoading', HyLoading)
   // Vue.component("YkLogin", YkLogin);
-  Vue.component("HyModal", HyModal);
-  Vue.component("HyNavbar", HyNavbar);
-  Vue.component("HyNoticeBar", HyNoticeBar);
-  Vue.component("HyNumberStep", HyNumberStep);
-  Vue.component("HyOverlay", HyOverlay);
-  Vue.component("YkPrice", YkPrice);
-  Vue.component("HyPicker", HyPicker);
-  Vue.component("HyPopup", HyPopup);
-  Vue.component("HyQrcode", HyQrcode);
-  Vue.component("HyRadio", HyRadio);
-  Vue.component("HyRate", HyRate);
-  Vue.component("HyReadMore", HyReadMore);
-  Vue.component("HyScrollList", HyScrollList);
-  Vue.component("HySearch", HySearch);
-  Vue.component("HySlider", HySlider);
-  Vue.component("HyStatusBar", HyStatusBar);
-  Vue.component("HySteps", HySteps);
-  Vue.component("HySubsection", HySubsection);
-  Vue.component("HySwiper", HySwiper);
-  Vue.component("HySwitch", HySwitch);
-  Vue.component("HyTabs", HyTabs);
-  Vue.component("HyTag", HyTag);
-  Vue.component("HyTextarea", HyTextarea);
-  Vue.component("HyTooltip", HyTooltip);
-  Vue.component("HyTransition", HyTransition);
-  Vue.component("HyUpload", HyUpload);
-  Vue.component("HyWarn", HyWarn);
+  Vue.component('HyModal', HyModal)
+  Vue.component('HyNavbar', HyNavbar)
+  Vue.component('HyNoticeBar', HyNoticeBar)
+  Vue.component('HyNumberStep', HyNumberStep)
+  Vue.component('HyOverlay', HyOverlay)
+  Vue.component('YkPrice', YkPrice)
+  Vue.component('HyPicker', HyPicker)
+  Vue.component('HyPopup', HyPopup)
+  Vue.component('HyQrcode', HyQrcode)
+  Vue.component('HyRadio', HyRadio)
+  Vue.component('HyRate', HyRate)
+  Vue.component('HyReadMore', HyReadMore)
+  Vue.component('HyScrollList', HyScrollList)
+  Vue.component('HySearch', HySearch)
+  Vue.component('HySlider', HySlider)
+  Vue.component('HyStatusBar', HyStatusBar)
+  Vue.component('HySteps', HySteps)
+  Vue.component('HySubsection', HySubsection)
+  Vue.component('HySwiper', HySwiper)
+  Vue.component('HySwitch', HySwitch)
+  Vue.component('HyTabs', HyTabs)
+  Vue.component('HyTag', HyTag)
+  Vue.component('HyTextarea', HyTextarea)
+  Vue.component('HyTooltip', HyTooltip)
+  Vue.component('HyTransition', HyTransition)
+  Vue.component('HyUpload', HyUpload)
+  Vue.component('HyWarn', HyWarn)
   // Vue.config.globalProperties.$dialog = myDialog;
-};
+}
 export {
   install,
-  // Dialog,
-  /* #ifdef H5 */
-  DialogService,
-  /* #endif */
   HyAddressPicker,
   HyAvatar,
   HyBackTop,
@@ -183,4 +175,4 @@ export {
   HyTransition,
   HyUpload,
   HyWarn,
-};
+}