Class ItemSelector

constructor

• new ItemSelector(__namedParameters?, options): ItemSelector

• Parameters

  • __namedParameters: {
        actor: any;
        empty: undefined | boolean;
        filter: any;
        items: any;
        selected: undefined | null;
    } = {}

    • actor: any

    • empty: undefined | boolean

    • filter: any

    • items: any

    • selected: undefined | null

  • options: any

  Returns ItemSelector

empty

filterFunc

items

selected

template

• get template(): string

• Returns string

title

• get title(): string

• Returns string

Static defaultOptions

• get defaultOptions(): {
      classes: string[];
      closeOnSubmit: boolean;
      height: string;
      resizable: boolean;
      scrollY: string[];
      submitOnChange: boolean;
      submitOnClose: boolean;
  }

• Returns {
      classes: string[];
      closeOnSubmit: boolean;
      height: string;
      resizable: boolean;
      scrollY: string[];
      submitOnChange: boolean;
      submitOnClose: boolean;
  }

  • classes: string[]

  • closeOnSubmit: boolean

  • height: string

  • resizable: boolean

  • scrollY: string[]

  • submitOnChange: boolean

  • submitOnClose: boolean

_onSaveSelection

• _onSaveSelection(event): void

• Parameters

  • event: any

  Returns void

_updateObject

• _updateObject(event, formData): void

• Parameters

  • event: any

  • formData: any

  Returns void

activateListeners

• activateListeners(jq): void

• Parameters

  • jq: any

  Returns void

close

• close(...args): void

• Parameters

  • Rest ...args: any[]

  Returns void

getData

• getData(): {
      empty: boolean;
      items: any;
      selected: string;
  }

• Returns {
      empty: boolean;
      items: any;
      selected: string;
  }

  • empty: boolean

  • items: any

  • selected: string

Static wait

• wait(options?, appOptions?, renderOptions?): Promise<null | string>

• Render item selector and wait for it to resolve.

  Parameters

  • options: {
        actor: undefined | Actor;
        empty: undefined | boolean;
        filter: Function;
        items: undefined | Item[];
        selected: undefined | string;
    } = {}

    Options

    • actor: undefined | Actor

      Actor to find items from.

    • empty: undefined | boolean

      Allow empty selection.

    • filter: Function

      Filter function

    • items: undefined | Item[]

      Items list. Used only if actor is undefined.

    • selected: undefined | string

      Already selected item ID.

  • Optional appOptions: object

    Application options

  • Optional renderOptions: object

    Render options

  Returns Promise<null | string>

  • Item ID or null if cancelled.