Cannot access Ionic component method from ref (Vue3)

Question

I'm trying to access the closeSlidingItems method of the IonList component so that the sliding item is closed automatically once I click on a button which appears from behind after sliding this item to the right.

I tried to do it by putting a reference to IonList, then accessing it from the callback method for the click event on this button. However, I get an error:

Cannot read property 'closeSlidingItems' of undefined

This is the code in the root component:

<template>
  <ion-app>
    <ion-list ref="myIonList">
      <ion-item-sliding v-for="user in users" :key="user">
        <ion-item-options side="start">
          <ion-item-option v-on:click="favorite(user)" color="primary">
            <ion-icon slot="icon-only" :icon="heartOutline"></ion-icon>
          </ion-item-option>
        </ion-item-options>

        <ion-item :color="userState(user)">
          <ion-label slot="start">{{ user.name }}</ion-label>
          <ion-label slot="end">{{ user.age }}</ion-label>
        </ion-item>
      </ion-item-sliding>
    </ion-list>
  </ion-app>
</template>

<script>
import {
  IonApp,
  IonContent,
  IonList,
  IonLabel,
  IonItem,
  IonItemSliding,
  IonItemOptions,
  IonItemOption,
  IonIcon,
} from "@ionic/vue";
import { defineComponent } from "vue";
import { heartOutline } from "ionicons/icons";

export default defineComponent({
  name: "App",
  components: {
    IonApp,
    IonList,
    IonLabel,
    IonItem,
    IonItemSliding,
    IonItemOptions,
    IonItemOption,
    IonIcon,
  },
  data() {
    return {
      heartOutline,
      users: [
        {
          name: "John",
          age: 35,
          favorite: false,
        },
        {
          name: "Jane",
          age: 30,
          favorite: false,
        },
      ],
    };
  },
  methods: {
    favorite(user) {
      const favorite = user.favorite || false;
      user.favorite = !favorite;
      //console.log(this.$refs.myIonList);
      // This won't work despite I defined a reference to IonList and closeSlidingItems is a method of this component!
      this.$refs.myIonList.closeSlidingItems();
    },
    userState(user) {
      return user.favorite ? "success" : "";
    },
  },
});
</script>

And to try it by yourselves (try sliding one list item to the right and clicking on the heart icon):

https://codesandbox.io/s/ionic-vue-refs-2-msjj6?file=/src/App.vue

Could anyone help me find the issue and how to fix it, or work around it?

Mateusz Rybczonek · Accepted Answer · 2020-12-18 09:00:24Z

7

+50

Okay, I think I got it. Try adding $el after the ref

this.$refs.myIonList.$el.closeSlidingItems()

answered Dec 18, 2020 at 9:00

Mateusz Rybczonek

2162 silver badges3 bronze badges

Sign up to request clarification or add additional context in comments.

2 Comments

Luis Martin Over a year ago

Wonderful! It works! Thank you! I didn't see that in the docs. It's stated to use this.$refs.<component>.method() Where did you find out?

Keshav Agrawal Over a year ago

This solved the problem. Where and how did you find it out? These things are not clear enough from the docs.

Mateusz Rybczonek · Accepted Answer · 2020-12-18 08:34:32Z

2

Same for ion-item-sliding close method. See below simplified example. It looks like the component methods are not visible when you try to get the component instance using Vue3. Ref returns a Proxy object in that case.

https://codesandbox.io/s/ionic-vue-refs-2-forked-zx3lg?file=/src/App.vue

answered Dec 18, 2020 at 8:34

Mateusz Rybczonek

2162 silver badges3 bronze badges

Collectives™ on Stack Overflow

Cannot access Ionic component method from ref (Vue3)

2 Answers 2

2 Comments

Comments

Your Answer

Hot Network Questions

Collectives™ on Stack Overflow

2 Answers 2

2 Comments

Comments

Your Answer

Sign up or log in

Post as a guest

Related