title: Taro.hideHomeButton(option)

sidebar_label: hideHomeButton

Hide the button to return to the home page. Since WeChat 7.0.7, when the user opens the root page of an mini program that is not the home page, the “Back to Home” button will be displayed by default, developers can call hideHomeButton in the page onShow to hide it.

Reference

Type

  1. (option?: Option) => Promise<CallbackResult>

Parameters

Option

Property Type Required Description
complete (res: CallbackResult) => void No The callback function used when the API call completed (always executed whether the call succeeds or fails)
fail (res: CallbackResult) => void No The callback function for a failed API call
success (res: CallbackResult) => void No The callback function for a successful API call

API Support

API WeChat Mini-Program H5 React Native
Taro.hideHomeButton ✔️