静态对象

静态 OverlayScrollbars 对象

OverlayScrollbars.plugin(SomePlugin);

静态对象方法

Typescript

// OverlayScrollbars 静态对象接口。
interface OverlayScrollbarsStatic {
  // 根据传入的目标获取其实例，如果目标没有实例则返回 `undefined`。
  (target: InitializationTarget): OverlayScrollbars | undefined;
  // 使用传入的选项和事件监听器对目标初始化 OverlayScrollbars。
  (
    target: InitializationTarget,
    options: PartialOptions,
    eventListeners?: EventListeners
  ): OverlayScrollbars;

  // 添加单个插件。
  plugin(plugin: Plugin): InferStaticPluginModuleInstance<Plugin>;
  // 添加多个插件。
  plugin(plugins: Plugin[]): InferStaticPluginModuleInstance<Plugin>[];

  // 检查传递的值是否为有效且未销毁的 Overlayscrollbars 实例。
  valid(osInstance: any): osInstance is OverlayScrollbars;

  // 获取环境信息。
  env(): Environment;
}

// 描述 Overlayscrollbars 运行环境的接口。
interface Environment {
  // 浏览器/系统原生滚动条的尺寸。
  scrollbarsSize: XY<number>;
  // 原生滚动条是否为覆盖式显示。
  scrollbarsOverlaid: XY<boolean>;
  // 浏览器是否支持隐藏原生滚动条。
  scrollbarsHiding: boolean;
  // 浏览器是否支持 ScrollTimeline API。
  scrollTimeline: boolean;
  // 如果没有其他指定，则使用的默认初始化配置。
  staticDefaultInitialization: Initialization;
  // 如果没有其他指定，则使用的默认选项配置。
  staticDefaultOptions: Options;

  // 返回当前的默认初始化配置。
  getDefaultInitialization(): Initialization;
  // 返回当前的默认选项配置。
  getDefaultOptions(): Options;

  /**
   * 设置新的默认初始化配置。
   * 如果新的默认初始化配置是部分填写的，它将与当前的默认初始化配置深度合并。
   * @param newDefaultInitialization 新的默认初始化配置。
   * @returns 当前的默认初始化配置。
   */
  setDefaultInitialization(
    newDefaultInitialization: PartialInitialization
  ): Initialization;

  /**
   * 设置新的默认选项。
   * 如果新的默认选项是部分填写的，它们将与当前的默认选项深度合并。
   * @param newDefaultOptions 新的默认选项。
   * @returns 当前的默认选项。
   */
  setDefaultOptions(newDefaultOptions: PartialOptions): Options;
}