Skip to content

滑动行为

负责 Telegram 小程序滑动行为的💠组件

检查支持

要检查当前 Telegram 小程序版本是否支持滑动行为,需要使用 isSupported 方法:

ts
import { swipeBehavior } from '@telegram-apps/sdk';

swipeBehavior.isSupported(); // boolean
ts
import { isSwipeBehaviorSupported } from '@telegram-apps/sdk';

isSwipeBehaviorSupported(); // boolean

挂载

在使用此组件之前,需要将其挂载,以便与正确配置的属性一起工作。 为此,请使用 mount 方法。 它将更新 isMounted 信号属性。

ts
import { swipeBehavior } from '@telegram-apps/sdk';

if (swipeBehavior.mount.isAvailable()) {
  swipeBehavior.mount();
  swipeBehavior.isMounted(); // true
}
ts
import {
  mountSwipeBehavior,
  isSwipeBehaviorMounted,
} from '@telegram-apps/sdk';

if (mountSwipeBehavior.isAvailable()) {
  mountSwipeBehavior();
  isSwipeBehaviorMounted(); // true
}

要卸载,请使用 unmount 方法:

ts
swipeBehavior.unmount(); 
swipeBehavior.isMounted(); // false
ts
import {
  unmountClosingBehavior,
  isSwipeBehaviorMounted,
} from '@telegram-apps/sdk';

unmountSwipeBehavior(); 
isSwipeBehaviorMounted(); // false

控制纵向滑动

要启用或禁用垂直滑动,请使用 enableVerticaldisableVertical 方法。 调用这些方法时,会更新 isVerticalEnabled 信号属性值。

ts
if (swipeBehavior.enableVertical.isAvailable()) {
  swipeBehavior.enableVertical();
  swipeBehavior.isVerticalEnabled(); // true
}

if (swipeBehavior.disableVertical.isAvailable()) {
  swipeBehavior.disableVertical();
  swipeBehavior.isVerticalEnabled(); // false
}
ts
import {
  enableVerticalSwipes,
  disableVerticalSwipes,
  isVerticalSwipesEnabled,
} from '@telegram-apps/sdk';

if (enableVerticalSwipes.isAvailable()) {
  enableVerticalSwipes();
  isVerticalSwipesEnabled(); // true
}

if (disableVerticalSwipes.isAvailable()) {
  disableVerticalSwipes();
  isVerticalSwipesEnabled(); // false
}

Released under the MIT License.