Ricos Site Context API: Sample Flows

This article presents possible use cases and corresponding sample flows that you can support. It provides a useful starting point as you plan your implementation.

Let users link to a static page

A rich content editor can let users add a link to one of the site's pages, such as the home page or an about page. Store the page's path as the link target, so the link keeps working if the site's domain changes.

To let users link to a static page:

1. Call List Static Pages to retrieve the pages. While pagingMetadata.hasNext is true, call it again with paging.cursor set to pagingMetadata.cursors.next.
2. Show the title of each page. When the user picks one, store its path as the link target.
3. To show a preview of the link, use the url of the page.
4. If published is false, tell users that the links don't work for visitors until the site is published.

Let users link to a dynamic item page

A site with a collection, such as a list of team members in a Wix Data collection, has a dynamic page that generates one item page for each item. Users can link to a single item page.

To let users link to an item page:

1. Call List Dynamic Pages to retrieve the dynamic pages.
2. Show the dynamic pages whose hasItemPages is true. If published is false, item pages aren't available yet, so don't show them.
3. When the user picks a dynamic page, call List Dynamic Item Pages with its path as prefix and its id as pageId. While pagingMetadata.hasNext is true, call it again with paging.cursor set to pagingMetadata.cursors.next.
4. Show the title of each item page. When the user picks one, store its path as the link target.