Skip to content

Changelog#

Links in these release notes go to the current guides, which describe the latest version.

11.0.1 - 2026.09.30#

Bug Fixes#

  • A Story opened from a row sends openedStory as it opens. Since 10.13.13, the event could arrive only when the player closed, or not at all. The first openedPage after a row tap reports storyListTap again.

11.0.0 - 2026.09.25#

Version 11.0.0 changes where the SDK keeps viewing history, how the script build loads its code, and how the npm package declares its files and dependencies. Read Migrate from version 10 to 11 before you update.

Breaking Changes#

  • Viewing history now comes from Storyteller. With the default privacy options, initialize loads the user's read Pages, Clip likes and views, and Poll and Quiz answers, and waits for them. History for an externalId follows the user across browsers and devices. Read state that 10.13 recorded carries over with the default privacy options. See Remote viewing store.
  • initialize rejects with InvalidApiKeyError, NetworkError, or NetworkTimeoutError when the viewing-history request fails. No sdkInitialized event is sent in that case. See Handle initialization errors.
  • The SDK calls a new viewing-history endpoint, and Clips requests use a new path and send a new request header. If a proxy or allowlist sits in front of the Storyteller API, allow them. See the migration guide.
  • Renamed the local storage keys for viewing history. Storyteller.likes, Storyteller.viewedClips, Storyteller.pollAnswers, Storyteller.triviaQuizAnswers, and Storyteller.readPages replace Storyteller.clipLikes, Storyteller.clipsViewed, Storyteller.pollAnswerMap, Storyteller.quizAnswerMap, and Storyteller.storiesReadMap. The SDK does not read or remove the earlier keys. With enableRemoteViewingStore: false, history saved by 10.13 does not carry over. See local storage items.
  • The script build loads Story player, Clips player, Poll, Quiz, and caption code as separate files from the directory that served storyteller.min.js. If you host the SDK files yourself, deploy every file in the version's dist directory and keep the file names. Your Content Security Policy must allow scripts from that directory. See Host the SDK files.
  • The npm package declares @types/react (>=17 <20) and @types/react-router-dom (^5.1.7) as peer dependencies, because its TypeScript declarations import them. npm 7 and later installs them. See TypeScript declarations.
  • The npm package adds import and require entry points and publishes its declarations at dist/index.npm.d.ts. It no longer ships index.js, types/*.d.ts, or SDK source files. Import only the package root and dist/storyteller.min.css.
  • The SDK no longer installs the reflect-metadata polyfill on the page's global Reflect object. If your code uses Reflect.getMetadata, import reflect-metadata in your application.
  • ActivityType has a new sdkInitialized member. Update exhaustive switch statements over ActivityType.
  • Story has new pinnedChipText and customLiveChipText properties for custom chip text. Update typed test data.
  • Removed the undocumented QuizRenderer.clearQuizData() method.

New Features#

  • Added destroy() to every view. Call it before your application removes or replaces the view's container.
  • Added the sdkInitialized activity event. onUserActivityOccurred receives it when enableUserActivityTracking is on. initializationSucceeded is true when Settings load and false when the Settings request fails. Other startup failures reject initialize without this event.
  • When the Stories API uses started-aware ordering, rows and grids show Stories the user has not opened, then Stories in progress, then finished Stories. Pinned and Live Stories keep their priority.
  • Clips rows, grids, and players that show a Collection load more Clips as the user reaches the last loaded Clip, including inside a Category. onDataLoadComplete reports only the first page.
  • Story tiles show custom Live and pinned chip text from Story content.
  • The liveChip theme for round and rectangular tiles adds unreadBackgroundGradient, readBorderColor, and unreadBorderColor. See Story tile chips.
  • The Clips player shows a Clip's long description when it has one. Users can expand the title, description, and Categories, and scroll them when they are long.
  • The remote Clips player theme can turn on compact Clip action buttons. If your remote theme already sets clipsActionButtonCompactSize, the buttons change when you update.
  • The remote Clips player theme can hide like and share counts with showLikeCount and showShareCount. If your remote theme already sets them, the counts change when you update.
  • Every Story, Poll, Quiz, and Story ad activity event now includes categoryDetails. Clip events already included it, and Clip ad events have no Category fields. See the Story, Poll, Quiz, and Ad events.

Performance#

  • The script-tag (CDN) build downloads less code up front. The main script is about 77 KB gzip, down from about 197 KB in 10.13.17. The script that runs inside each Story is about 34 KB, down from about 191 KB.
  • The script build downloads Story player, Clips player, Poll, Quiz, and caption code the first time a page needs it. A Stories view also starts a low-priority download of the AMP player script before the first Story opens. See version 11 behavior.
  • The npm package still includes all SDK code in one JavaScript file. Your bundler decides what your users download and when.
  • initialize calls with the same API key and externalId, made while an earlier call is still running, share its startup work.
  • Story and Clips views avoid repeated layout and lookup work.
  • The SDK is compiled to ES2020. Supported browsers are unchanged from 10.13.

Improvements#

  • Updated the default AMP runtime, which renders Stories, to 20260925.1. The Story ad, Story swipe, and next Story button fixes below come from this update.
  • Poll and Quiz answers can show two lines. Longer answers are clipped.
  • Each wrapped line of a Clip or Story caption has its own background. Captions align to the start of the line, including on right-to-left pages.
  • Clip captions appear after the Clip starts playing.
  • The Story CC control appears only on video Pages, and it moves above a call-to-action that overlaps it.
  • A caption theme field set for a feed now overrides only that field of the tenant caption theme. Before, a feed caption theme replaced the tenant theme as a whole.
  • Caption defaults changed to 16 px text, the font's natural line height, and a #171A25 background. In 10.13 they were 18 px text, a 22 px line height, and a #000000 background.
  • Stories that have no Pages are no longer shown.

Bug Fixes#

  • If a user pauses a Story and then answers its Poll or Quiz, the Story resumes and the pause button updates.
  • When playAllStories is off, the Story player moves from read pinned or Live Stories to the next unread Story instead of closing.
  • When the player refreshes an open Story, the Story keeps its pinned or Live position.
  • On desktop, the next Story button is no longer disabled on the last pinned or Live Story when the player continues to another Story.
  • Forward navigation stays available when a user returns to a Story they finished earlier in the same player session.
  • Browser Back and Forward move between the Pages of an open Story.
  • Going back to an earlier Story shows the Story ad from that point again.
  • Going back through a Page Ad returns to the Page before the ad.
  • An ad after the last Page of the last pinned Story no longer loops. The next tap or swipe moves on or closes the player.
  • Swiping between Stories no longer gets stuck where read Stories meet unread Stories.
  • Clips ad frequency and the first ad position reset when a user closes and reopens the Clips player.
  • Clips ads keep appearing after a user changes swipe direction.
  • Users can swipe, drag, or scroll from a Clips image ad to the next or previous Clip.
  • On desktop, a loaded Clips ad in the preview no longer turns into a Clip, and an ad that has not loaded is skipped before the preview shows it.
  • In Safari, the Clips player background no longer flashes black between Clips.
  • In Safari, a paused Clip shows its image instead of a black frame.
  • On macOS, switching to another window no longer briefly plays the Clip.
  • In a short looping Clips feed, the Clip on screen plays. Keyboard and screen reader users reach only that Clip's controls.
  • Escape closes only the visible Story player. In Safari, closing Stories repeatedly no longer raises a history.replaceState error.
  • Activity requests sent while the SDK saves the user ID now include externalId.
  • A Quiz completion is recorded when the score is zero.
  • Repeated taps record a Poll or Quiz answer once.
  • StorytellerEmbeddedClipsPlayerView no longer locks page scrolling when it first renders.

Documentation#

10.13.18 - 2026.09.30#

Bug Fixes#

  • A Story opened from a row sends openedStory as it opens. Since 10.13.13, the event could arrive only when the player closed, or not at all. The first openedPage after a row tap reports storyListTap again.

10.13.17 - 2026.09.23#

New Features#

  • Added configuration.context to the onUserActivityOccurred callback data. The selected view supplies the context when views share a player and when an SDK action opens related content. Context changes apply while a view remains mounted. The value stays outside Storyteller activity API requests.

10.13.16 - 2026.09.15#

New Features#

  • Added getStoriesCount and getClipsCount methods to the shared SDK instance. Integrations can check for content before they create an optional list view.

Improvements#

  • Row images now receive their source when they approach the horizontal viewport. Story players keep every AMP Story entry and create a poster image only for the active Story.

10.13.15 - 2026.09.10#

Bug Fixes#

  • Fixed Stories skipping their first page right after a swipe to the next Story. The background Story refresh introduced in 10.13.13 hot-swapped playerStories, which restarted the player and re-showed the active Story on its read-state initial page (the page after the one on screen). The same re-run also switched the swiped-to Story to single-Story playback mode, reset its view start time, and registered a duplicate read-state listener on every refresh. Story switches now leave the running player alone and a refreshed Story only re-shows when its active page no longer exists.

10.13.14 - 2026.09.10#

Bug Fixes#

  • Updated the default AMP runtime to 20260910.1, which keeps Story video-ad audio controls available when the ad capability signal and media setup complete in either order.

10.13.13 - 2026.08.24#

New Features#

  • Added closed captions for Clips and Stories when the matching captions feature flag is enabled. The SDK supports WebVTT cues, a saved caption preference, caption theme settings, toggle analytics, and safe caption controls for Story media pages.

Bug Fixes#

  • Included the internal declaration files required by the published TypeScript definitions.

10.13.12 - 2026.08.19#

Bug Fixes#

  • Contained rejected activity-tracking requests inside the SDK so blocked or failed best-effort activity delivery does not reach host applications as an unhandled Promise rejection. Story navigation and existing activity callbacks continue unchanged.

10.13.11 - 2026.08.17#

Bug Fixes#

  • Updated the default AMP runtime to 20260817.1, fixing captions-state synchronization and quiz result-page enablement during AMP page initialization while preserving useful errors for invalid page references.

10.13.10 - 2026.08.07#

New Features#

  • Added instructions.iconHighlightColor and instructions.iconColor theme properties for independently styling the highlight and foreground colours of built-in Story instruction icons. iconHighlightColor falls back to colors.primary, while iconColor falls back to the effective instructions.headingColor. Existing custom instructions.icons URL overrides remain unchanged, so colour-only branding does not require custom icon assets.

10.13.9 - 2026.07.29#

Bug Fixes#

  • Fixed Story Page API host resolution so URL- and storage-provided customInstanceHost values cannot control iframe requests. Story Pages now use trusted server metadata when present and otherwise retain the existing environment-based API defaults.

10.13.8 - 2026.07.09#

New Features#

10.13.7 - 2026.06.26#

New Features#

Improvements#

  • Updated the default AMP runtime to 20260626.1.

10.13.6 - 2026.06.02#

New Features#

Bug Fixes#

  • Fixed recordActivity payloads so activity externalId is still included when personalization tracking is disabled.

10.13.5 - 2026.05.18#

Bug Fixes#

  • Fixed Clips video ad playback state so user-paused ads stay paused after CTA taps, mute changes, browser tab lifecycle changes, and ad completion events.
  • Fixed iOS Safari GAM clip video ads so they start muted when needed for autoplay, resume cleanly after clip navigation, and keep poster surfaces visible instead of showing a black frame.
  • Fixed GAM SafeFrame video ads so poster fallbacks remain visible until a video frame is painted, looped video ads initialize correctly, and paused ads are not resumed by mute changes.
  • Reapplied the Web SDK GAM category targeting fix so SDK-provided category KVPs are passed as arrays, preventing double-encoded comma separators in AMP DoubleClick requests.
  • Fixed production AMP URL resolution for the hotfix path and updated the default AMP runtime to 20260518.1.

10.13.4 - 2026.04.30#

Bug Fixes#

  • Fixed the npm package artifact so package-root imports expose the expected SDK exports and the packaged CSS file is included.

10.13.3 - 2026.04.29#

Bug Fixes#

  • Fixed Web SDK GAM category targeting values so SDK-provided category KVPs are passed as arrays, preventing double-encoded comma separators in AMP DoubleClick requests.
  • Updated the default AMP runtime to 20260428.1 to include story audio and story ad playback fixes.
  • Fixed Story player start/close handling so visible players can reassert playback and unmute state during story navigation without resetting the active player.

10.13.2 - 2025.12.1702#

Improvements#

  • CSS formatting improvements

10.13.1 - 2025.12.1701#

Improvements#

  • The logic for updating the hash on Clip navigation now relies on the location pathname instead of the default history API behaviour (which uses base HTML elements if provided)

10.13.0 - 2025.11.2601#

New Features#

  • Add stNextClipCategories KVP to integrating app custom targeting
  • Added row.startPadding and row.endPadding theme properties to add padding to a row that should be flush with the container on scroll
  • Support for the "Between Pages" ad strategy
  • Ad events now include an "Ad Strategy" field
  • Added support for additional action types (linking to Stories, categories, Clips, and Collections)
  • AAds between Stories now display even when a Story is skipped

Deprecations#

  • Deprecated theme.storyTiles.title.show property in favour of a value that can be set in the CMS. Starting from this version, this Theme property has no effect. Default value for the CMS property is true.
  • Ad KVPs now match the mobile SDKs (collection was renamed to stCollection, clipCategories was renamed to stClipCategories, and so on)

Improvements#

  • Added a retry button when a Clip or Story fails to load, replacing the infinite spinner
  • If a row doesn't have a set height, it now defaults to a minimum height
  • Improved focus outlines on row and grid items
  • Removed pause button over image Clip ads
  • Non-AMP ads in Clips no longer show pause/play controls since they cannot be paused
  • Previous and Next Story buttons remain enabled when read/unread status is disabled for a row

Bug Fixes#

  • Fixed a bug where ad placement didn’t consistently account for buffer logic
  • Initial ad index now properly accounts for the previous Story’s pages

10.12.10 - 2025.11.2601#

Bug Fixes#

  • Fixed a bug with inconsistent loading of Stories after deleting pages or updating their targeting

10.12.9 - 2025.11.1101#

Bug Fixes#

  • Fixed a bug with inconsistent loading of live Stories when some theme properties are not set

10.12.8 - 2025-10.30#

Bug Fixes#

  • Fixed a bug where it was possible for the wrong CTA to show under Stories ads after navigating back and forth

10.12.7 - 2025-10-24#

Improvements#

10.12.6 - 2025-10-23#

Bug Fixes#

  • Fixed a bug where it was possible for the current category analytics property to be empty in Stories rows with multiple categories

10.12.5 - 2025-10-08#

Bug Fixes#

  • Fixed a bug where it was possible for the "actionButtonTapped" event not to get triggered for actions that open in a new tab

10.12.5 (alpha.3) - 2025-09-24#

Improvements#

  • Fixing generation of .d.ts files

10.12.5 (alpha.2) - 2025-09-23#

Improvements#

  • Fixed a bug where tile size could grow for round tiles when storyTiles.title.show was set to false

10.12.5 (alpha.1) - 2025-09-19#

Improvements#

  • Further improvements to support for some CMPs

10.12.5 (alpha.0) - 2025-09-12#

Improvements#

  • Improving support for some CMPs

10.12.4 - 2025-08-25#

Bug Fixes#

  • Fixed an issue with the Clips player size on some Android devices

10.12.3 - 2025-08-22#

Bug Fixes#

  • Improved the auto-advance behaviour of non-AMP ads in Firefox and Safari

10.12.2 - 2025-08-14#

New Features#

  • Introduced an initial index for the betweenStoriesAndPages and betweenClips ads strategies, that will be the index after which the first ad will appear. Can be configured in the CMS.

10.12.1 - 2025-07-22#

Improvements#

  • Added clipShares as a supported disabledFunctionalFeatures value in tracking preferences. For details, see the Privacy and Tracking documentation

10.12.0 - 2025-07-17#

Improvements#

  • Introduced disabledFunctionalFeatures option in tracking preferences. For details, see the Privacy and Tracking documentation
  • Setting the user ID to null is now supported
  • Introduced enableRemoteViewingStore option in tracking preferences. For details, see the Privacy and Tracking documentation
  • The recentStoryPlaybackMode is now only saved to local storage if needed for analytics
  • Stopped storing user attributes when the enablePersonalization tracking preference is set to false
  • Removed unused settingsSavedDate local storage item

10.11.1 - 2025-06-20#

Improvements:

  • Removed quiz share button from OneBox stories

10.11.0 - 2025-06-19#

Breaking changes:

  • Implemented VPPA compliance measures including SHA256 hashing for User IDs for requests and removal of Content ID from ad requests. See Privacy and Tracking for details.
  • Deprecated Storyteller.currentUserId method as part of privacy enhancements.
  • Added enableFullVideoAnalytics property to eventTrackingOptions for granular video analytics control. See Privacy and Tracking for details.

Improvements:

  • Improved VPPA compliance by removing direct user identifiers from various API requests. See Privacy and Tracking for details.
  • Added support for sheet actions in Clips.

10.9.1 - 2025-06-02#

Improvements:

  • Moved some dependencies to devDependencies

10.9.0 - 2025-04-02#

Features:

Improvements:

  • Non-AMP ads are now supported in Clips as long as they are based on a Storyteller template
  • Better tracking pixels support in Clip ads

10.8.0 - 2025-03-07#

Improvements:

  • The instructions screen is now only shown when opening a Story from the row (not when a Story is opened directly from its URL)
  • The gradient behind the Story/Clip titles on rectangular tiles is now shown by default (it can be hidden by setting storyTiles.rectangularTile.showGradient to false)
  • Better support for non-AMP ads

10.7.2 - 2025-01-23#

Improvements:

  • The instructions screen is now only shown once instead of once per Stories row/grid

10.7.1 - 2025-01-17#

Bug Fixes:

  • Fixed a Safari iOS bug where it was possible for the borders of round thumbnails to disappear
  • Fixed a bug where it was possible for some necessary events not to get reported to Storyteller
  • Fixed a bug where it was possible for a Story row to not be clickable after opening a Story from its share link

10.7.0 - 2025-01-06#

New Features:

Improvements:

  • The behaviour and signature of the open* methods now match the native SDKs:

Bug Fixes:

  • Fixed a bug with linking to a Story not present on the page when player.playAllStories theme property was set to false
  • Fixed a bug where it was possible for the default basename of a view could be empty if no data-base-url was set
  • Fixed a bug where it was possible for the Collection ID param of shared Clips to be empty

10.6.0 - 2024-12-17#

New Features:

Improvements:

  • Added default custom targeting values to integrating app ad requests

10.5.3 - 2024-12-09#

Improvements:

  • Added accessible labels to button elements

10.5.2 - 2024-11-27#

Improvements:

  • Removed calls to deprecated Storyteller internal endpoint

10.5.1 - 2024-11-15#

Bug Fixes:

  • Fixed a bug where it was possible for some Stories not to autoplay on iOS

10.5.0 - 2024-11-14#

New Features:

  • Added support for ads in the Clips Player
  • Added support for "Share media" actions
  • Added support for enableViewedOrdering in a Clips collection

Improvements:

  • Improved focus behaviour for the Story player navigation buttons
  • Grid thumbnails now use the highest quality asset based on their size
  • Added support for Storyteller ads with no actions
  • Mobile CTAs are now aligned to the center by default
  • Improved Story transitions and loading styles
  • Improved full screen styles on mobile
  • Added documentation for Clip events
  • Improved error handling when initialising Storyteller rows in container with invalid IDs

Bug Fixes:

  • Fixed a bug where it was possible for iOS/Android specific actions to show in desktop browsers
  • Fixed a bug where it was possible for some progress bars to experience a delay in loading
  • Fixed a bug where it was possible for the OpenedStory, SkippedStory, DismissedStory, and DismissedClips events to not get recorded in some cases
  • Fixed a bug where it was possible for a previously paused Story to be paused on reopen
  • Fixed a bug where it was possible for an unread Story to be skipped by using the keyboard arrows
  • Fixed a bug where it was possible for the audio of a previous Story to play over the current Story when using the keyboard to navigate
  • Fixed a bug where it was possible for the like state of a clip to be inaccurate in some cases
  • Fixed a bug where it was possible for the swipe up gesture to not open the CTA destination

10.4.11 - 2024-09-20#

Improvements:

  • User attributes now automatically get cleared when a new API key or user ID is provided

Bug Fixes:

  • Fixed a bug where it was possible for the "New" chips to be visible on Stories with read/unread ordering disabled

10.4.10 - 2024-09-06#

New Features:

Improvements:

  • Updated the logic for generating unique ad requests correlators

10.4.9 - 2024-09-03#

New Features:

  • Added support for image titles in clip collections

Improvements:

  • Increased cases where the unmute state is persisted in Chromium browsers

10.4.8 - 2024-08-23#

Bug Fixes:

  • Fixed a bug where it was possible for the Storyteller delegate to not be writeable after the first initialization

10.4.7 - 2024-08-19#

Bug Fixes:

  • Fixed a bug with the formatting of the ads targeting object

10.4.6 - 2024-08-16#

Improvements:

  • Fall back to navigator share API (if available) if the provided onShareButtonTapped function returns null or isn't a Promise

10.4.5 - 2024-07-30#

Improvements:

  • Pinned Stories now use the same styles as Live Stories (to match the native SDKs)
  • clipActionText and clipActionUrl properties are now recorded for Clip events
  • Improved error handling when an invalid container ID is supplied

Bug Fixes:

  • Fixed a bug where it was possible for the completedStory event not to be recorded if a Story was already read
  • Fixed a bug where it was possible for the category update of an existing Story row to lead to a console error

10.4.4 - 2024-07-26#

Improvements:

  • Updated the correlator in ads requests URLs so that it's always unique

10.4.3 - 2024-07-17#

Improvements:

  • Updated the ads algorithm to keep requesting ads for a Story even if a previous request failed

Bug Fixes:

  • Fixed a bug where it was possible for overflow to be disabled when closing the Story player using the browser back button

10.4.2 - 2024-07-03#

Bug Fixes:

  • Fixed a bug where it was possible for 1st-party ads to be requested from the wrong endpoint

10.4.1 - 2024-06-28#

Bug Fixes:

  • Fixed a bug where it was possible for a read Story to be shown as unread when new pages were just added but the assets were still processing

10.4.0 - 2024-06-27#

Improvements:

Bug Fixes:

  • Fixed a bug where it was possible for the live chip inside the Clips player to use the default styles instead of the custom theme
  • Fixed a bug where it was possible for the live chip inside the Stories player to use the default styles instead of the custom theme

10.3.6 - 2024-06-20#

Improvements:

  • Updated the ads logic to keep fetching ads for a Story even if a previous request failed

Bug Fixes:

  • Fixed a bug where it was possible for the first ad in a Story to appear a page later than the provided frequency

10.3.5 - 2024-06-18#

Improvements:

  • Added support for some cookie banners that clear or update local storage when dismissed

10.3.4 - 2024-06-13#

Bug Fixes:

  • Fixed a bug where it was possible for the round Story cells to remain empty on Safari iOS 16.4 and below

10.3.3 - 2024-06-07#

Improvements:

  • Updated the maximum lines of the round Story cells titles so they adapt to the chosen line height

10.3.2 - 2024-06-06#

Bug Fixes:

  • Fixed a bug where it was possible for the round Story cells borders to get cropped
  • Fixed a bug where it was possible for the round Story cells borders colours to not reflect the read/unread state

10.3.1 - 2024-05-31#

Improvements:

  • Improved console error logs when no Clips or Stories available
  • Improved mouse scrolling experience for Clips on Firefox

Bug Fixes:

  • Fixed a bug where it was possible for the first Story in a view to skip pre-loading for tenants with a lot of Stories
  • Fixed a bug where it was possible for the ads action button destination to be displayed instead of the advertiser name if no advertiser name was provided

10.3.0 - 2024-05-15#

New Features:

Improvements:

  • Improved initialization errors
  • 'New' chip are not shown on pinned Stories so as to match the native SDKs behaviors
  • The tappable area to pause the Clips player has been increased

Bug Fixes:

  • Fixed a bug where it was possible for a viewed clip to display the 'new' chip
  • Fixed a bug where it was possible for some of the buttons theme properties to not get applied
  • Fixed a bug where it was possible for Stories to get cropped on some tablet screens
  • Fixed a bug where it was possible for the Clips share amount to not persist on navigation

10.2.1 - 2024-05-02#

Bug Fixes:

  • Fixed a bug where it was possible for some of the instructions theme properties to not get applied

10.2.0 - 2024-04-10#

New Features:

Improvements:

  • Removed Storyteller inline styles
  • Updated ad events to use seconds (not milliseconds) for consistency with other events
  • Clips players can now be closed by clicking on the background
  • Improved transition between clips on Safari for smoother experience
  • Adjusted the Story player to accommodate sticky elements like Smart App banners

Bug Fixes:

  • Fixed a bug where it was possible for the Story lightbox not to open
  • Fixed a bug where it was possible for the Story page to restart after sharing on Safari
  • Fixed a bug where it was possible for the Story progress bars to transition from their previous state upon reopening

10.1.3 - 2024-04-16#

Bug Fixes:

  • Fixed a bug where it was possible for the Story player to load indefinitely after closing the instructions screen

10.1.2 - 2024-04-03#

Bug Fixes:

  • Fixed a bug where it was possible for round story cells with hidden titles to be horizontally off-centre in Chromium browsers

10.1.1 - 2024-03-19#

Improvements:

  • If the lists.row.scrollIndicatorInlineAlignment theme property is set to outside and the row doesn't have enough items for the scroll indicators to be visible, the empty space where the indicator would normally sit has been removed

10.1.0 - 2024-03-08#

New Features:

Improvements:

  • Story players can now be closed by pressing the Esc button
  • Story players can now be closed by clicking on the background
  • Trying to initialize a Storyteller instance more than once will now throw an error
  • Clicking on an already answered quiz option now moves the user to the next page
  • OpenedReason now has additional possible values: tap and automaticPlayback
  • DismissedReason now has additional possible values: backgroundTapped, skippedFinalPage, completedFinalPage, and backTapped
  • The following enums used for building custom themes are now exposed: Alignment, ButtonAlignment, and TextCase
  • The IListConfiguration type is now exposed and can be used to set a list's configuration
  • Updated the type of IStorytellerDelegate to make the onUserActivityOccurred callback optional
  • Updated the type of IStorytellerDelegate to make customTargeting optional in getAdConfig
  • Grid thumbnails now use the most appropriate thumbnail size
  • The clip player now automatically pauses on tab change
  • If playAllStories is set to false and the next Story will be skipped, the next Story button is greyed out
  • Various improvements to the clip player transitions and experience
  • Various performance improvements to the Stories player on iOS
  • Various improvements to the loading states and transitions

Bug Fixes:

  • Fixed a bug where it was possible for the player not to pause when pressing the share button on Safari
  • Fixed a bug where it was possible for a Story page to get skipped after answering a poll
  • Fixed a bug where it was possible for the OpenedPage event not to get triggered
  • Fixed a bug where it was possible for the player to pause when a quiz question wasn't answered
  • Fixed a bug where it was possible for a previously opened Story to appear briefly when opening another Story
  • Fixed a bug where it was possible for Story audio to keep playing after the player was closed
  • Fixed a bug where it was possible for a Story to show a grey screen when navigating backwards or quickly
  • Fixed a bug where it was possible for the wrong OpenedReason to be recorded when opening a Story or Page
  • Fixed a bug where it was possible for clip players to be appended to the DOM more than once on SPAs
  • Fixed a bug where it was possible for the clip player back button to scroll users back to the top of the page
  • Fixed a bug where it was possible for poll results to clash with the background
  • Fixed a bug where it was possible for OneBox Stories not to autoplay in the Google app
  • Fixed a bug where it was possible for the live chip position to be wrong when the row titles were hidden

10.0.4 - 2024-02-02#

Bug Fixes:

  • Fixed a bug where it was possible for short image polls captions to overlap with the background

10.0.3 - 2024-01-31#

Bug Fixes:

  • Fixed a bug where it was possible for OneBox Stories not to send events analytics to Amplitude

10.0.2 - 2024-01-26#

Bug Fixes:

  • Fixed a bug where it was possible for OneBox Stories not to send engagement units events analytics

10.0.1 - 2024-01-10#

Bug Fixes:

  • Fixed a console error about navigator being undefined
  • Fixed a bug where the gradient behind the Story titles on rectangular tiles didn't respect padding preferences

10.0.0 - 2024-01-10#

New Features:

Improvements:

  • Added support for instanceMethod and escapeKeyPressed in the analytics events' DismissedReason property
  • Added support for tap and automaticPlayback in the analytics events' OpenedReason property
  • Added isInitialized and isPlayerVisible properties to the global Storyteller instance
  • Added the dismissPlayer method to the global Storyteller instance
  • Added the enableEventTracking and disableEventTracking methods to the global Storyteller instance
  • Added the enableLogging method to the global Storyteller instance
  • Added IListViewDelegate type export
  • Moved the openPage and openStory methods from the list views to the global Storyteller instance
  • Renamed the onShareButtonClicked callback to onShareButtonTapped and moved it to the global Storyteller delegate
  • Renamed the onStoriesDataLoadStarted callback to onDataLoadStarted
  • Renamed the onStoriesDataLoadComplete callback to onDataLoadComplete
  • Renamed the onStoryDismissed callback to onPlayerDismissed
  • Moved the getAdConfig method to the global Storyteller delegate
  • Moved the onUserActivityOccurred callback to the global Storyteller delegate
  • Removed the tileBecameVisible callback
  • Removed the onError callback
  • Updated list views to derive their basename from their categories or collection
  • Improved dark mode support and default styles
  • Various performance and playback improvements

Bug Fixes:

  • Fixed a bug where the OpenedPage event did not fire on Stories with a single Page
  • Fixed a bug where the SkippedStory event did not fire when the final Page of a Story was skipped
  • Resolved playback issues on quizz Pages

8.9.4 - 2023-12-18#

Improvements:

  • Adding support for dark mode placeholders by using the lists.backgroundColor theme property to set the placeholder styles
  • Preventing Content Layout Shift when loading grid items

8.9.3 - 2023-12-08#

Improvements:

  • Adding title.show theme property to show/hide Story titles on all tiles
  • Removed circularTile.title.hide theme property

Bug Fixes:

  • Fixing a bug where it was possible for round Story tiles with hidden titles to get cropped

8.9.2 - 2023-12-01#

Bug Fixes:

  • Fixing a bug where it was possible for the player to load indefinitely after closing the instructions screen

8.9.1 - 2023-11-30#

Bug Fixes:

  • Adding TypeScript declaration file export to package.json

8.9.0 - 2023-11-22#

Bug Fixes:

  • Fixing a bug where it was possible for auto-advancing ads to not show a progress bar
  • Fixing a bug where it was possible for action buttons to open the wrong URL in Stories with multiple action buttons

8.8.7 - 2023-10-26#

Bug Fixes:

  • fixing a bug where it was possible for stories not to play when the instructions screen was hidden via the theme

8.8.6 - 2023-10-25#

Bug Fixes:

  • Fixing a bug where it was possible for OpenedStory events not to be fired in certain scenarios
  • Fixing a bug where it was possible for OpenedPage events not to be fired in certain scenarios
  • Fixing a bug where it was possible for PreviousPage events to be fired at an incorrect moment
  • Fixing a bug where it was possible for the story player to be incorrectly aligned on certain mobile browsers
  • Fixing a bug where it was possible for playback to stall on certain mobile browsers

8.8.5 - 2023-10-24#

Improvements:

  • Moving the Action button below the player on desktop
  • Reducing the size of the Action button on mobile browsers to reduce the chance of collision with content

8.8.4 - 2023-10-17#

Improvements:

  • Fixing the category query parameter

8.8.3 - 2023-10-13#

Bug Fixes:

  • Fixing a bug where it was possible for Current Category to be reported as empty

8.8.2 - 2023-10-13#

Improvements:

  • Added support for returning externalId

Bug Fixes:

  • When no Category is matched, CurrentCategory no longer reports "Home"

8.8.1 - 2023-10-12#

Improvements:

  • Fixing a bug where it was possible for externalId for Categories for Ads Targeting
  • Fixing a bug where it was possible for Current Category to be reported incorrectly for Analytics

8.8.0 - 2023-10-11#

New Features:

Improvements:

  • Fixing Story navigation bugs
  • Fixing instruction page bugs
  • Adding missing title attribute in iframes

8.7.0 - 2023-10-05#

New Features:

  • Adding support for ads between pages

Improvements:

  • Adding SkippedPage Analytics Event
  • Adding CompletedPage Analytics Event
  • Adding Page Title to all events
  • Adding missing event properties
  • Updating Story Title display
  • Adding missing alt attributes
  • Fixing images aspect ratio errors

8.6.0 - 2023-09-20#

Improvements:

  • Removing the # from the URL when closing a Story.

Bug Fixes:

  • Fixing a muting/unmuting bug when going back into a Story.
  • Fixing errors coming from Google Ad Manager.

8.5.3 - 2023-09-05#

Improvements:

  • Validate AdConfig before passing it to Story View

8.5.2 - 2023-08-30#

Bug Fixes:

  • Fixed module exports

8.5.1 - 2023-08-29#

Bug Fixes:

  • Fixed Storyteller usage in Jest tests

8.5.0 - 2023-08-17#

New Features:

  • Adding useGoogleWebStoryUrls parameter to StorytellerStoriesGridView

Improvements:

  • Reduced SDK budle size by 50%, leading to faster app performance.

Bug Fixes:

  • Fixing a bug where it was possible for the navigation arrows on desktop to not appear.
  • Fixing a bug where it was possible for Story transition animations to not appearing.
  • Fixing a bug where it was possible for Stories to fail to open when opened via a URL.

8.4.2 - 2023-07-31#

New Features:

  • Adding the ability to open a fully AMPHTML compatible version of stories when selecting an item from a StorytellerStoriesRowView

Bug Fixes:

  • In certain situations, the OpenedStory and OpenedPage events might not fire. This is now fixed.

8.4.1 - 2023-07-07#

New Features:

8.4.0 - 2023-06-30#

Improvements:

  • Standardizing the behavior of quizzes with our native SDKs
  • Adding additional analytics properties

Bug Fixes:

  • Fixing a bug where it was possible for the "Share your Result" button on quizzes to be black in Safari
  • Fixing a bug where videos could fail to play if a user hadn't interacted with the browser
  • Fixing a bug where it was possible for a Page's sound to continue playing after the Story player was dismissed

8.2.0 - 2023-06-23#

New Features:

  • Adding support for Audience Targeting and Personalization - see Users for more information

Improvements:

  • Adding additional analytics properties

8.1.0 - 2023-06-01#

Improvements:

  • Internal state management and minor bugfixes

8.0.0 - 2023-04-26#

New Features:

Improvements:

  • Added support for compiling on case-sensitive filesystems
  • Engagement units are now fetched from the view instead of the API
  • Updated the quiz renderer to use a more specific grid layer selector

7.9.2 - 2023-04-17#

New Features:

  • Adding useGoogleWebStoryUrls parameter to StorytellerListView

7.9.1 - 2023-01-17#

Bug Fixes:

  • Fixing bug causing the skip story buttons to not appear on Safari

7.9.0 - 2023-01-16#

Improvements:

7.8.5 - 2023-01-13#

Bug Fixes:

  • Stop the flash of images when coming back from swipe up

7.8.4 - 2023-01-12#

Bug Fixes:

  • Story player improvements

7.8.2 - 2022-12-13#

Bug Fixes:

  • Fixing bug where the PreviousPage event would not fire
  • Fixing bug where the SkippedStory event would not fire

7.8.1 - 2022-12-13#

Bug Fixes:

  • Fixing bug where the player would freeze when opened
  • Fixing bug where the PreviousPage event would not fire

7.8.0 - 2022-12-05#

Bug Fixes:

  • Ensuring circular live story border matches theme color
  • Improving loading behavior when opening stories

7.7.1 - 2022-11-09#

Bug Fixes:

  • Fixing font theme property
  • Fixing instructions.icons theme property

7.7.0 - 2022-09-28#

Improvements:

7.6.0 - 2022-09-23#

Bug Fixes:

  • Fixing bug where thumbnails would sometimes fail to load

Improvements:

7.5.0 - 2022-08-29#

Bug Fixes:

  • Lazy load Story tile thumbnails
  • Fixing issue where the navigation buttons could disappear
  • Stop player going back 2 Stories when back button pressed

Improvements:

  • Improve caching for static assets

7.4.5 - 2022-08-22#

Bug Fixes:

  • Fixing bug with scroll indicator fade theming
  • Fixing bug when applying corner radius theme property

7.4.3 - 2022-08-17#

Bug Fixes:

  • Fixing quiz score placement when sharing disabled
  • Fixing bug where instructions screen took multiple clicks to dismiss

7.4.2 - 2022-08-17#

Bug Fixes:

  • Don't reorder Stories when player is closed
  • Fix NPM type definitions

Improvements:

  • Use simple HTTP Requests

7.4.1 - 2022-07-29#

New Features:

7.4.0 - 2022-07-29#

New Features:

Bug Fixes:

  • Fixing live chip theme issues

7.3.5 - 2022-07-15#

Bug Fixes:

  • Don't show share results button if share API not available
  • Fixing bug when returning from swipe up
  • Make sure externalApp swipe ups are recorded correctly

7.3.4 - 2022-07-13#

Improvements:

  • Improving support for older browsers

7.3.3 - 2022-07-11#

Bug Fixes:

  • Polls theme fixes

7.3.1 - 2022-07-08#

Improvements:

  • Make sure player Stories reorder when player closed

Bug Fixes:

  • Fixing corrupt svg console errors

7.3.0 - 2022-06-23#

Deprecation and Changes:

  • Removing showStoryTitle theme property
  • Adding showStoryIcon theme property

7.2.4 - 2022-06-20#

Improvements:

  • Improving open Story transitions
  • Hide Quiz share button when share buttons hidden

Bug Fixes:

  • Fixing issue with new indicator always showing on rectangular tiles

7.2.2 - 2022-06-01#

Bug Fixes:

  • Fixing issues with NPM type definitions

7.2.1 - 2022-05-31#

Bug Fixes:

  • Stop scroll to top when player closed

7.2.0 - 2022-05-13#

Bug Fixes:

  • Fixing issues with NPM package

7.1.2 - 2022-05-12#

Improvements:

  • Updating package.json

7.1.1 - 2022-05-11#

New Features:

7.1.0 - 2022-05-02#

New Features:

  • Added support for Live Stories

7.0.0 - 2022-04-07#

New Features:

Improvements:

  • Made implementing custom themes even easier

2.2.0 - 2022-03-23#

Improvements:

  • Hide share button on browsers that don't support navigator.share
  • Make externalId optional
  • Allow Ad frequency to be configured

2.1.0 - 2022-03-11#

Improvements:

  • Adjust tile height to fill parent container
  • Send pollAnswerId in analytics events
  • Send all properties to analytics endpoint

2.0.1 - 2022-02-16#

Bug Fixes:

  • Fixing Story Page issues

2.0.0 - 2022-02-09#

Improvements:

New Features:

1.17.1 - 2022-01-18#

Improvements:

  • Improving swipe behavior
  • Show navigation arrows on touchscreen laptops

Bug Fixes:

  • Stopping JSONParseErrors being thrown for empty responses
  • Fixing missing API key 401s

1.17.0 - 2021-11-19#

New Features:

1.16.0 - 2021-11-02#

New Features:

  • Added the ability to swipe down to dismiss a Story
  • Added the ability for share links to open a specific Page (instead of just the first Page in the Story)
  • Added a playAllStories option to the theme which will not exit the Story player when the user reaches the end of their unread Stories - but rather keep them in the Stories experience until they see every Story in the row

Bug Fixes:

  • Fixed an issue which could cause Polls not to display in certain scenarios

1.15.0 - 2021-10-22#

Improvements:

  • Hiding 'i' button when video fails to play

Bug Fixes:

  • Stop video failed to play message appearing when a video successfully plays

New Features:

  • Recording share success events

1.14.0 - 2021-10-21#

Bug Fixes:

  • Fixing bug where Poll answer percentages display incorrectly

1.13.0 - 2021-10-19#

Improvements:

  • Preventing background media from being cropped

1.12.0 - 2021-10-18#

Bug Fixes:

  • Using the correct value for storyReadStatus in analytic events
  • Fixing issue where Story titles are shared/duplicate sharing URLs are shared when tapping share button

Improvements:

  • Adding information about VotedPoll event to the docs
  • Updating to open Story immediately when tapping/clicking Story tile instead of showing loading spinners

1.11.0 - 2021-10-15#

Bug Fixes:

  • Fixing sharing instructions issues

1.10.0 - 2021-10-12#

Improvements:

  • Removes the border around buttons in the Story player

1.9.0 - 2021-10-07#

Bug Fixes:

  • Fixing bug where users can vote for a Poll more than once

1.8.0 - 2021-10-05#

Improvements:

  • Adding theme option to hide Story titles

Bug Fixes:

  • Persisting mute state throughout Stories
  • Fixing CORS issues

1.7.0 - 2021-09-24#

Bug Fixes:

  • Stopping the wrong Story from being shown briefly when opening a share link
  • Disabling the 'previous page' button on the first Page of the first Story
  • Fixing issue where Story row would not load on iOS 12

1.6.0 - 2021-09-23#

Improvements:

  • Always displaying the mute/unmute icon in player
  • Adding text property to onShareButtonClicked() delegated method
  • Allow 3 lines for the Story title when using circular tiles

Bug Fixes:

  • Fixing instructions screen layout and icons on desktop
  • Fixing issue with missing navigation arrows and black background when refreshing/arriving from shared link

1.5.0 - 2021-09-17#

Bug Fixes:

  • Stop player closing when navigating backwards
  • Sort all Story rows when player is closed
  • Stop player from continuing in background after being closed

New Features:

  • Adding share delegate method
  • Adding docs for share callback

Improvements:

  • Hide share button if navigator.share doesn't exist
  • Don't hide share button if onShareButtonClick callback is defined

1.4.0 - 2021-09-16#

Bug Fixes:

  • Fixing Poll styling
  • Fixing ad overlay appearing over Story view

1.3.0 - 2021-09-09#

Bug Fixes:

  • Fixing desktop player not pausing on share
  • Fixing left scroll arrow
  • Only show read Stories and fix player opening unexpectedly
  • Don't open player until correct Story has loaded
  • Fixing bug when opening same Story after dismissing it
  • Setting opacity on tile loading
  • Fixing style import
  • Hide mute/unmute text

New Features:

  • Adding tileLoading state to tiles

1.2.0 - 2021-09-07#

New Features:

  • Adding properties to row theme

Bug Fixes:

  • Fixing instruction icons

Deprecations and Changes:

  • Switch to using query string params instead of headers in API requests
  • Updating row theme docs

1.1.0 - 2021-09-02#

Bug Fixes:

  • Fixing Poll styling
  • Fixing ad overlay appearing over Story view