带有 Vue 3 和 Typescript 的 Flickity API

Question

我一直在我的 Vue 3 应用程序中使用 Flickity，当我使用带有静态单元格的硬编码 HTML 轮播时，它可以正常工作。但是，我需要在运行时以编程方式添加单元格，但我无法让 Flickity API 正常工作。

我正在尝试遵循 append() 示例，但我收到了错误：

flickity.js?1385:72 Bad element for Flickity: .carousel

在运行时在我的检查器中。我尝试遵循解决方案here 和here，但都未能成功运行。看起来这是由于 Flickity 库上的 TypeScript 错误造成的。我还安装了@types/flickity，仅供参考。

我可以做些什么来修复下面的append 逻辑？

<template>
        <div class="row">
          <div class="col d-block m-auto payment-option">
            <flickity ref="carousel" :options="flickityOptions">
            </flickity>
          </div>
      </div>
</template>

<script lang="ts">
import {defineComponent} from "vue";
//import Flickity from 'vue-flickity/src/flickity.vue';
import Flickity from 'flickity'
export default defineComponent({
  name: "PageName",
  components: {
    Flickity
  },
  data() {
    return {
      flickityOptions: {
        initialIndex: 3,
        prevNextButtons: false,
        pageDots: true,
        wrapAround: true
      }
    };
  },
  methods: {
    createBankAccountCarousel(flkty: Flickity) {
      flkty.append(this.makeFlickityCell())
    },
    makeFlickityCell() {
      const cell = document.createElement('div');
      cell.className = 'carousel-cell'
      cell.textContent = "Hi"
      return cell
    }
  },
  mounted() {
    let flkty = new Flickity(this.$refs.carousel)
    this.createBankAccountCarousel(flkty)
  }
});
</script>

Answer 1

看起来您可能在 Vue 3 中尝试了vue-flickity，但that component was built for Vue 2。

您可以在 Vue 3 中创建自己的 Flickity 组件：

1. 使用以下模板和脚本创建Flickity.vue，它在根元素上应用template ref，并包含slot 以接收.carousel-cell 元素：

   <template>
     <!-- ? template ref -->
     <div ref="root" class="flickity">
       <slot />
     </div>
   </template>
   
   <script lang="ts">
   import { defineComponent, ref } from 'vue'
   
   export default defineComponent({
     setup() {
       const root = ref<HTMLElement | null>(null) // reference to template ref named "root"
       return {
         root,
       }
     }
   })
   </script>
   

2. 声明一个optionsprop，稍后我们将把它传递给Flickity构造函数。

   <script lang="ts">
   import { defineComponent } from 'vue'
   
   export default defineComponent({
     props: {
       options: Object,
     }
   })
   </script>
   

3. 在组件的mounted hook中，使用"root"模板引用和options属性实例化Flickity；在unmounted 中，销毁Flickity 实例：

   <script lang="ts">
   import { defineComponent, onMounted, onUnmounted } from 'vue'
   import Flickity from 'flickity'
   
   export default defineComponent({
     setup(props) {
       let flickity: typeof Flickity | null = null
       onMounted(() => flickity = new Flickity(root.value as HTMLElement, props.options))
       onUnmounted(() => flickity?.destroy())
     }
   })
   </script>
   

4. 添加一个名为 "append" 的方法以允许将新元素附加到轮播：

   <script lang="ts">
   import { defineComponent } from 'vue'
   import Flickity from 'flickity'
   
   export default defineComponent({
     setup() {
       let flickity: typeof Flickity | null = null
       return {
         append(element: HTMLElement) {
           flickity?.append(element)
           flickity?.select(-1)
         }
       }
     }
   })
   </script>
   

5. 使用以下类型声明创建 src/flickity.d.ts（如果使用 VS Code，则必须重新启动 IDE 才能索引这些类型）：

   declare module 'flickity' {
     const Flickity: {
       new (el: string | HTMLElement, options?: Record<string, unknown>): this
       append(element: HTMLElement)
       destroy()
       select(id: string | number)
     }
     export = Flickity
   }
   

6. 添加以下<style> 块，该块引入flickity 默认样式，并设置将在槽中接收的.carousel-cell 元素的样式：

   <style scoped>
   @import '~flickity/dist/flickity.css';
   
   .flickity .carousel {
     background: #EEE;
     margin-bottom: 40px;
   }
   /* use ::v-deep to get at slot elements */
   .flickity::v-deep .carousel-cell {
     height: 200px;
     width: 25%;
     margin: 0 10px;
     background: #6C6;
     display: flex;
     align-items: center;
     justify-content: center;
     border-radius: 8px;
   }
   </style>
   

示例用法：

<template>
  <div class="app">
    <flickity ref="flickity" :options="flickityOptions">
      <div class="carousel-cell">1</div>
      <div class="carousel-cell">2</div>
      <div class="carousel-cell">3</div>
    </flickity>
    <div class="actions">
      <button @click="addElement">Append element</button>
    </div>
  </div>
</template>

<script lang="ts">
import { defineComponent } from 'vue'
import Flickity from './components/Flickity.vue'

export default defineComponent({
  name: 'App',
  components: {
    Flickity
  },
  data() {
    return {
      flickityOptions: {
        pageDots: true,
        wrapAround: true,
      }
    }
  },
  methods: {
    addElement() {
      // eslint-disable-next-line @typescript-eslint/no-explicit-any
      (this.$refs.flickity as any).append(this.makeFlickityCell())
    },
    makeFlickityCell() {
      const cell = document.createElement('div')
      cell.className = 'carousel-cell'
      cell.textContent = 'Hi'
      return cell
    }
  }
})
</script>

<style scoped>
.app {
  display: flex;
  flex-direction: column;
  justify-content: space-around;
  height: 50vh;
}
</style>

demo