Kontent.ai
Copyright © 2023 Kontent.ai. All rights reserved.
  • Web
  • Privacy policy
  • Cookies policy
  • Consent settings
  • Security
  • GDPR
  • Documentation
  • API reference
  • Product updates
Kontent.ai Learn
  • Plan
  • Set up
  • Model
  • Develop
  • Create

Resolve rich text content

Is this page helpful?
Complete and continue
  • Sign in
    • JavaScript
      JavaScript
    • TypeScript
      TypeScript
    • .NET
      .NET
    • Java
      Java
    • PHP
      PHP
    • Ruby
      Ruby
    Martina Farkasova
    34 minutes
    Apart from structured and formatted text, rich text elements can also contain references to content components and content items, and links to content items.Let’s see how to deal with these references so your rich text is displayed correctly.

    How structured rich text helps you

    One of the benefits of using an API-first CMS like Kontent.ai is that you’re able to clearly structure your content so it can be used in any channel. But you don’t want to be restricted to needing to know exactly what content will be included ahead of time. Structure is great, but your content creators want the freedom to add various amounts of various kinds of content. For this, you can add structure to your rich text with content components and linked items. The major difference between content components and linked items is that components exist only inside a single content item, while linked items can be reused across your project. You can read more about when to use components and when linked items. With Kontent.ai, you can link content items together in two ways:
    1. Using a linked items element – here, you can limit the items, including what types can be included and how many. Read how to retrieve linked content items.
    2. In a rich text element – here, your items are included within the text, which requires additional work from your app to render them. This way is covered here.
    This article will look at how to add structure to your rich text through examples of components. For your rich text, the principle is the same for components and linked items. The items and components can be distinguished in the JSON response, but it's not necessary for these purposes. There are two ways to implement the structure on your front end:
    1. Defining resolvers for content types that might appear in the rich text.
    2. Using templates or specific views for structured blocks.
    With most technologies, you can choose whether to take a global approach with resolvers or iterate over blocks, such as by making use of design templates for blocks within your app. Choosing to use a structured model can help ensure you don’t need to know what type of content is being added to your rich text, as your hierarchy will be created automatically.

    Resolve items and components in rich text

    This example shows how to resolve embedded content in articles. The tweets can be inserted either as components or content items. You can use this approach for any other type of structured content in your rich text elements. If you don’t adjust your application, any content item or component inserted in rich text elements resolves to an empty object reference, which won’t be rendered on the page.
    For the final HTML, you could also work with embedded tweets, such as by calling the Twitter API.

    Resolve hyperlinks to content items

    This example will show you how to resolve links to content item used within the body of articles. Without adjusting your application, any link in a rich text element that points to a content item will contain an empty value. Let’s see how to resolve such links correctly.
    The URL to a content item linked in the rich text element is now correctly resolved.
    What's next?
    Resolve linked content
    When your content creators build pages by linking content items together, your app needs to know how to get all these individual items and resolve them.
    • Develop with Kontent.ai
    • Hello World
    • Hello Web Spotlight
    • Run a sample app
    • Build apps
    • Decide navigation and URLs
    • Environments
    • Get Developer Certification
    • HTML
    • HTML
    <object type="application/kenticocloud" data-type="item" data-codename="my_tweet"></object>
    <p>The used coffee grounds are retained in the filter, while the <a href="/articles/which-brewing-fits-you" data-item-id="65832c4e-8e9c-445f-a001-b9528d13dac8">brewed coffee</a> is collected in a vessel such as a carafe or pot.</p>
    • Generate models
    • Resolve rich text
    • Resolve linked content
    • Build your first app

    1. Implement a tweet resolver

    To ensure your tweet is resolved exactly as you’d like it, create a Tweet resolver for rich text elements.

    2. Register the resolver

    Register the resolver to ensure it’s used.

    3. Retrieve the rich text

    Now that your app knows how to resolve strings that contain tweets in them, the tweet will be included in the body.

    1. Define a model

    If you’re using strongly typed models, add a model for each type of content item you want to link within rich text.

    2. Implement a resolver

    To ensure your links are resolved correctly, you need to implement a resolver with two methods:
    • The first method will return the URL of an available item.
    • The second method will return a 404 Not found error when the linked item is not available.
    A content item is unavailable when deleted or, in the case of live environments, unpublished.
    When building the resolver logic, you can use the link parameter to get more information about the linked content items.

    3. Register the resolver

    You’ll need to register the resolver to ensure its use.

    4. Retrieve the article

    Now that your app knows how to resolve links, it’s enough to simply retrieve an article, and the links will be included inside the body.
  • How structured rich text helps you
  • Resolve items and components in rich text
  • Resolve hyperlinks to content items
    • Ruby
    • Ruby
    • Ruby
    • Ruby
    • Ruby
    • Ruby
    # Tip: Find more about Ruby SDKs at https://kontent.ai/learn/ruby
require 'delivery-sdk-ruby'

item_resolver = Kontent::Ai::Delivery::Resolvers::InlineContentItemResolver.new(lambda do |item|
  if item.system.type.eql? 'tweet'
    return "<blockquote class=\"twitter-tweet\" data-lang=\"en\" data-theme=\"#{item.elements.theme.value[0].codename}\">"\
    "<a href=\"#{item.elements.tweet_link.value}\"></a>"\
    '</blockquote>'
  end
end)
    # 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: '<YOUR_PROJECT_ID>',
               inline_content_item_resolver: item_resolver
    # Tip: Find more about Ruby SDKs at https://kontent.ai/learn/ruby
require 'delivery-sdk-ruby'

delivery_client.item('my_article').execute do |response|
  item = response.item
  text = item.get_string('body')
  puts text
end
    # Tip: Find more about Ruby SDKs at https://kontent.ai/learn/ruby
require 'delivery-sdk-ruby'

link_resolver = Kontent::Ai::Delivery::Resolvers::ContentLinkResolver.new(lambda do |link|
        # Link is available
        return "/articles/#{link.url_slug}" if link.type.eql? 'article'
      end, lambda do |id|
        # Link is broken
        return "/notfound?id=#{id}"
      end)
    # 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: '<YOUR_PROJECT_ID>',
               content_link_url_resolver: link_resolver
    # Tip: Find more about Ruby SDKs at https://kontent.ai/learn/ruby
require 'delivery-sdk-ruby'

delivery_client.item('my_article').execute do |response|
  item = response.item
  text = item.get_string('body')
  puts text
end