{"type":"doc","content":[{"type":"heading","attrs":{"level":2},"content":[{"text":"Overview","type":"text"}]},{"type":"paragraph","content":[{"text":"Standard practice is to create a predefined search box component to be subsequently placed on the desired page template. This is the specific configuration for this type of widget based on the common widget root element.","type":"text"}]},{"type":"paragraph"},{"type":"heading","attrs":{"level":2},"content":[{"text":"Steps to create","type":"text"}]},{"type":"orderedList","attrs":{"order":1},"content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Create a Stencil component template file in a desired directory (e.g. ","type":"text"},{"text":"templates\\components\\hawksearch","type":"text","marks":[{"type":"em"}]},{"text":")","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Place the specific root element structure in the component file","type":"text"},{"type":"hardBreak"},{"type":"hardBreak"},{"text":"templates\\components\\hawksearch\\search-box.html","type":"text","marks":[{"type":"strong"}]}]},{"type":"codeBlock","attrs":{"language":"html"},"content":[{"text":"

\n \n

","type":"text"}]},{"type":"paragraph"},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"The element has the dedicated search box selector, thus differentiating it from other widgets like the results, which require an initial search.","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"The only available main Vue component is ","type":"text"},{"text":"","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"There is an exposed variable for redirecting - ","type":"text"},{"text":"searchpage","type":"text","marks":[{"type":"strong"}]},{"text":". If available, the search request will redirect to a search results page where the results widget will display the output of the search. If this variable is not provided the search process will be executed on the current page.","type":"text"}]}]}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":" A frequently used placement of this widget using the redirect feature is in the heading of the page. For this, the component should be placed in ","type":"text"},{"text":"templates\\components\\common\\header.html","type":"text","marks":[{"type":"em"}]},{"text":". In this case “/search“ is the URL of the search results page.","type":"text"},{"type":"hardBreak"},{"type":"hardBreak"},{"text":"templates\\components\\common\\header.html","type":"text","marks":[{"type":"strong"}]}]},{"type":"codeBlock","attrs":{"language":"html"},"content":[{"text":"...\n

\n {{> components/hawksearch/search-box searchpage=\"/search\"}}\n

\n...","type":"text"}]},{"type":"paragraph"}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"The same invocation can be executed in any of the other template files. If there is an available results widget on the same page, use without the searchpage parameter.","type":"text"}]},{"type":"codeBlock","content":[{"text":"...\n{{> components/hawksearch/search-box }}\n...\n\n...\n{{> components/hawksearch/results }}\n...","type":"text"}]}]}]},{"type":"panel","attrs":{"panelType":"info"},"content":[{"type":"paragraph","content":[{"text":"Follow the ","type":"text"},{"text":"search results documentation","type":"text","marks":[{"type":"link","attrs":{"href":"https://bridgeline.atlassian.net/l/cp/e59j2J6P"}}]},{"text":" for more information on how to setup the search results.","type":"text"}]}]},{"type":"paragraph"}],"version":1}

Browser not supported