Public API for the Favorites Widget.

Drag + Drop

When dragging - the follow data is available:

• "text/plain": "<favorite url>"
• "application/vnd.duckduckgo.bookmark-by-id": "<favorite id>"
• See this link for the actual value used in code: "New Tab Constants".DDG_MIME_TYPE

Favicons

There are three representations of a favicon: image source, letters, or fallback icon

• if the favicon image source is absent, or it fails to load (404), we'll then try to use 'letters'
• if the etldPlusOne field is null though, we won't use any letters, and we'll load a default globe icon instead

Requests:

favorites_getData

• "NewTab Messages".FavoritesGetDataRequest
• Used to fetch the initial data (during the first render)
• returns "NewTab Messages".FavoritesData

favorites_getConfig

• "NewTab Messages".FavoritesGetDataRequest
• Used to fetch the initial data (during the first render)
• returns "NewTab Messages".FavoritesConfig

Subscriptions:

favorites_onDataUpdate

• "NewTab Messages".FavoritesOnDataUpdateSubscription.
• The tracker/company data used in the feed.
• returns "NewTab Messages".FavoritesData

favorites_onConfigUpdate

• "NewTab Messages".FavoritesOnConfigUpdateSubscription.
• The widget config
• returns "NewTab Messages".FavoritesConfig

Notifications:

favorites_setConfig

• "NewTab Messages".FavoritesSetConfigNotification
• Sent when the user toggles the expansion of the favorites
• Sends "NewTab Messages".FavoritesConfig
• Example payload:

{
  "expansion": "collapsed"
}
Copy

favorites_move

• "NewTab Messages".FavoritesMoveNotification
• Sends "NewTab Messages".FavoritesMoveAction
• When you receive this message, apply the following
• Search your collection to find the object with the given id.
• Remove that object from its current position.
• Insert it into the new position specified by targetIndex.
• Example payload:

{
 "id": "abc",
 "targetIndex": 1
}
Copy

favorites_openContextMenu

• "NewTab Messages".FavoritesOpenContextMenuNotification
• Sends "NewTab Messages".FavoritesOpenContextMenuAction
• When you receive this message, show the context menu for the entity
• Example payload:

{
  "id": "abc"
}
Copy

favorites_open

• "NewTab Messages".FavoritesOpenNotification
• Sends "NewTab Messages".FavoritesOpenNotification
• When you receive this message, open the favorite in the given target
• Example payload:

{
   "id": "abc",
   "target": "same-tab"
}
Copy