Class Controller<PluginState, PluginEventMap, PluginServerData, PluginData>Abstract

constructor

• new Controller<
      PluginState extends BasePlugin.State,
      PluginEventMap extends BasePlugin.EventMap<PluginState, PluginData>,
      PluginServerData,
      PluginData,
  >(
      five: Five,
      config?: BasePlugin.Config,
  ): Controller<PluginState, PluginEventMap, PluginServerData, PluginData>

  Type Parameters

  • PluginState extends BasePlugin.State
  • PluginEventMap extends BasePlugin.EventMap<PluginState, PluginData>
  • PluginServerData
  • PluginData

  Parameters

  • five: Five
  • Optionalconfig: BasePlugin.Config

  Returns Controller<PluginState, PluginEventMap, PluginServerData, PluginData>

five

hooks

Abstractstate

可以通过 plugin.state 和 plugin.setState 来获取和设置。
通过 state 设置后，plugin 会通过合适的动画运动来达到设置的效果。
来迎合一些通过数据驱动的场景。
Copy

ReadonlystaticPrefix

absoluteUrl

• absoluteUrl(url: string): string

  Parameters

  • url: string

  Returns string

  Description

  获取静态资源的url

OptionalappendTo

• appendTo?(wrapper: Element): void

  插件自身DOM添加到父容器

  Parameters

  • wrapper: Element

    Element元素

  Returns void

Abstractdisable

• disable(options?: BaseOptions): void

  禁用插件，让插件停止响应交互

  Parameters

  • Optionaloptions: BaseOptions

  Returns void

Abstractdispose

• dispose(): void

  插件进行销毁

  Returns void

Abstractenable

• enable(options?: BaseOptions): void

  启用插件，让插件能够响应交互

  Parameters

  • Optionaloptions: BaseOptions

  Returns void

getCurrentState

• getCurrentState(): PluginState

  获取当前的插件状态，如果当初插件内存在需要通过动画变更的 state 值，则通过此方法可以得到中间状态

  Returns PluginState

Optionalhide

• hide?(options?: BaseOptions): void | Promise<void>

  隐藏UI

  Parameters

  • Optionaloptions: BaseOptions

  Returns void | Promise<void>

Optional Abstractload

• load?(
      serverData: PluginServerData,
      state?: PluginState,
      userAction?: boolean,
  ): Promise<void>

  加载插件依赖数据

  Parameters

  • serverData: PluginServerData

    插件数据
  • Optionalstate: PluginState

    插件 State
  • OptionaluserAction: boolean

  Returns Promise<void>

OptionalsetState

• setState?(state: Partial<PluginState>, options?: BaseOptions): void

  设置state

  Parameters

  • state: Partial<PluginState>

    插件的目标状态
  • Optionaloptions: BaseOptions

    配置项

  Returns void

Optionalshow

• show?(options?: BaseOptions): void | Promise<void>

  展示UI

  Parameters

  • Optionaloptions: BaseOptions

  Returns void | Promise<void>