diff --git a/docs/_config.yml b/docs/_config.yml index a9eef2800..4d7bc9746 100644 --- a/docs/_config.yml +++ b/docs/_config.yml @@ -71,6 +71,8 @@ navigation: url: javascript/expandable-tables.html - title: IFrame url: javascript/iframe.html + - title: Navbar Search + url: javascript/navbar-search.html - title: Browser Support url: browser-support.html icon: fab fa-chrome diff --git a/docs/javascript/navbar-search.md b/docs/javascript/navbar-search.md new file mode 100644 index 000000000..70965194f --- /dev/null +++ b/docs/javascript/navbar-search.md @@ -0,0 +1,94 @@ +--- +layout: page +title: Navbar Search Plugin +--- + +The navbar search plugin provides the functionality to show/hide a search input across the whole header. + +##### Usage + +This plugin can be activated as a jQuery plugin or using the data API. + +###### Data API +{: .text-bold } + +Activate the plugin by adding the following data-attribue `data-widget="navbar-search"` to the `.navbar-search-block` inside the header. You can use the HTML Markup below for a quick start. + +###### jQuery +{: .text-bold } + +The jQuery API provides more customizable options that allows the developer to pre-process the request before rendering and post-process it after rendering. + +```js +("[data-widget="navbar-search"]").SiteSearch(options) +``` + +##### HTML Markup +Place this HTML Markup after inside the header. +```html + + + + +``` + +Or you can place the search button inside the navbar as nav-item with this markup: +```html + +``` + +##### Options +{: .mt-4} + +|--- +| Name | Type | Default | Description +|-|-|-|- +| resetOnClose | Boolean | false | Reset Input on Close/Hide. +{: .table .table-bordered .bg-light} + + +##### Methods +{: .mt-4} + +|--- +| Method | Description +|-|- +|toggle | Toggles the search block. +|close | Closes the search block. +|open | Opens the search block. +{: .table .table-bordered .bg-light} + +Example: `$('[data-widget="navbar-search"]').SiteSearch('toggle')`