vxe-pc-ui/types/components/carousel.d.ts

A vue based PC component library

import { RenderFunction, SetupContext, Ref } from 'vue'
import { DefineVxeComponentApp, DefineVxeComponentOptions, DefineVxeComponentInstance, VxeComponentBaseOptions, VxeComponentEventParams, ValueOf } from '@vxe-ui/core'
import { VxeCarouselItemPropTypes, VxeCarouselItemProps, VxeCarouselItemSlots } from './carousel-item'

/* eslint-disable no-use-before-define,@typescript-eslint/ban-types */

export declare const VxeCarousel: DefineVxeComponentApp<VxeCarouselProps, VxeCarouselEventProps, VxeCarouselSlots>
export type VxeCarouselComponent = DefineVxeComponentOptions<VxeCarouselProps, VxeCarouselEventProps>

export type VxeCarouselInstance = DefineVxeComponentInstance<VxeCarouselProps, VxeCarouselConstructor>

export interface VxeCarouselConstructor extends VxeComponentBaseOptions, VxeCarouselMethods {
  props: VxeCarouselProps
  context: SetupContext<VxeCarouselEmits>
  reactData: CarouselReactData
  getRefMaps(): CarouselPrivateRef
  getComputeMaps(): CarouselPrivateComputed
  renderVN: RenderFunction
}

export interface CarouselPrivateRef {
  refElem: Ref<HTMLDivElement | undefined>
}
export interface VxeCarouselPrivateRef extends CarouselPrivateRef { }

export namespace VxeCarouselPropTypes {
  export type ModelValue = VxeCarouselItemPropTypes.Name
  export interface Option extends VxeCarouselItemProps {
    slots?: VxeCarouselItemSlots
  }
  export type Options = Option[]
  export type Loading = boolean
  export type Height = number | string
  export type Width = number | string
  export type AutoPlay = boolean
  export type Interval = number | string
  export type Loop = boolean
  export type Vertical = boolean
  export type ShowIndicators = boolean
}

export type VxeCarouselProps = {
  modelValue?: VxeCarouselPropTypes.ModelValue
  options?: VxeCarouselPropTypes.Options
  loading?: VxeCarouselPropTypes.Loading
  height?: VxeCarouselPropTypes.Height
  width?: VxeCarouselPropTypes.Width
  autoPlay?: VxeCarouselPropTypes.AutoPlay
  loop?: VxeCarouselPropTypes.Loop
  interval?: VxeCarouselPropTypes.Interval
  vertical?: VxeCarouselPropTypes.Vertical
  showIndicators?: VxeCarouselPropTypes.ShowIndicators
}

export interface CarouselPrivateComputed {
}
export interface VxeCarouselPrivateComputed extends CarouselPrivateComputed { }

export interface CarouselReactData {
  activeName: VxeCarouselPropTypes.ModelValue | undefined
  staticItems: VxeCarouselDefines.ItemConfig[]
  itemWidth: number
  itemHeight: number
}

export interface CarouselInternalData {
  apTimeout: undefined | number
  stopFlag: boolean
}

export interface CarouselMethods {
  dispatchEvent(type: ValueOf<VxeCarouselEmits>, params: Record<string, any>, evnt: Event | null): void
  /**
   * 切换到上一个
   */
  prev(): Promise<any>
  /**
   * 切换到下一个
   */
  next(): Promise<any>
}
export interface VxeCarouselMethods extends CarouselMethods { }

export interface CarouselPrivateMethods { }
export interface VxeCarouselPrivateMethods extends CarouselPrivateMethods { }

export type VxeCarouselEmits = [
  'update:modelValue',
  'change'
]

export namespace VxeCarouselDefines {
  export interface CarouselEventParams extends VxeComponentEventParams {
    $carousel: VxeCarouselConstructor
  }

  export interface ItemConfig {
    id: string
    name: VxeCarouselItemPropTypes.Name | undefined
    url: VxeCarouselItemPropTypes.Url | undefined
    className: VxeCarouselItemPropTypes.ClassName | undefined
    slots: VxeCarouselItemSlots
  }

  export interface ChangeEventParams extends CarouselEventParams {
    value: VxeCarouselPropTypes.ModelValue
  }
}

export type VxeCarouselEventProps = {
  onChange?: VxeCarouselEvents.Change
}

export interface VxeCarouselListeners {
  change?: VxeCarouselEvents.Change
}

export namespace VxeCarouselEvents {
  export type Change = (params: VxeCarouselDefines.ChangeEventParams) => void
}

export namespace VxeCarouselSlotTypes {
  export interface DefaultSlotParams {}
}

export interface VxeCarouselSlots {
  default?: (params: VxeCarouselSlotTypes.DefaultSlotParams) => any
}

export const Carousel: typeof VxeCarousel
export default VxeCarousel