Skip to content

illuminateeducation/quick-switcher

 
 

Repository files navigation

quick-switcher

Build Status Code Climate

Front-end web component for navigating and searching

Check out the docs for a demo.

Development Environment

  1. Ensure Node.js is installed
  2. Install quick-switcher dependencies
npm install

Todo

Document:

  • Basic initialization
    • searchCallback
    • selectCallback
  • Basic options
    • hotKey
    • searchDelay
  • Subsearches
    • Defining items as subsearches
    • selectChildSearchCallback—performing an action when an item is selected that is a subsearch
  • Tracker usage
    • What is the purpose of a tracker?
    • How is tracking enabled?
    • How can the tracker be overridden so that items can be pinned to the top/bottom of the list?
  • Sorters?
    • These may go away, especially if the tracker is revamped to handle sorting automatically
  • Filters?
    • Right now only one of these is really useable

About

🔍 Front-end web component for navigating and searching

Topics

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages

  • JavaScript 62.8%
  • Ruby 14.9%
  • CSS 11.8%
  • HTML 10.2%
  • Makefile 0.3%