Find It Fast

A jQuery search autocomplete plugin with built-in WAI-ARIA

Features

• Meets WAI-ARIA requirements; built-in necessary form input HTML
• Handles JSON objects, arrays and AJAX urls
• Optionally customize callbacks
• Mobile-friendly

Optional Configuration

• defaults
  • dataConfig
    • type (string) -- json, array, or url (url assumes json response. Form is serialized and params are passed to ajax url)
    • src (string) -- json object, array or url of data
    • key (string) -- name of 'key' in JSON response to display listItem name
    • href (string) -- name of 'key' in JSON response to display listItem href
    • maxItems (number) -- maximum number of items allowed to display in autocomplete
    • timer (number) -- millisecond delay after typing stops before data retrieval
  • initClass (string) -- plugin class name attached to HTML tag for reference
  • templates
    • form
      • method (string)
      • action (string)
      • name (string)
      • label (string)
      • hideLabelText (boolean)
      • placeholder (string)
      • inputName (string) -- use argument name for ajax request if selecting url for dataConfig.type
      • inputClass (string)
      • clearSearchHtml (string)
      • clearSearchAriaText (string)
      • includeSubmit (boolean) -- include a search button if the search can also redirect to a search results page. This will add a submit button with an onsubmit event (customized in eventConfig.form.onObjSubmit) and a form action (provide action in templates.form.action)
      • action (string)
      • submitType (string) -- text or icon, - choosing icon will render submitAriaText
      • submitHtml (string) button text or icon html
      • submitAriaText (string)
    • listItems
      • type (string) -- json, array
      • includeLinks (boolean) -- uses <a> tags for listItems, provide dataConfig.href
      • className (string) -- additional class name
      • position (string) -- placement of autocomplete list (bottom or top)
  • ariaConfig
    • srHiddenClass (string)
    • includeLiveRegion (boolean) -- should be a live region somewhere on page whether it is your own or this version (NOTE: only renders once if true is selected)
    • liveMsg -- messages that the screen reader reads when search results are returned
      • none (string) -- no results (NOTE: this message also appears in the autocomplete when no results are returned)
      • one (string) -- one result
      • multiple (string) -- more than one result
  • eventConfig (callbacks) -- these are defaulted to plugin functionality, but can be replaced with your own
    • input -- search field
      • onObjClick
      • onObjFocus
      • onObjBlur
      • onObjKeydown
    • cancel -- search reset button
      • onObjClick
      • onObjFocus
      • onObjBlur
      • onObjKeydown
    • listItems -- each search result
      • onObjClick
      • onObjFocus
      • onObjBlur
      • onObjKeydown
    • form -- form actions
      • onObjSubmit

Example Configs for API resource

$('#search1').findItFast({
    dataConfig: {
        type: 'url',
        src: '/countries/search?limit=10',
        key: 'name',
        href: 'url',
        timer: 1000
    },
    templates: {
        form: {
            inputName: 'q'
        },
        listItems: {
            includeLinks: true
        }
    }
})

$('#search2').findItFast({
    dataConfig: {
        type: 'url',
        src: '/countries/search?limit=5&key=code',
        key: 'code'
    },
    templates: {
        form: {
            inputName: 'q'
        }
    },
    ariaConfig: {
        includeLiveRegion: true
    }
})