Standard article navigation
Many help centers present a list of articles within the current section on the Article page. The Article Navigation extension can compliment this approach, giving visitors direct access to the previous and next article as defined by your content authors. This is perfect when your articles have some inherit ordering, as there’ll be no confusion as to what a visitor should read next.
Standard article navigation
View code d7f42199fb73592dbeef86677fa1455b051c621cee7060bea816b9832d74d1b106002f8ce1345aa02cb8a5d26a2d68ece3993f167e4f6f370c73a6fd48a66814adefa9b2247baa270d0607fa0ee6e983691c2cd761e2fc27c06f525d885965d582656a434390c7a73133ccb31cef77523d1fdda352bf7bcc434aab3bbe3de3b8b817f6a8967e26ee7b501ce11fac64bfaefa03e33b6dbb0af88d9ceb65548be45123b017cd479bd8aaabbf3f5b500da8a66fa79f0e883caa135c9a429a1bd209e10b2c89b0d3c030d2adc3142c68ed44282a1a6c0d4128d07d64effbeb04aa5fbeda80b11a948acd109c42799d9f5d16c4a6af41c202c65ade12628277ca2fbe3d998487d59907a217b2df08c3403cfa3cee6253389ba87a472bd72ab9239a65d3c3fb59dccc2b6a448dfc14a904559bbe30c640a300007c85f1b2de3009b81cd2733e49473075ae95dd2ccb2aaca50165571547cbc8106e6a73959791879cabba8823cc939677dd5b9a10e361759390ca38317dcae11d9092d0229ebf223b7164b413dc49cd5dd3d6b98690631f84e80f2cf6312aaa719d61d60ef57095d89a3bf10f2d0f9ff513f3c6aeafb915d9db2796435ca669d437b06739f18524e9c9dacfb650a0cc748f8929bfeaf32b3ab65a5a0fda34f702c27f24e41d9f2343bf6876a0f29b15bbd228d86734dd0c574153992c69269636b17f0d82f44c6e97e7025ce8f824cd7c50448b967a2da61a386220de16324e273f9b8aec8b9aec35ba38d85fe3aa5f462b6f353c4ecb4c4f10fbbb5639b096e5bc2c279c74f4d3618f65d9b4b2a28ff00326524ae17b6d4aea779ff2b47d17f4defaf4d5ab180828745b30e74fe6c8c0fef2a2acd54a8abc8c08416af036fdea03ed821fd81fdfd9e8fd9fc8e6f88594435d555c7f31163d1f9569cbb81ff28a0067f1bab3148c8244e20dbcae0837ed7caa3674c5e0796315fa85b8255c4a16be457451578bb92aeeb2605c4789d6bc6ca84fd7b9092ce3a7b203b90089fd8344efa2ed7cf60396d40255f2f9c4c05977bbd44b3bcfe73236d8ee124af5c9eebe7b1ead9f818451580c22b1846bb7f4ea9fdc5753c31cc1f159c0a95b881675c32e14e5d93097b243c813a589a5ad9577e05005ef5b69e56e4bb017bc29f5be3314be991abd6a5b800a959de981e91f860e2592cfc1c9d112d7ed01ef5daca7ea9e295244f212144a6d0fe0eb0cf2f28a9a2f93c99ebc31f5775c5a47f73ac69d807b6f4d907f4c089e9bc5216b054c184de627a34f82a4d8e28e99883915ed337574deefeb14761b88933cd672d2a7e1ecd5ab40bcdec294b020665f43c7b7108f879930e493784c61d65937316ec0ab9ca6684b749b435149211774c1180ca47c9c232c68a8f896dba7a1658adc91af2bac27485f1dcbe512b6a07ce33ae518a5f2f196c63bb432336e0e20d1181f46678e025bb32208713781a47fd3bebc2672622868195387a12da0bac90b020ba213d9c89589a7b0943a37ec5f7f8ab5baf061accd1ae968a2caa79f390cd3bde540ba472a324e51cb81d799057c35892dc1625e1ab3c89df671f3346839f705f5fec14bc0d1a2fda3099892802f4b2428baf46a994cc8e20fd30683b8b685293a19d48083d662c819d58347a98bab18bc04961bbfd7c330e5299c752ffd129c275d3ef85bab02f29e87f946190911fc3411be7095c154f86dde2fd00f1fe2cdd54293be074ac06233d08e5cdeaf4e2ca4bdc776a162dddf3f961909c9dcd02a433bb910eb764e26797397cb5ec0675ed75009c5b962b2bfed7e272912608e9164ead1567a873cddafea53a2099df45304cc47883f3e6122f252e495bc193ab3ddf01f2ade4b3d3011652d74d7f5422bb07e2401350b5848dd942916ffaf8c481021b78242b8a8cfdfb603569638f130ceaa83de9e771b459a81aabf1aab1a7e6dfe966688948ae46abdb8e97c9f7f6b0a05390c252a3150ae4dd5b453dab92e8cdc5bf83c411459a01bee044fcadabfb73940e7b10b73b17ebf1bbcb56374745616abf3dede136fb33d2befadec40c5c6254b33dfada6e7f2805b2e6ab65bd06fad7c3743afc5a2bce05617a991b9b3f7cb5b1dfe1dbbcf45d720b9efbf017cf93d8c5f232e242841c1fb05801114ed9ed2ee643a9436d1eb30669e4e5b6bdf4a501c5b2f1cddcdf782cdb3ca5c5ab0665f88997adf60e26578026930a3eb91bc9d1e6060f89105619073daffd216525b42c762ca0b794202
The links will inherit the overall style of the theme as defined in your theme settings. Additional control is provided through extension options and you can even create your own fully custom templates. Using custom templates, previous and next article links can be presented as simple buttons or include information from the articles themselves, like titles and excerpts.
Custom article navigation
Because the layout and appearance of the links themselves can be fully customized using templates, you can tailor them to your specific use-case.
Next article link with summary information
View code f43e60e4b624cba2bdb34e664952238ad66cbcbe711d078ffa6db14d59626f81276c14723468eeca0a18a86563b57034dddec0eaa0c24bbe81ed2d9513ac77ce93e13b8e2a4f542c73073f7e226272cf10f61134084ef8f44afd822bb0be353cbcc1dbbb793a895473b40ca7e6526d3c8fabb22fbe0b8292cba0fa3fbc5f311b1bc4dd6c749c682c36f3d763ee10b2391a78e39f7effe93df15ff6a427a6b37c96bb3f9df5a57d2bf9840afe7af26b197ae9b9e3e7fbf58d36e434e1579e719f4b58749cc2dd9b7033bdaccea1a22546fc0a419f6bf3564c85b7a2c671883ce40c5a31e7768d056371d47d8dcb01a50dcb0ef8e8c6a47f273beba4c7f0f7e1fd05456520fe1c9b0e3c2ed14885e5df7e70c490282e71b5408d6d89949b89e484ca4c07afc106264eb4fa71233bdeaaf9f40cfb67dad471c93ffef540c8dd22d6238f6de2695fc76856325f09a8aeb48876a99ce3238ce828ede0ed7c270c1349a6eace6b92b93e6894aa235472b3e2dca2ef2da5dcaffbc2db51241ee2a35a400de841a96c0a0901059bb32d9259478a5a4596dbbaf71c85c9a57ff7f77bfe7ba9d7a3891b5fb08ad2408e75d60bd84e4b50863660411461114e6a4657ec73f2b44930edffcddc3334ad85704b7dbd26f0d1d68ecd617ab93e0f4958c2cccfa3e8fbdf3cbaf729c6f47f53b7811f90ecd39d5048d4198981db6eae09525ef8ca51b61bd2668e92a5cd6fb717e3308be30465a7f440b9bf82f481244434329d8d8901354ca1350d32bfdcaeee81bf9eb1233c112fb181e7aa140def16c135a4a2a51bce2f9a1e67ba377f0d80c17a5e993b4f8ef62c2537b92d39619237a559ad7a77434960c1b067896f6b0352887cd0adbb4a961b9aedef5a26520d4f9f1d46ecd730b88393d10c3382a64e3a5b10161b0fff72f46d1a7277dff71e25b57726007612f5f4fb0c00a74a37d848538565242bc511c247a891d127d43548042ceb71b2b0ec68e998d473ba59e7d69991b87bed9a6dcfe33386cd2216057f68d604ab2a24ff81696e3f8669565dea30fada1ae27e076bf306ee6dab822bd93b6e2b0eb35b011187af56ea065bdb56dff09e68c49d22f9da7f684ff63308af0a21e2d817c36c954c0ca99f6ad78aa2372272213aa482b48d4ab03bafbb9ff2d6e882d8fffb9776a93eae7189582961d23243f953f4a36d07f5675124fb888437806ae5d80ef25e6c2bcb62c183c3659648c2a707b7ea4b0c2ee97f5f31338a65eadecbee602004c41bd70d7f6a0c26b5eaa326f18db2f8cd9e28a4763abd826b950e839eafb7b25f467b15be5f52b2f4446a3ddc483096cef21ed5e87a5d0e0a32e3cf9b4943da7d671363770fe0e7dfa27350e3cde52cd5364c66e8e2414f53033e69da87fc0ab129853540a3f17d492b6657c90572322b5408a40bb2c81652344c9a894ac1363082427851c861527119270f4d9c14f1aee3820dbb87d929c1cb5ff7d262ace9783e373c616af4e99b4489975f5bacfa6a6792322ba4e76836734843c8f137b8eeebcc9c0b179e12fb75f07895ced7ffec5471c8c431d969797db2716567c3f7491d6f8db1c2e871675fda3f7f3484f0e7fdcb4022506974b36ea30a1db0f2129823e400dea47fbf700d9810388abe3c799a21bcc535ccf32a4dd1a962b051db70468de69073f7ee2e7e1f31c9a4d7793354dcc875ada0356690bc0eef67a31bc6b5a4fd4053c89e6fdbca7caeb305935e94d55ba9949d5c2e52615cbc78dfd4b58fa7bd07f2ef787920a1bc3d9d505bb5a4fa999c28a4388dca1fe5b80f70eb3457fbae3d1b1fc405176ee47da54df5e3c09975f1c8476295f0e48937f455823e00cb5867bf5f752d5f7e575503c410ecfa6e6e5229e5e341dac1696eb0eb5b9adf57c4b338e282c7955fdbb849cf4a90b49d0856e87fa2dbe9a40fd8d1ad7176ccec8d08b6341a3f9115a9535a3866c25799dc7734a53adf6e594d4fb083a2bad8680e962d15199699f2973e916981d461e7316555392afefa02ed857d8c42813e0e1ccf89bd354868a36c472f191d4a67bd32c2d3f664e992d9289ac913b3ae21efb06d11843752208b16fa2f5d44d790016a61a296ea911e3dec2224fe66fc685470e0195dc7752799aedcc923c3d9792138137b05da1e514e3cd25257644fd2e7893b562108b3103d6dc29d6b24a01e075479280a20c256428dd8f50d57d2a5f093cf6a955a344005e56e9f447fc74186f782d47cd809e54d64a5c36ee9851402fb24a7eb9cad8f972c15a98cc19fe8c7439318d2bf548b6148aef6cbfe60afaee0092d10204537bcf6d06749b22cb3292d42e76b8a55007b64b7e415084e5caf8c3fc1aa20cc7e8e364231c7505e78d92d2c8ee0a13bb948fca2118bfc311aaf951767f86a5085af5e5d086776b7a7a607182538084f0415c2b12e849280e10669f03bbe5ce982cba782bcc43f2b7f0a5e496ff33622f1d51d96ec7f7ef7d4390e7ac570099bdb4fb50aa3d88069e3f5f4ce591925fb64d7d92c8f0854d90366735af6550ee5ee2214f4496475beb92791dcdf7b46bc8cf4bd3544678e123ab1068f5fdf2cc352a28308e82b25bed65a68b98d7848ca27c47c6fb0d9f9b3b5d0e96fb5313954132159313b59f0857544929e95376210e80bf25af0f45ae627cdc01a766508852f44719d7779fb62763f3c0b9de921031f65bb348b5830da69923d391734939b447279312403e65bdb36f01da317ed62399e70c3a4ae7962c1f1b6cc2a13f08ff5c51c4da6d32e30969ca4eccd890b75b39c783ffad0cab5875a5abb36234a056dd7d5a90deafec1b46cbf0dcf36f0f1269b363a88474396b96c87b5223366b7504786836e9bd88035008b7201b25049a5598321546ea9a95d6b1b8a6b5e4acdaa9d9a43e72db82cb906abc870b1641ecc498ae5dbe1a75071b303e50e572f4aab88cdb8a6e9dfdc81fda294aba188f585bf551e316b623ed12df202d1b9c2032dab25c3aaa927028a98b81edb6f6aa29a54fb2891d1f88348ae0dce6553630b87b1f6bfdc9589b3b47ff5c1f051a001508ca952de1ed06d2ed3f55b9e61b3cf4160a62c04ef7d5d846a7cb6798554afb3d9850474a9fa39fb14b835426fbd32f2e1bb248060555d25ef60c7301a842a64258e5b2db012bcbc49a65cdff951345eeb51de9ead76c77e9b57257e70921a0fabcceab8c5d929cdc63e77422f676a5586f8f8b453c5475b5d6c968cc5a1ee7f6c78f9064d7bb88aa5172ea363ea1e974e0c8202cd090e95c0c602ec9ae3af65e1a091bd8f5a3775118dfa2548a5e848158cf3f8a3a82ccf1020d43c2fc04aa872fe24bed139704979d0647606771a70b472393d00812914d389f2da2dccef76bad7cd94c49c0f095c4727a79e117ef257be7e7d467c5962f7788772cb6fcff089ebe3fcad3a33ca33409e6a8502d55f1c2950be15a9ebd3e48ec23a2017662d136c303d1956f7ca180381fb9c2a42a0b25bc4dfb9a831630a0cdf964c4cb77c7616c4e5954b3e0da3f358a8e9b8a65b94160c87da98aa77cd9fa55d1fe4935f342ce103bb164284f5b05c3771fcdb01c6b190f8983eecff7828d12d70e197368970033cdd589b2a8709cc58d57c8c3c854e98defbf9370827fff99274cae5cff302b2cd5a2ae6c03de609f5b7341ab69e53ab57ae57aa8a6579a90c6b39fceff69649add18470c65a17b6b8131e7f2683801a1c695257ed12c480de53328a06ef457351c3dba2efe9cfc35264a3226c2645c07807913a07c45e99c9f9b0c117a0b13421951f36e9db575ad597dd849f4b9efe5049dcfadacf95322052bd288bfcfbab552985029aa9c17a5aa2f26b4bbcd0006af123e4b37b3b81d6325edceb089bfea955b1ca3ff8b5a9c124e60a131fa64e64ec254667cf315a9b0ada2dfaf3005a0bcf3b1c93d686fb4dcb145ed36430db3966aad5170772cc2049da76345fa723dc7a0b73f5018b8c7d460dc514d3351389df98f0a4fb3cbc5b5d84fcdeb3e0eba4c636fca75c29d08dfb01ae19e5d710efd10dcb2f1d2d13a0d85bd8d39b2d91715b14f0307e3c73a3419ca3ba4926c077c3c3394db484016d25898cea0e85318e9a169a7186989549083b95c7390e575127315a097fcb58c15b04f33bbcfa983a4e1c1abbab22b10f960ad10736af49b8ecad0357effcd2b0c3ae54ded1e988c2cba849484539f67fff580cb46a15db625e1adeb23adfe52c6c75871d00fb8a190c22f76266a1f83f72d81ae1850aaa4f193403ef9631db982f4e16c7eff7ea3601836bad346aff48201079bfb94b50f6d828b54a44811c24d69b3daddadf86419d759bbcc582e0e90c8aa3f6b835a7a1c784d2241e550b8f53dab9dca586ac10a25c29f6d6491e9e9d74337acb243c515c8e1d33a6f41a45797e2751565eddd96574fbc7546cfd957e7d3ab6bb0f632cb200f981b708d49dea639bd4538e73b651db445dc84a673d15475578c75ddab30dbcec693a7a562fdd1f2e02a5e9951928c101b38d54b4a3e54a1bdb6d0f8f07a7689611d3931c8bac4767db7d5469bfe91daca7cdce363b91884324d69c38a6c25cd18601ab18756bd6946a674fa232ddb8c289891cdfcf94e56018870d431b3de8bfc2463cf0de072d0c8df3a0de179ee29aa34caf15b127d9aed53791cc23f435ce3ff991745bde05085999d6f630d2f6510e36ff6515f93812dcf5bd66ebe670e9675d50d9778daa6ab2531b48e1bedff07cf5941a0d1f6bae7eb87e14b8b107210862c7164a05f35fb537eaba60caf3efb232824054ceb6e045bdf4d0a8cf6454fb47870a29b77111e70b2b88811726f5a02e05ebd52d5a7d6ced57484389077db24200dfed430dd409bc0302e102135b00a6072f38d26a6afd42e88224726731929ec625097d1018863bdf6d006a181a3e24e8c71b0f2530ac04c6636829e453732b56f9de91b5150c098475a83a8d6d3a962218fd092f1fe37fb8698036c7386f0b21282b44e2b52b988a80d4407988be9dea4efe17976d9a2e70073f6146ba9db9704fc2f6d6c4af9efeeec762ba38dcf620c55c645e5fe05bc49e466e38053097d324a93d4114634f9e9f1608a0354e42860ccb8937a2a31d3fc2d87c6b04f0d666fcaab98d36665b3eb4a72df93054d7543ea59f2df0b3146580bd7e6ee8eb39eb0b32003f0afae7
For more examples, take a look at our Article Navigation patterns.
Creating article navigation links
Our themes allow you to add article navigation links to article pages using the Article navigation setting in the Article page elements setting group. Once a style other than None has been selected, the article navigation links will appear below your article content.
The Article Navigation extension is bundled into all of our themes by default, so you can start using it straight away. You can find the source code for the extension within the extensions.(min.)js file in the theme’s Assets folder.
Use data-element="article-navigation" on an element to create a dynamic article navigation element:
<div data-element="article-navigation" data-article-id="{{article.id}}"></div>
If used outside of the Article page, you must provide an article ID using the data-article-id attribute.
If data attributes are used you will need to ensure that the allow unsafe HTML setting is enabled within Zendesk Guide.
The Article Navigation extension can be instantiated against a element using JavaScript:
<div id="article-navigation"></div>
<script type="text/javascript">
document.addEventListener('DOMContentLoaded', () => {
new ArticleNavigation(document.getElementById('article-navigation'), {
articleId: {{article.id}},
// Options go here
});
});
</script>
Options
| Name | Type | Default | Description |
|---|---|---|---|
| articleId | stringnumbernull | null | The ID of the current article. |
| labels | array | [] | The label(s) to filter articles by. |
| properties | array | See below | The object properties from the REST API response to pass to the templating function. |
| template | stringnull | null | The name of the template to use. |
| templateData | object | {} | Additional data to expose to the templating function. |
The following article properties are passed to the templating function by default:
idtitlehtml_urlpositionpromoteddraft
The following section and category properties are required by the extension to sort the collection of articles:
section_idcategory_id
Events
| Class | Properties |
|---|---|
articleNavigation:render | Fires when the article list has been rendered. |
