tributejs.d.ts

// Type definitions for TributeJS v3.3.4
// Project: https://github.com/zurb/tribute
// Definitions by: Jordan Humphreys <https://github.com/mrsweaters/>

export type TributeItem<T extends {}> = {
  index: number
  original: T
  score: number
  string: string
}

export type TributeCollection<T extends {}> = {
  // symbol that starts the lookup
  trigger?: string

  // element to target for @mentions
  iframe?: any

  // class added in the flyout menu for active item
  selectClass?: string

  // function called on select that returns the content to insert
  selectTemplate?: (item: TributeItem<T>) => string

  // template for displaying item in menu
  menuItemTemplate?: (item: TributeItem<T>) => string

  // template for when no match is found (optional),
  // If no template is provided, menu is hidden.
  noMatchTemplate?: () => string

  // specify an alternative parent container for the menu
  menuContainer?: Element

  // column to search against in the object (accepts function or string)
  lookup?: string | ((item: T) => string)

  // column that contains the content to insert by default
  fillAttr?: string

  // array of objects to match
  values?: Array<T> | ((text: string, cb: (result: Array<T>) => void) => void)

  // specify whether a space is required before the trigger character
  requireLeadingSpace?: boolean

  // specify whether a space is allowed in the middle of mentions
  allowSpaces?: boolean

  // optionally specify a custom suffix for the replace text
  // (defaults to empty space if undefined)
  replaceTextSuffix?: string
}

export type TributeOptions<T> = TributeCollection<T> | {
  // pass an array of config objects
  collection: Array<TributeCollection<{ [key: string]: any }>>
}

export default class Tribute {
  constructor<T extends {}>(options: TributeOptions<T>)

  isActive: boolean

  append<T extends {}>(index: number, values: Array<T>, replace?: boolean): void

  appendCurrent<T extends {}>(values: Array<T>, replace?: boolean): void

  attach(to: Element): void

  detach(to: Element): void
}