BackButton

Button used by the stack navigation to go back to the previous screen

Properties

Name	Type	Default Value	Required	Description
onPress	() => void		Yes	the onPress function for the back button
canGoBack	boolean		Yes	a boolean indicating if the user has a screen to go back to; if false, the back button will be hidden
label	BackButtonLabel		Yes	translation key to use for the display text, as well as the testID for the component
a11yHint	string		No	optional param to add accessibility hint to back button
focusOnButton	boolean	true	No	boolean to specify if we want accesibility to focus on the back button
backButtonTestID	string		No	option testID
webview	boolean		No

Example

How to use the BackButton component

<BackButton 
onPress={() => {}} 
label={'BackButtonLabelConstants.back'} 
canGoBack={true} 
showCarat={true} 
a11yHint={'a11yHint'}/>

Source Code

Full code for the BackButton component

import React, { FC } from 'react'
import { useTranslation } from 'react-i18next'
import { TouchableWithoutFeedback } from 'react-native'

import { useFocusEffect } from '@react-navigation/native'

import { BackButtonLabel } from 'constants/backButtonLabels'
import { NAMESPACE } from 'constants/namespaces'
import { a11yHintProp } from 'utils/accessibility'
import { useAccessibilityFocus, useTheme } from 'utils/hooks'

import Box from './Box'
import TextView from './TextView'

/**
 *  Signifies the props that need to be passed in to {@link BackButton}
 */
export type BackButtonProps = {
  /** the onPress function for the back button */
  onPress: (() => void) | undefined
  /** a boolean indicating if the user has a screen to go back to; if false, the back button will be hidden */
  canGoBack: boolean | undefined
  /** translation key to use for the display text, as well as the testID for the component */
  label: BackButtonLabel
  /** optional param to add accessibility hint to back button */
  a11yHint?: string
  /** boolean to specify if we want accesibility to focus on the back button */
  focusOnButton?: boolean
  /** option testID */
  backButtonTestID?: string

  webview?: boolean
}

/**
 * Button used by the stack navigation to go back to the previous screen
 */
export const BackButton: FC<BackButtonProps> = ({
  onPress,
  canGoBack,
  label,
  a11yHint,
  backButtonTestID,
  focusOnButton = true,
  webview,
}) => {
  const { t } = useTranslation(NAMESPACE.COMMON)
  const theme = useTheme()

  const [focusRef, setFocus] = useAccessibilityFocus<TouchableWithoutFeedback>()

  useFocusEffect(focusOnButton ? setFocus : () => {})

  if (!canGoBack) {
    return null
  }

  const a11yHintPropParam = a11yHint ? a11yHint : t(`${label}.a11yHint`)

  return (
    <TouchableWithoutFeedback
      ref={focusRef}
      onPress={onPress}
      accessibilityLabel={label}
      {...a11yHintProp(a11yHintPropParam)}
      accessibilityRole="button"
      accessible={true}
      testID={backButtonTestID}>
      <Box
        display="flex"
        flexDirection="row"
        ml={theme.dimensions.headerButtonSpacing}
        height={theme.dimensions.headerHeight}
        alignItems={'center'}>
        <TextView
          variant="ActionBar"
          color={webview ? 'link' : undefined}
          ml={theme.dimensions.textIconMargin}
          allowFontScaling={false}
          accessible={false}>
          {t(label)}
        </TextView>
      </Box>
    </TouchableWithoutFeedback>
  )
}

export default BackButton

Accessibility