React Native Help Scout

Help Scout's Beacon for React Native.

Installation

yarn add react-native-help-scout

iOS

Please visit https://developer.helpscout.com/beacon-2/ios/#additional-setup and complete the steps

Usage

import { Beacon } from 'react-native-help-scout'

// Initialize Beacon
Beacon.init('beacon-id')

// Open Beacon
Beacon.open()

// Set user information in Beacon
Beacon.identify({
	email: '[email protected]',
	name: 'Joshua Heywood',
	company: 'Megatronic',
	jobTitle: 'Marketing Manager',
})

// Unset user information in Beacon
Beacon.logout()

// Navigate to a specific screen (iOS only)
Beacon.navigate('/ask/message/')

// Open with search
Beacon.search('query')

// Open article
Beacon.openArticle('DOCS_ARTICLE_ID')

// Open contact from
Beacon.contactForm()

// Open previous messages (Android only)
Beacon.previousMessages()

// Dismissing the Beacon (iOS only)
Beacon.dismiss(() => console.log('Beacon dismissed'))

// Event handlers
const openHandler = () => console.log('Beacon opened')
Beacon.events.on('open', openHandler)
Beacon.events.off('open', openHandler)
Beacon.events.off('open')
Beacon.events.once('open', () => console.log('This will only get called the first time the open event is triggered'))

const closeHandler = () => console.log('Beacon closed')
Beacon.events.on('close', closeHandler)
Beacon.events.off('close', closeHandler)
Beacon.events.off('close')
Beacon.events.once('close', () => console.log('This will only get called the first time the close event is triggered'))

Requirements

• React Native 0.61.0 or newer