@bridgeline-digital/hawksearch-handlebars-ui 2.0.0-beta.12 → 2.0.0-beta.13
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/index.js +1 -1
- package/dist/index.js.map +1 -1
- package/docs/index.html +2 -2
- package/package.json +2 -2
- package/readme.md +1 -1
package/docs/index.html
CHANGED
|
@@ -38,9 +38,9 @@
|
|
|
38
38
|
</a>
|
|
39
39
|
<p>This library is also available through <a href="https://www.jsdelivr.com/">jsDelivr</a>, a high-performance global content delivery network built to consume <a href="https://www.npmjs.com/">npm</a> packages.</p>
|
|
40
40
|
<p>To configure your website to use the CDN, simply update your HTML to import the script file, set your [Configuration)(models/Configuration.html), and add the appropriate elements to your page. Below is a basic sample implementation:</p>
|
|
41
|
-
<pre><code class="language-html"><span class="hl-0"><!</span><span class="hl-1">DOCTYPE</span><span class="hl-2"> </span><span class="hl-3">html</span><span class="hl-0">></span><br/><span class="hl-0"><</span><span class="hl-1">html</span><span class="hl-2"> </span><span class="hl-3">lang</span><span class="hl-2">=</span><span class="hl-4">"en"</span><span class="hl-0">></span><br/><span class="hl-2"> </span><span class="hl-0"><</span><span class="hl-1">head</span><span class="hl-0">></span><br/><span class="hl-2"> </span><span class="hl-0"><</span><span class="hl-1">meta</span><span class="hl-2"> </span><span class="hl-3">charset</span><span class="hl-2">=</span><span class="hl-4">"utf-8"</span><span class="hl-2"> </span><span class="hl-0">/></span><br/><span class="hl-2"> </span><span class="hl-0"><</span><span class="hl-1">title</span><span class="hl-0">></span><span class="hl-2">HawkSearch Handlebars UI</span><span class="hl-0"></</span><span class="hl-1">title</span><span class="hl-0">></span><br/><span class="hl-2"> </span><span class="hl-0"><</span><span class="hl-1">meta</span><span class="hl-2"> </span><span class="hl-3">name</span><span class="hl-2">=</span><span class="hl-4">"viewport"</span><span class="hl-2"> </span><span class="hl-3">content</span><span class="hl-2">=</span><span class="hl-4">"width=device-width, initial-scale=1"</span><span class="hl-2"> </span><span class="hl-0">/></span><br/><span class="hl-2"> </span><span class="hl-0"><</span><span class="hl-1">script</span><span class="hl-5"> </span><span class="hl-3">type</span><span class="hl-5">=</span><span class="hl-4">"text/javascript"</span><span class="hl-0">></span><br/><span class="hl-5"> </span><span class="hl-6">var</span><span class="hl-5"> </span><span class="hl-7">HawkSearch</span><span class="hl-5"> </span><span class="hl-2">=</span><span class="hl-5"> </span><span class="hl-7">HawkSearch</span><span class="hl-5"> </span><span class="hl-2">||</span><span class="hl-5"> {};</span><br/><br/><span class="hl-5"> </span><span class="hl-7">HawkSearch</span><span class="hl-5">.</span><span class="hl-7">config</span><span class="hl-5"> </span><span class="hl-2">=</span><span class="hl-5"> {</span><br/><span class="hl-5"> </span><span class="hl-7">clientId:</span><span class="hl-5"> </span><span class="hl-8">'YOUR_CLIENTID_HERE'</span><br/><span class="hl-5"> };</span><br/><span class="hl-5"> </span><span class="hl-0"></</span><span class="hl-1">script</span><span class="hl-0">></span><br/><span class="hl-2"> </span><span class="hl-0"><</span><span class="hl-1">script</span><span class="hl-5"> </span><span class="hl-3">src</span><span class="hl-5">=</span><span class="hl-4">"//cdn.jsdelivr.net/npm/@bridgeline-digital/hawksearch-handlebars-ui@2.0.0-beta.
|
|
41
|
+
<pre><code class="language-html"><span class="hl-0"><!</span><span class="hl-1">DOCTYPE</span><span class="hl-2"> </span><span class="hl-3">html</span><span class="hl-0">></span><br/><span class="hl-0"><</span><span class="hl-1">html</span><span class="hl-2"> </span><span class="hl-3">lang</span><span class="hl-2">=</span><span class="hl-4">"en"</span><span class="hl-0">></span><br/><span class="hl-2"> </span><span class="hl-0"><</span><span class="hl-1">head</span><span class="hl-0">></span><br/><span class="hl-2"> </span><span class="hl-0"><</span><span class="hl-1">meta</span><span class="hl-2"> </span><span class="hl-3">charset</span><span class="hl-2">=</span><span class="hl-4">"utf-8"</span><span class="hl-2"> </span><span class="hl-0">/></span><br/><span class="hl-2"> </span><span class="hl-0"><</span><span class="hl-1">title</span><span class="hl-0">></span><span class="hl-2">HawkSearch Handlebars UI</span><span class="hl-0"></</span><span class="hl-1">title</span><span class="hl-0">></span><br/><span class="hl-2"> </span><span class="hl-0"><</span><span class="hl-1">meta</span><span class="hl-2"> </span><span class="hl-3">name</span><span class="hl-2">=</span><span class="hl-4">"viewport"</span><span class="hl-2"> </span><span class="hl-3">content</span><span class="hl-2">=</span><span class="hl-4">"width=device-width, initial-scale=1"</span><span class="hl-2"> </span><span class="hl-0">/></span><br/><span class="hl-2"> </span><span class="hl-0"><</span><span class="hl-1">script</span><span class="hl-5"> </span><span class="hl-3">type</span><span class="hl-5">=</span><span class="hl-4">"text/javascript"</span><span class="hl-0">></span><br/><span class="hl-5"> </span><span class="hl-6">var</span><span class="hl-5"> </span><span class="hl-7">HawkSearch</span><span class="hl-5"> </span><span class="hl-2">=</span><span class="hl-5"> </span><span class="hl-7">HawkSearch</span><span class="hl-5"> </span><span class="hl-2">||</span><span class="hl-5"> {};</span><br/><br/><span class="hl-5"> </span><span class="hl-7">HawkSearch</span><span class="hl-5">.</span><span class="hl-7">config</span><span class="hl-5"> </span><span class="hl-2">=</span><span class="hl-5"> {</span><br/><span class="hl-5"> </span><span class="hl-7">clientId:</span><span class="hl-5"> </span><span class="hl-8">'YOUR_CLIENTID_HERE'</span><br/><span class="hl-5"> };</span><br/><span class="hl-5"> </span><span class="hl-0"></</span><span class="hl-1">script</span><span class="hl-0">></span><br/><span class="hl-2"> </span><span class="hl-0"><</span><span class="hl-1">script</span><span class="hl-5"> </span><span class="hl-3">src</span><span class="hl-5">=</span><span class="hl-4">"//cdn.jsdelivr.net/npm/@bridgeline-digital/hawksearch-handlebars-ui@2.0.0-beta.13/dist/hawksearch-handlebars-ui.js"</span><span class="hl-5"> </span><span class="hl-3">defer</span><span class="hl-0">></</span><span class="hl-1">script</span><span class="hl-0">></span><br/><span class="hl-2"> </span><span class="hl-0"></</span><span class="hl-1">head</span><span class="hl-0">></span><br/><span class="hl-2"> </span><span class="hl-0"><</span><span class="hl-1">body</span><span class="hl-0">></span><br/><span class="hl-2"> </span><span class="hl-0"><</span><span class="hl-1">h1</span><span class="hl-0">></span><span class="hl-2">HawkSearch Handlebars UI</span><span class="hl-0"></</span><span class="hl-1">h1</span><span class="hl-0">></span><br/><span class="hl-2"> </span><span class="hl-0"><</span><span class="hl-1">hawksearch-search-field</span><span class="hl-0">></</span><span class="hl-1">hawksearch-search-field</span><span class="hl-0">></span><br/><span class="hl-2"> </span><span class="hl-0"><</span><span class="hl-1">hawksearch-search-results</span><span class="hl-0">></</span><span class="hl-1">hawksearch-search-results</span><span class="hl-0">></span><br/><span class="hl-2"> </span><span class="hl-0"></</span><span class="hl-1">body</span><span class="hl-0">></span><br/><span class="hl-0"></</span><span class="hl-1">html</span><span class="hl-0">></span>
|
|
42
42
|
</code></pre>
|
|
43
|
-
<p><em>Note: It is highly recommended to target a specific version, especially if there are customizations, to avoid potentially breaking changes in the future. For example, instead of including the script at <a href="https://cdn.jsdelivr.net/npm/@bridgeline-digital/hawksearch-handlebars-ui/dist/hawksearch-handlebars-ui.js">https://cdn.jsdelivr.net/npm/@bridgeline-digital/hawksearch-handlebars-ui/dist/hawksearch-handlebars-ui.js</a>, you can use <a href="https://cdn.jsdelivr.net/npm/@bridgeline-digital/hawksearch-handlebars-ui@2.0.0-beta.
|
|
43
|
+
<p><em>Note: It is highly recommended to target a specific version, especially if there are customizations, to avoid potentially breaking changes in the future. For example, instead of including the script at <a href="https://cdn.jsdelivr.net/npm/@bridgeline-digital/hawksearch-handlebars-ui/dist/hawksearch-handlebars-ui.js">https://cdn.jsdelivr.net/npm/@bridgeline-digital/hawksearch-handlebars-ui/dist/hawksearch-handlebars-ui.js</a>, you can use <a href="https://cdn.jsdelivr.net/npm/@bridgeline-digital/hawksearch-handlebars-ui@2.0.0-beta.13/dist/hawksearch-handlebars-ui.js">https://cdn.jsdelivr.net/npm/@bridgeline-digital/hawksearch-handlebars-ui@2.0.0-beta.13/dist/hawksearch-handlebars-ui.js</a>.</em></p>
|
|
44
44
|
|
|
45
45
|
<a href="#configuration" id="configuration" style="color: inherit; text-decoration: none;">
|
|
46
46
|
<h2>Configuration</h2>
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@bridgeline-digital/hawksearch-handlebars-ui",
|
|
3
|
-
"version": "2.0.0-beta.
|
|
3
|
+
"version": "2.0.0-beta.13",
|
|
4
4
|
"description": "The HawkSearch Handlebars UI package allows you to add a highly-customizable search results page to your website powered by HawkSearch.",
|
|
5
5
|
"private": false,
|
|
6
6
|
"publishConfig": {
|
|
@@ -9,7 +9,7 @@
|
|
|
9
9
|
"scripts": {
|
|
10
10
|
"build:dev": "npm run gulp && webpack",
|
|
11
11
|
"build:prod": "npm run gulp && webpack --mode=production",
|
|
12
|
-
"docs": "tsc ./typedoc/index.ts --outDir ./typedoc/build && typedoc",
|
|
12
|
+
"docs": "tsc ./typedoc/index.ts --esModuleInterop true --outDir ./typedoc/build && typedoc",
|
|
13
13
|
"eslint": "eslint . --ext .ts --max-warnings=0 --fix",
|
|
14
14
|
"gulp": "gulp build",
|
|
15
15
|
"gulp:svg": "gulp svg",
|
package/readme.md
CHANGED
|
@@ -34,4 +34,4 @@ The HawkSearch Handlebars UI package allows you to add a highly-customizable sea
|
|
|
34
34
|
|
|
35
35
|
## Documentation
|
|
36
36
|
|
|
37
|
-
Documentation is available in the `docs` folder of the npm package.
|
|
37
|
+
Documentation is available at http://handlebars-ui.hawksearch.com/2.0.0-beta.13/ and in the `docs` folder of the npm package.
|