Search suggestions

Display a curated list of search keyword suggestions to users in order to help them find helpful content.

Suggestions as badges
View code
9fcdd73019816fb29078b94f7ae5acafeba5fb7c7c908744162ec0e6ab22d00c82a1683337fa2935182ae7bdfcab7bb1bfb0b901af05ba28b868d0828cb59d8701e0f592ed21c88d06b3c550353c03db732304649b76cc3b4d53ce754979cdcf14585db4e22c7cfb65023dfbe06fcaeda7d8a6a75c6d96d9337133f5ae36534a8aa6d4e295863187a121b7218704852838cd1df6f1138e680a92669a5d2e18e79c578181f9234c5550df5592fb5ee62248e81efa7a5668cc1d18acb0e4fb5bf7affc3ea2b4008dbba07dea6bd33986a37dad84d4321c8773c5e88643ac18c1f2fe658d209055dde03bf0fb42418133acf94ed2342da62a2e264eb304a0089771c27ad816166d6b5d38f951163d86917b1a912f88a1215012e539a09983aaf27a5ae96bd62868ca0ca2f8261035458ea4eeebcf382afc92cbb419b5c40290fb776024552d54210e6c105032b7ebf76507435bc2a32def4059d06fd10530b600578ffd16305ada1e938f99416d1831c47965355a33086e611208edbd038d01b00000b93ad16345fd054299c53d0e53951f21e9f666d01ffd61f47ad2f24d96d5dcbe493e1ac5e52bec73c540c357297e1c4aceb225a643dde8478bba911a56423d86486b360e7d9ce56986ed77cb781b397d43ab808737c5c8ec5fa44da8c869068e2066e1ee069b4fab7135f96eda1463ec4bc126ecd378cee42f7290582df4fb7ff980eb69e601d2ebff9505f65bf29baea8d7e29dd4666e1b5419e95e9a58bdbe927f59ceed5a007f71954815309d79f593f9f242aae8b1ed596968db5b3bcefa216a4038936464becc38e79c6c217df718993bc6b90d288c5037e847cd873c6c7290ed9f329a72c60794fc39c53e4f8fd11734a50887b550f0671cfde9d825618bb41fb72c4412478c7e2b42d48e99d9a028e9fad113250f377cb1571119471e55c755d917c8938dcd0b5aa3b57ca3045b0b5b3b551bf2e8c96519b7b7437c8f0a502e44886fe639c3ff5e859701f9daca19309a7cc44f2df2032fb651ba2ac8a5ff9a9d93808bf60e1e6f7a3a593494455f3c99ce5c1f0f54e42828bf752ba7764168aa6ef1c6c27b04bc658b91fbb8c6237f487e5b9156e48553d64339ca8e0c979ed29cdb071869116075ff0d6ed675d0175579b168db63580a9a6dfb6e9cd4698defc87ac5e32ba14af17c95cefe456e28fcecac63d2fd77d06c0a38cced677fc33dc30b65738f3053b6e8bf94db248a16ef5c345f9cdc041eb4e2740a402fd8f074976379feb9d40a22b04f6b29f4e770ead37bda1970b450f3b2822ac956789f0ff53af0f01091a21174a928f5eea231d9bc6254d72b9b5efa9b4ffeec74d13b30a7efdc822cf1939e00ba783e01c312ed0073090efce45be3e880fbec24cc47958e62e27b78cb7fa77bd152adacce00352b6e9a3b2db473310c8d319b510b4e77764a7c2f55585c348ed68af11662855a82e4eddfa65c7a7e8bffd6bc8957ea059a899f7336f0563d8c7a96ee8581b543b05810e48bce80abc3666bf5fbcb786785ff249a7fbb679594200ef8b56e1de0303737d2d6b2b74de980c43f24ece8299d0612aee359034fc7713db5131e16e5f38bdee9f6785fc05dab916ce64109b955c4624a47971f7f991444028bcdf08dcbcf4306264667fe87f492a77d17617596add327d4c08527dec30146e4ba1645e1d20b8c952e97ef7f3d608c447e113c33a3593a65ed05315b0e6093646cd7d89db4c2c8f705678b00ff2d15a7f33f96c95aa3c41e70cb2ad973a2f825fd27ebdfd35abcb2c7ab51a708c70636ecd7ad61c04dd20a726bb7fbba9652126de064a05038101c93e81083f7c2aa70c5e6e2c3e0058d18c73d98785227cb20302d07330e604900374f7aba98eb5e6d5049c47276af1bfac037c266056152d16dba57c1a6d9ce12a7ec12b6f1772e303079d8603657e1d81c3eed50bdec
Suggestions as badges
View code
24e59fc160ce020320474b420d9da0d0c3bb9f758460959c8f9d78bfb12d145229e8ed0a9e71fad30ab884dd3d3fe1d3dd4140927bf09025c8f459c49065bad3c174f3bf726a04605840b6d8eedfd665d6766b25d99d8b116d80226412b2c5130b6ef85b0bd6c328d4f27d00dbbd2d9c9f86934255f59f0d1ec80f29050f1f4b0138be82df5687a8d56709ec55370e55ed0a618394a478140828f6af61d69e5e33d11ef8d3a2a707f5c1ccdf75ce357a6c533ce7cbb1c97e2a13e5c50839256dbc1fd525bd393feb036bc91664689f5dbbe50796b03a28632bdee093f7ad7196d6933722070708cecd1c15464e8343dbb6c81a6c68d874b4dc6b88d2d4757d974144067d05ef98bdcc979a7561bd30fa94260f6f5c26f378f7d2e5266d5bf40707405f3825061c07773eb692cd31ec4ab7d1f6a9ca4cd313a74537525ae00a67f1b56294ade83fffcc9c86d3d899cedcf652b59dc63028722441a3f98f2869742465016ab7852f1783e58c79439bc5eac7823f963a176d2a082097d88471f74d6e2956a3710ed9e0a7732bc1641359d777383fdd29404fa72697369cba693a96fbce15538268abcb57f702c6cce0ad940c934dc4accb572c18fa7475c4cf5eb32011fb279a7585250572b6bf615299ef86af9c2c65d4f4b12110fdfbfc8e8b1bc3bcd5be704b6b88eaa6aceb6ca75403be4acc89bb2f3fceea1fca6c259aebbee6eee210321af3b1c21c90789cf5c3bc5a2684e4e82a485d0d569f4f44f2b19de5964be99d0839a28cbbbbd319670e420a6f47d07b257811d0cfd2a567abbc52e98df8adf5f29f6f4fac428d560e5111fe0b398e7c2711b017a67384222acf80dede734872346a69f60192a551e707268b8d9d7dac9b5f2dcf00ae1126e10dd4dfacf61f6f1b50709a551945d061319656a2b90830ac40d46fee667d4fc4380de155e0bcf010354232fa740984902c7d462070789d30ab7044d4d1b933333dbabeb3414136dfa66934bb8a5c6ec30882904d1100856e113d73447c49f296974443ef2821fbfe32b405024cc8c4444e3fa33ed7355f91c944bb0448502d0c0e4fd04677a2018be78d9bdcbf618cc06b8463832b986d47de3939f6db94dfb5f7c0c56fc96045c0b25fcca4e0ef50547d5db432ece28a5a7aa0975e148d563a8875318d60bc7f27752dbfadf71886d125c535afb44866e0d4aabb76bd90bc4010014e0f9b748ac6be0e45df3057e68a63875dd5bb871097d3c17ffc9307bde4ec4eb24c39e69b6c86ccf6fc1e7da8586e65d652a43df6fda93e937d8f1b4c30f1aa032f18c67b001071e79235d6a560542e31dbf9f996091b3ac8219f51040d1a6457109f82db5833a3737708868234e6e4e89d6d876308fc54dac3f9d03c019515a7488ba9d87dd13c1c4c7e09a06f4c38702af04db01f8fcfc4e69516d4022fd1c7bfb62dba136b6df8511b0d152998706d92af9c35b93d2e073e3f69536a4a2e6056f0285f01d5c9b127e79d5860c322ae51e4f8dac9190456dbacd0f3123124ef89ce3c856bf07e82c1f65e2b21ad5c7d28dc4bcbe348e22a24217d5bbb6c84028d8d0fdf3a70454c500ae62acd89ba33cfbcad20998ac83c1600adf1c701fd14f70cb566f1d8ca3e9f8b92695ccffa76b923e7c0a4dedf560f006b3a66c9700506595dd16b606907ab7f62fb7ad5548b833f901b0e01a989a8a58f267465c702ca2886263e28220a1560da5e838b449181f5bc7c57caa7eaa6765177e052079080fd98810c20279601a4f6fe35a12e78add664170887853025e097828af30a2a09c0d189dd210bbc958d6e0ee76ce64fecdb785de3e14d6ffe4e57788452cdad240297c84f7abca3562110c3b7b11565f221acc0d137dd97d90d2f8da9857928916468d82fba8a05cdff54ddd1629672f29d7be4331945f74ec770b6b1d9b860bbd6477659600a8219503d835ea6d0

