react-native-viewability-tracking-view
TypeScript icon, indicating that this package has built-in type declarations

1.0.0 • Public • Published

react-native-viewability-tracking-view

Note: This tracking uses setInterval and the native measure method, which can affect your application's performance if used excessively

If you need to track how many times a View is visible on the screen, you can use this. It provides options for setting offsets (offset*), in case part of your screen is covered by fixed elements, e.g. a tab bar.

Also, you can configure what is considered enough to be "seen". By default, onViewabilityChange will be called when at least 50% (itemVisiblePercentThreshold) of the ViewabilityTrackingView has been rendered within the device's screen dimensions for at least 1000 ms (minimumViewTime).

Lastly, you can define how often the measurement is taken, which affects the accuracy of the tracking and the performance impact it has (viewabilityMeasurementInterval).

Example

import ViewabilityTrackingView, {
  OnViewabilityParameters,
} from 'react-native-viewability-tracking-view'

export const MyComponent = ({
  isCurrentRoute,
  title,
}: {
  isCurrentRoute: boolean
  title: string
}) => {
  const onViewabilityChange = (data: OnViewabilityParameters) => {
    /* do something */
  }

  return (
    <ViewabilityTrackingView
      enabled={isCurrentRoute} // to only track when relevant
      accessibilityLabel={`Advertising banner ${title}`}
      onViewabilityChange={onViewabilityChange}
      testID="ViewabilityTrackingView"
      // check docs below for all props
    >
      <Text>{title}</Text>
    </ViewabilityTrackingView>
  )
}

Props

export interface OnViewabilityCallbackParameters<
  Item extends Record<string, unknown> = Record<string, never>
> {
  isInView: boolean
  item?: Item
  itemVisiblePercent: number
  testID?: string
  timeInView?: number
  timeOutOfView?: number
}

export interface ViewabilityTrackingViewProps<
  Item extends Record<string, unknown> = Record<string, never>
> extends ViewProps {
  /**
   * DEV ONLY: Set to true to get console.logs of the viewability, each time it's measured.
   *
   * @type {boolean}
   * @memberof ViewabilityTrackingViewProps
   */
  __DEV__debug?: boolean

  children?: React.ReactNode

  /**
   * Requiring explicit opt-in to the tracking. This is to remind consumers that viewability tracking
   * might affect performance, so ideally it should only be enabled when there is a chance that the
   * content will come into view.
   *
   * @type {boolean}
   * @memberof ViewabilityTrackingViewProps
   */
  enabled: boolean

  /**
   * Minimum percent of pixels that need to be viewable for item to be considered in view. Defaults to 50.
   *
   * @type {number}
   * @memberof ViewabilityTrackingViewProps
   */
  itemVisiblePercentThreshold?: number

  /**
   * Item is optional, but passed into the onViewability* callbacks.
   *
   * @type {OnMeasureParameters['item']}
   * @memberof ViewabilityTrackingViewProps
   */
  item?: Item

  /**
   * Minimum view time, in milliseconds, required to trigger onViewabilityChange. Defaults to 1000.
   *
   * @type {number}
   * @memberof ViewabilityTrackingViewProps
   */
  minimumViewTime?: number

  /**
   * Use offsetBottom to set that amount of pixels as not viewable, e.g. if there is a fixed bottom
   * bar that content can be scrolled behind, while still within the window of the device.
   *
   * @type {number}
   * @memberof ViewabilityTrackingViewProps
   */
  offsetBottom?: number

  /**
   * Use offsetLeft to set that amount of pixels as not viewable, e.g. if there is a fixed sidebar
   * that content can be scrolled behind, while still within the window of the device.
   *
   * @type {number}
   * @memberof ViewabilityTrackingViewProps
   */
  offsetLeft?: number

  /**
   * Use offsetRight to set that amount of pixels as not viewable, e.g. if there is a fixed sidebar
   * that content can be scrolled behind, while still within the window of the device.
   *
   * @type {number}
   * @memberof ViewabilityTrackingViewProps
   */
  offsetRight?: number

  /**
   * Use offsetTop to set that amount of pixels as not viewable, e.g. if there is a fixed header
   * that content can be scrolled behind, while still within the window of the device.
   *
   * @type {number}
   * @memberof ViewabilityTrackingViewProps
   */
  offsetTop?: number

  /**
   * Called when the itemVisiblePercentThreshold and the minimumViewTime is met for the first time
   * since coming into view and when going out of view after having been in view. In the latter case
   * it does not matter for how long it had been in view before going out of view.
   *
   * @memberof ViewabilityTrackingViewProps
   */
  onViewabilityChange?: (params: OnViewabilityCallbackParameters) => void

  /**
   * Called on every viewability measurement, which is done at the viewabilityMeasurementInterval.
   *
   * @memberof ViewabilityTrackingViewProps
   */
  onViewabilityCheck?: (params: OnViewabilityCallbackParameters) => void

  testID?: string

  /**
   * Time between viewability measurements, in milliseconds. Defaults to 200.
   *
   * @type {number}
   * @memberof ViewabilityTrackingViewProps
   */
  viewabilityMeasurementInterval?: number
}

Package Sidebar

Install

npm i react-native-viewability-tracking-view

Weekly Downloads

7

Version

1.0.0

License

MIT

Unpacked Size

50.8 kB

Total Files

19

Last publish

Collaborators

  • fredrikolovsson