Telegram 小程序 | TypeScript @telegram-apps/sdk @2.x | 组件 | 返回按钮

riyad

返回按钮​

💠组件 负责 Telegram Mini Apps 返回按钮 。

检查支持​

要检查当前 Telegram 小应用程序版本是否支持返回按钮，请使用 isSupported 方法：

Variable :

1. import { backButton } from '@telegram-apps/sdk';
   ( X0 N' \1 I9 R; E( a, C
2. 
   5 v5 e0 D. R. p& g
3. backButton.isSupported(); // boolean

复制代码

Functions :

1. import { isBackButtonSupported } from '@telegram-apps/sdk';
   ) T8 D1 S2 J% ^! e/ P: ^7 f( Y
2. 
   
3. isBackButtonSupported(); // boolean

复制代码

安装​

在使用该组件之前，有必要将其安装到配置正确的 属性中。 为此，请使用 mount 方法。 它将更新 isMounted 信号属性。

Variable :

1. import { backButton } from '@telegram-apps/sdk';
   , [" K$ s: v' H* h# U
2. 
   
3. backButton.mount();
   6 \7 f7 ]) @) n( w- z% w
4. backButton.isMounted(); // true

复制代码

Functions :

1. import { mountBackButton, isBackButtonMounted } from '@telegram-apps/sdk';
   * y. m5 l7 m' E; Y  Q
2. 
   4 x% _2 l+ k9 w$ A2 X
3. mountBackButton();
   
4. isBackButtonMounted(); // true

复制代码

要卸载，请使用 unmount 方法：

Variable :

1. backButton.unmount();
   8 e+ }5 B" }6 _9 `1 |
2. backButton.isMounted(); // false

复制代码

Functions :

1. import { unmountBackButton, isBackButtonMounted } from '@telegram-apps/sdk';
   / F  ]! H: }) W) [: W7 W* u  F
2. 
   . M* e4 ~& F# O% ~0 A. R
3. unmountBackButton();
   % E. a0 r% M5 d: Z1 Q- n5 T
4. isBackButtonMounted(); // false

复制代码

展示与隐藏​

要更改按钮的可见性，请使用 hide() 和 show() 方法。 这些方法会更新 isVisible 信号属性值。

Variable :

1. backButton.show();
   
2. backButton.isVisible(); // true
   
3. 
   
4. backButton.hide();
   2 H( t5 E( a& j& O+ X) U
5. backButton.isVisible(); // false

复制代码

Functions :

1. import {
   0 r" o1 ]$ n; ~5 S# `0 ^1 b
2.   showBackButton,
   
3.   hideBackButton,
   1 j) f7 N0 a9 e
4.   isBackButtonVisible,
   
5. } from '@telegram-apps/sdk';
   
6. 
   1 G9 Q* d& e$ Y, @4 k% ]5 X  q
7. showBackButton();
   
8. isBackButtonVisible(); // true
   
9. 
   1 B8 i4 A4 i/ T/ F2 u/ W9 Z+ g+ V
10. hideBackButton();
    4 U2 ?1 X$ i4 j8 M' Z7 u, y
11. isBackButtonVisible(); // false

复制代码

跟踪点击​

要添加按钮点击监听器，请使用 onClick 方法。 它返回一个函数，用于移除绑定的 监听器。 或者，您也可以使用 offClick 方法。

Variable :

1. function listener() {
   
2.   console.log('Clicked!');
   
3. }
   
4. 
   / z* l9 q8 L: o
5. const offClick = backButton.onClick(listener);
   7 C/ d& a& C" I: c3 R2 L
6. offClick();
   
7. // or
   
8. backButton.onClick(listener);
   4 h5 P. s: m. l+ f
9. backButton.offClick(listener);

复制代码

Functions :

1. import { onBackButtonClick, offBackButtonClick } from '@telegram-apps/sdk';
   
2. 
   ! M3 i7 }7 j$ b3 c  @& m' D
3. function listener() {
   0 c" O0 d3 O4 R
4.   console.log('Clicked!');
   
5. }
   & w# F" P+ o, t8 K/ r1 a+ x
6. 
   7 _6 m3 J  w6 D' v. _
7. const offClick = onBackButtonClick(listener);
   8 A3 l1 @/ @  G: j6 G" p
8. offClick();
   
9. // or
   
10. onBackButtonClick(listener);
    ) e7 f( X1 Z7 ?% V* x7 H- Q. o9 q
11. offBackButtonClick(listener);

复制代码

. Z& k" F# A7 d9 H6 u
/ f! O/ K. \& _* a2 D9 X. p! s