You need to enable JavaScript to run this app. Vue3+TypeScript集成Flickity时出现this.$refs.flickity.on不是函数报错
优惠活动
大模型
产品
解决方案
定价
更多

Vue3+TypeScript集成Flickity时出现this.$refs.flickity.on不是函数报错

错误原因

  • 你自定义的Flickity.vue组件没有将原生Flickity实例的on方法暴露给父组件:父组件通过$refs.flickity拿到的是Vue组件实例,你当前只给组件实例暴露了root和append两个属性/方法,自然找不到on方法。
  • 类型定义缺失:你写的flickity.d.ts中IFlickity接口没有声明on方法,就算方法暴露了也会抛出TypeScript类型错误。
  • 事件绑定时机错误:你在父组件mounted的$nextTick回调中绑定ready事件,此时Flickity实例大概率已经初始化完成,ready事件已经触发过,就算方法可用也收不到回调。

修复方案

步骤1:修改Flickity.vue,暴露方法并抛出初始化事件

<script lang="ts">
import { defineComponent, onMounted, onUnmounted, ref } from 'vue'
import Flickity from 'flickity'

export default defineComponent({
  props: {
    options: Object,
  },
  // 声明组件抛出的事件
  emits: ['init'],
  setup(props, { emit }) {
    let flickity: typeof Flickity | null = null
    const root = ref<HTMLElement | null>(null)

    onMounted(() => {
      flickity = new Flickity(root.value as HTMLElement, props.options)
      // 初始化完成后将实例抛给父组件
      emit('init', flickity)
    })
    onUnmounted(() => flickity?.destroy())

    return {
      root,
      append(element: HTMLElement) {
        flickity?.append(element);
        flickity?.select(-1)
      },
      // 额外暴露on方法,兼容直接通过ref调用的场景
      on(eventName: string, callback: (...args: any[]) => void) {
        flickity?.on(eventName, callback)
      }
    }
  },
})
</script>

步骤2:补全flickity.d.ts类型声明

interface IFlickity {
    new (el: string | HTMLElement, options?: Record<string, unknown>): this;
    append(element: HTMLElement);
    destroy();
    select(id: string | number);
    // 新增on方法类型
    on(eventName: string, callback: (...args: any[]) => void): void;
}

declare module 'flickity' {
    const Flickity: IFlickity;
    export = Flickity;
}

步骤3:修改父组件事件绑定逻辑

直接用组件抛出的init事件拿到Flickity实例绑定事件即可,不需要等待$nextTick:

export default defineComponent({
  // 其他代码保持不变
  methods: {
    onInit(flickityInstance: typeof Flickity) {
      flickityInstance.on('ready', () => {
        console.log('Flickity is ready!')
      })
    },
    // 原有其他方法不变
  }
})

内容的提问来源于stack exchange,提问作者Cody

相关产品推荐
方舟 Agent Plan

超全模态模型 × Harness 升级,最新支持 Deepseek-V4.1-Flash、GLM-5.3 系列、Doubao-Seedream-5.0-pro、Kimi-K3 (部分), 限时 9.9 元起

最近更新时间:2026.10.14 02:06:01