Skip to main content
Use this API to listen for events when the Mini Program transitions from background to foreground. The callback triggers at the same time as the onShow() lifecycle method in the app registration.

​
Parameters

PropertyTypeRequiredDescription
callbackFunctionYesHandler executed when the app moves to foreground

​
Callback Parameters

The callback receives the same parameters as the onShow() lifecycle method:
PropertyTypeDescription
pathStringPath of the page that was opened
queryObjectQuery parameters from the launch URL
referrerInfoObjectInformation about the source app

​
Code Example

Page({
  onLoad() {
    // Register listener when page loads
    my.onAppShow(this.onAppShowHandler);
  },

  onUnload() {
    // Clean up listener when page unloads
    my.offAppShow(this.onAppShowHandler);
  },

  onAppShowHandler(res) {
    console.log('App moved to foreground');
    console.log('Path:', res.path);
    console.log('Query:', res.query);

    // Refresh data when app becomes visible
    this.refreshData();
  },

  refreshData() {
    // Fetch latest data
  }
});

​
Use Cases

Page({
  onLoad() {
    my.onAppShow(() => {
      // Refresh data when user returns to app
      this.fetchLatestData();
    });
  },

  fetchLatestData() {
    my.request({
      url: 'https://api.example.com/data',
      success: (res) => {
        this.setData({ items: res.data });
      }
    });
  }
});

Page({
  data: {
    timer: null
  },

  onLoad() {
    my.onAppShow(this.resumeTimer.bind(this));
    my.onAppHide(this.pauseTimer.bind(this));
    this.startTimer();
  },

  startTimer() {
    this.data.timer = setInterval(() => {
      // Timer logic
    }, 1000);
  },

  pauseTimer() {
    clearInterval(this.data.timer);
  },

  resumeTimer() {
    this.startTimer();
  }
});

App({
  onLaunch() {
    my.onAppShow((res) => {
      // Track app resume events
      this.trackEvent('app_resume', {
        path: res.path,
        timestamp: Date.now()
      });
    });
  }
});
Always remove event listeners when they’re no longer needed using my.offAppShow() to prevent memory leaks.

my.offAppShow

Stop listening for foreground events

my.onAppHide

Listen for background events