x
Support Purchase
Metronic

The Ultimate Bootstrap & Angular 6 Admin Theme Framework For Next Generation Applications

Watch Video

 

Quicksearch

Overview

mQuicksearch is a Metronic's custom plugin defined in src/js/framework/components/general/quicksearch.js.

Initialization

First parameter is the id, class, or tag of the HTML element. The second parameter is for the options.

var quicksearch = new mQuicksearch('m_quicksearch', options);

Options

var options = {
    mode: 'default', //'default/dropdown'
    minLength: 1,
    maxHeight: 300,
    requestTimeout: 200, // ajax request fire timeout in milliseconds
    inputTarget: 'm_quicksearch_input',
    iconCloseTarget: 'm_quicksearch_close',
    iconCancelTarget: 'm_quicksearch_cancel',
    iconSearchTarget: 'm_quicksearch_search',

    spinnerClass: 'm-loader m-loader--skin-light m-loader--right',
    hasResultClass: 'm-list-search--has-result',

    templates: {
        error: '<div class="m-search-results m-search-results--skin-light"><span class="m-search-result__message">{{message}}</div></div>'
    }
};
Field Type Description
mode string

Quick search mode. Accepted values are default and dropdown

Sample 
mode: 'default'
minLength number

Minimum length of records to be displayed

Sample 
minLength: 1
maxHeight number

Maximum height of result to be displayed

Sample 
maxHeight: 300
requestTimeout number

The timeout in miliseconds for the request

Sample 
requestTimeout: 200
inputTarget string

The target of input textbox where the search action to be triggered

Sample 
inputTarget: 'm_quicksearch_input'
iconCloseTarget string

Set the icon for the search close

Sample 
iconCloseTarget: 'm_quicksearch_close'
iconCancelTarget string

Set the icon for the search cancel

Sample 
iconCancelTarget: 'm_quicksearch_cancel'
iconSearchTarget string

Set the icon for the search

Sample 
iconSearchTarget: 'm_quicksearch_search'
spinnerClass string

Set spinner icon class name to be displayed during search action

Sample 
spinnerClass: 'm-loader m-loader--skin-light m-loader--right'
hasResultClass string

Set search result class name when the search has result

Sample 
hasResultClass: 'm-list-search--has-result'
templates.error string

The error template in HTML format, to be displayed when the search result has error. Add the placeholder {{message}} in the template, and it will be replaced by showError(message) API method.

Sample 
templates: {
    error: '<div class="m-search-results m-search-results--skin-light"><span class="m-search-result__message">{{message}}</div></div>'
}

API Methods

Method Description
setDefaults(options)

Set default options

Input Parameters
Name Type Description
options object

A new options object for the menu
showResult(response)

Show the result of the search

Input Parameters
Name Type Description
response string

The search result response to be displayed
showError(message)

Show the error based of the template error defined in the options. {{message}} placeholder in the error template will be replaced by the message parameter.

Input Parameters
Name Type Description
message string

The text for the error
showProgress()

Show the search progress bar
hideProgress()

Hide the search progress bar
search()

Trigger search manually
on(name, handler)

Register event

Input Parameters
Name Type Description
name string

Unique event name
handler function

Callback function handler for the event
one(name, handler)

Register event to be run once

Input Parameters
Name Type Description
name string

Unique event name
handler function

Callback function handler for the event
I run a team of 20 product managers, developers, QA and UX resources. Previously we designed everything ourselves. For our newest platform we tried out Metronic. I cannot overestimate the impact Metronic has had. It's accelerated development 3x and reduced QA issues by 50%. If you add up the reduced need for design time/resources, the increase in dev speed and the reduction in QA, it's probably saved us $100,000 on this project alone, and I plan to use it for all platforms moving forward.
The flexibility of the design has also allowed us to put out a better looking & working platform and reduced my headaches by 90%. Thank you KeenThemes! Jonathan Bartlett, Metronic Customer

Powerful Framework

Everything within Metronic is customizable globally to provide limitless unique styled projects

Multi Demo

Choose a perfect design for your next project among hundreds of demos

Limitless Components

A huge collection of components to power your application with the latest UI/UX trands

Angular 6 Support

Enterprise ready Angular 6 integration with built-in authentication module and many more

Bootstrap 4

Metronic deeply customizes Bootstrap with native look and feel

Exclusive Datatable Plugin

Our super sleek and intuitive Datatable comes packed with all advanced CRUD features

60,000+ Strong

Metronic is the only theme trusted by over 60,000 developers world wide

Continuous Updates

Lifetime updates with new demos and features is guaranteed

Quality Code

Metronic is writer with a code structure that all developers will be able to pick up easily and fall in love

The Ultimate Bootstrap Admin Theme Trusted By Over 60,000 Developers World Wide

PURCHASE NOW