Skip to content

Creating an instance

super-dev edited this page Mar 20, 2022 · 4 revisions
const { 
   keyword, 
   result, 
   renderResult 
} = new dddd.Search(data, options);

Arguments

data

search source data

  • required
  • type: array

options

config extends options

  • type: object
  • default: {}
search config options
queryStringKey

search keyword query string key

  • type: string
  • default: 'q'

fields

search target fields

  • type: array
  • default: ['title', 'content', 'category', 'sub_category', 'tags']
render options
hasCustomRenderFunction

custom render function availability

  • type: boolean
  • default: false

resultSelector.template

search result template block selector

  • type: string
  • default: '#template-post-list'

resultSelector.container

target container selector to render search results

  • type: string
  • default: '#postSection'

Return

name type description
keyword string search keyword in query string
result array search result array
renderResult function search result render function using default template middleware
Clone this wiki locally