Options
All
  • Public
  • Public/Protected
  • All
Menu

Represents the interface a handler for picker plugin. Developer need to implement this interface to create a new type of picker

Hierarchy

  • PickerHandler

Index

Properties

onDispose

onDispose: () => void

Type declaration

    • (): void
    • Dispose the picker handler

      Returns void

onInitialize

onInitialize: (helper: PickerHelper) => void

Type declaration

    • Initialize the picker handler, pass in editor and PickerPlugin instance so that the handler can save them

      Parameters

      Returns void

onTrigger

onTrigger: (queryString: string, insertPoint: DOMInsertPoint) => PickerDirection

Type declaration

    • Notify the picker handler that user has typed trigger character so handler should show picker now

      Parameters

      • queryString: string

        Current query string

      • insertPoint: DOMInsertPoint

        Insert point where user is typing, can be used for calculating picker position

      Returns PickerDirection

      A picker direction to let picker plugin know what kind of picker is opened. Picker plugin will use this value to decide how to handle keyboard event to change selection. Return null means picker is not actually opened

Methods

Optional onClosePicker

  • onClosePicker(): void

Optional onQueryStringChanged

  • onQueryStringChanged(queryString: string): void

Optional onSelect

  • onSelect(): void

Optional onSelectionChanged

Generated using TypeDoc