Choose your navigation approach

Navigation is composed of content items based on a content type dedicated to navigation. Define the relationships in the navigation using a subpages element if you use Web Spotlight or with a linked items element in other cases. When modeling the navigation, decide whether to bind content to the navigation or keep them separate. This way, items that you link in the subpages or linked items element also hold the content. While this approach is more straightforward for understanding the concept, it isn’t suitable for omnichannel delivery. That’s why it’s more suitable for smaller projects or projects that use one way of navigation for all channels. If you separate navigation from content, you’re creating two items for content linked from your navigation. The first is for the content itself; the second is for a navigation item that links the first one.

This way is better for larger projects prepared for omnichannel content.

Create a new content type and add elements needed for your channel. In the code examples below, this type is called the Navigation item. It typically contains:

A text element for the title of the navigation item (Title in the code sample)
A subpages or linked items element for child menu items (Subitems)
A linked items element for the content itself
A URL slug element if you’re building website navigation (URL)

2. Define your root

You need to define where your navigation begins. While websites typically have a homepage, other structures may have a root or main screen. You can use the content type created for navigation for the root navigation item or create a different content type for this purpose. Websites usually benefit from having a separate content type for their homepage. That’s because homepages have a unique appearance and contain a different layout and content than other pages. The code example below uses the navigation item for the homepage, created with the name Root navigation item. Create content items using the created navigation content type and link them with the subpages or linked item element.

When finished, publish the root together with all its linked items. Developers now need to request the items via the Delivery API to generate your menu. Specify the depth parameter to retrieve more than one level of subpages or linked items if you want to show all navigation with one API call.

Using the retrieved data, display the navigation as you prefer. It can be your sections in a mobile app or smartwatch, or it can be a menu on a website like this:

The content of the linked items is inside the modular_content property of the response. And that’s it! You now have a dynamic menu that your content creators can manage entirely from Kontent.ai.

# Tip: Find more about Ruby SDKs at https://kontent.ai/learn/ruby
require 'delivery-sdk-ruby'

delivery_client = Kontent::Ai::Delivery::DeliveryClient.new project_id: '8d20758c-d74c-4f59-ae04-ee928c0816b7'
# Gets navigation items and their linked items
delivery_client.item('root_navigation_item')
               .depth(5)
               .execute do |response|
                 item = response.item
               end

# Gets specific elements of all articles
delivery_client.items('system.type'.eq('article'))
               .elements(%w[title url])
               .execute do |response|
                 items = response.items
               end

Choose your navigation approach

Choose a suitable navigation approach

Navigation bound to content

Navigation separate from content

Build your navigation

1. Create a content type for navigation items

2. Define your root

3. Create your navigation items

4. Retrieve your navigation items

5. Display navigation

Choose your navigation approach