about summary refs log tree commit diff
path: root/src/components/Link.tsx
blob: 8f686f3c4cee69beb7f5ac6648fbfe1896ff0304 (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
import React from 'react'
import {
  Text,
  TextStyle,
  StyleProp,
  GestureResponderEvent,
  Linking,
} from 'react-native'
import {
  useLinkProps,
  useNavigation,
  StackActions,
} from '@react-navigation/native'
import {sanitizeUrl} from '@braintree/sanitize-url'

import {isWeb} from '#/platform/detection'
import {useTheme, web, flatten} from '#/alf'
import {Button, ButtonProps, useButtonContext} from '#/components/Button'
import {AllNavigatorParams, NavigationProp} from '#/lib/routes/types'
import {
  convertBskyAppUrlIfNeeded,
  isExternalUrl,
  linkRequiresWarning,
} from '#/lib/strings/url-helpers'
import {useModalControls} from '#/state/modals'
import {router} from '#/routes'

export type LinkProps = Omit<
  ButtonProps,
  'style' | 'onPress' | 'disabled' | 'label'
> & {
  /**
   * `TextStyle` to apply to the anchor element itself. Does not apply to any children.
   */
  style?: StyleProp<TextStyle>
  /**
   * The React Navigation `StackAction` to perform when the link is pressed.
   */
  action?: 'push' | 'replace' | 'navigate'
  /**
   * If true, will warn the user if the link text does not match the href. Only
   * works for Links with children that are strings i.e. text links.
   */
  warnOnMismatchingTextChild?: boolean
  label?: ButtonProps['label']
} & Pick<Parameters<typeof useLinkProps<AllNavigatorParams>>[0], 'to'>

/**
 * A interactive element that renders as a `<a>` tag on the web. On mobile it
 * will translate the `href` to navigator screens and params and dispatch a
 * navigation action.
 *
 * Intended to behave as a web anchor tag. For more complex routing, use a
 * `Button`.
 */
export function Link({
  children,
  to,
  action = 'push',
  warnOnMismatchingTextChild,
  style,
  ...rest
}: LinkProps) {
  const navigation = useNavigation<NavigationProp>()
  const {href} = useLinkProps<AllNavigatorParams>({
    to:
      typeof to === 'string' ? convertBskyAppUrlIfNeeded(sanitizeUrl(to)) : to,
  })
  const isExternal = isExternalUrl(href)
  const {openModal, closeModal} = useModalControls()
  const onPress = React.useCallback(
    (e: GestureResponderEvent) => {
      const stringChildren = typeof children === 'string' ? children : ''
      const requiresWarning = Boolean(
        warnOnMismatchingTextChild &&
          stringChildren &&
          isExternal &&
          linkRequiresWarning(href, stringChildren),
      )

      if (requiresWarning) {
        e.preventDefault()

        openModal({
          name: 'link-warning',
          text: stringChildren,
          href: href,
        })
      } else {
        e.preventDefault()

        if (isExternal) {
          Linking.openURL(href)
        } else {
          /**
           * A `GestureResponderEvent`, but cast to `any` to avoid using a bunch
           * of @ts-ignore below.
           */
          const event = e as any
          const isMiddleClick = isWeb && event.button === 1
          const isMetaKey =
            isWeb &&
            (event.metaKey || event.altKey || event.ctrlKey || event.shiftKey)
          const shouldOpenInNewTab = isMetaKey || isMiddleClick

          if (
            shouldOpenInNewTab ||
            href.startsWith('http') ||
            href.startsWith('mailto')
          ) {
            Linking.openURL(href)
          } else {
            closeModal() // close any active modals

            if (action === 'push') {
              navigation.dispatch(StackActions.push(...router.matchPath(href)))
            } else if (action === 'replace') {
              navigation.dispatch(
                StackActions.replace(...router.matchPath(href)),
              )
            } else if (action === 'navigate') {
              // @ts-ignore
              navigation.navigate(...router.matchPath(href))
            } else {
              throw Error('Unsupported navigator action.')
            }
          }
        }
      }
    },
    [
      href,
      isExternal,
      warnOnMismatchingTextChild,
      navigation,
      action,
      children,
      closeModal,
      openModal,
    ],
  )

  return (
    <Button
      label={href}
      {...rest}
      role="link"
      accessibilityRole="link"
      href={href}
      onPress={onPress}
      {...web({
        hrefAttrs: {
          target: isExternal ? 'blank' : undefined,
          rel: isExternal ? 'noopener noreferrer' : undefined,
        },
        dataSet: {
          // default to no underline, apply this ourselves
          noUnderline: '1',
        },
      })}>
      {typeof children === 'string' ? (
        <LinkText style={style}>{children}</LinkText>
      ) : (
        children
      )}
    </Button>
  )
}

function LinkText({
  children,
  style,
}: React.PropsWithChildren<{
  style?: StyleProp<TextStyle>
}>) {
  const t = useTheme()
  const {hovered} = useButtonContext()
  return (
    <Text
      style={[
        {color: t.palette.primary_500},
        hovered && {
          textDecorationLine: 'underline',
          textDecorationColor: t.palette.primary_500,
        },
        flatten(style),
      ]}>
      {children as string}
    </Text>
  )
}