Search suggestions are designed for use with the search bar on the Home page, but can be used anywhere in the help center.

Search suggestions can be added to the Home page (home_page.hbs) using the Popular keywords theme setting in the Home page elements setting group.

  1. Select a style from the Popular keywords style dropdown list.
  2. Enter one or more keywords in a comma-separated list.

The search suggestions will then appear below the search bar in the hero element in the style selected.

To use a custom pattern, copy the <template> from your selected pattern into the bottom of the Footer (footer.hbs) template.

Search suggestions can be added to any page by copying-and-pasting the following hook into a page template:

{{~#isnt settings.popular_keywords_style 'none'}}
  {{~#if settings.popular_keywords}}
    <div id="popular-keywords">
      <script type="text/javascript">
        ready(function() {
          Util.renderTemplate(document.getElementById('popular-keywords'), 'popular-keywords', {
            keywords: '{{#if settings.use_translations}}{{dc settings.popular_keywords}}{{else}}{{settings.popular_keywords}}{{/if}}'
          });
        })
      </script>
    </div>
  {{/if~}}
{{/isnt~}}}

The search suggestions will appear in the position of the hook element on the page.

To use a custom pattern, copy the <template> from your selected pattern into the bottom of the Footer (footer.hbs) template.

If you select the Custom template style option, copy-and-paste your selected pattern template into the bottom of the Home page (home_page.hbs) or Footer (footer.hbs) templates.

Related patterns