# All files / src/Banner Banner.tsx

99.12% Statements 113/114
85% Branches 17/20
95.45% Functions 21/22
98.82% Lines 84/85

Press n or j to go to the next uncovered block, b, p or k for the previous block.

    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
    192
    193
    194
    195
    196
    197
    198
    199
    200
    201
    202
    203
    204
    205
    206
    207
    208
    209
    210
    211
    212
    213
    214
    215
    216
    217
    218
    219
    220
    221
    222
    223
    224
    225
    226
    227
    228
    229
    230
    231
    232
    233
    234
    235
    236
    237
    238
    239
    240
    241
    242
    243
    244
    245
    246
    247
    248
    249
    250
    251
    252
    253
    254
    255
    256
    257
    258
    259
    260
    261
    262
    263
    264
    265
    266
    267
    268
    269
    270
    271
    272
    273
    274
    275
    276
    277
    278
    279
    280
    281
    282
    283
    284
    285
    286
    287
    288
    289
    290
    291
    292
    293
    294
    295
    296
    297
    298
    299
    300
    301
    302
    303
    304
    305
    306
    307
    308
    309
    310
    311
    312
    313
    314
    315
    316
    317
    318
    319
    320
    321
    322
    323
    324
    325
    326
    327
    328
    329
    330
    331
    332
    333
    334
    335
    336
    337
    338
    339
    340
    341
    342
    34311x

    11x
    11x
    11x
    11x
    11x
    11x
    11x
    11x
    11x
    11x

    11x

    11x
    115x
    115x

    904x

    115x

    115x

    11x
    114x
    114x

    11x

    37x

    37x

    37x

    34x

    11x
    97x
    97x

    11x
    97x
    97x

    11x
    93x
    93x

    11x
    4x
    4x

    11x
    12x
    12x

    24x

    12x

    4x

    8x

    24x

    11x
    111x
    111x

    11x
    90x
    90x

    90x

    11x

    17x
    17x

    11x

    14x
    14x

    11x

    14x
    14x

    11x

    14x
    14x

    11x

    1x
    1x

    11x

    11x

    11x

    11x

    11x

    11x

    11x

    11x

    11x

    11x

    11x

    11x

    11x

    11x

    11x

    11x

     import {
      Check,
      Clear,
      EllipsisVertical,
      Error,
      Info,
      Warning,
    } from '@procore/core-icons/dist'
    import { partition } from 'ramda'
    import React from 'react'
    import { Button } from '../Button/Button'
    import { Card } from '../Card/Card'
    import { Menu, useMenu } from '../Menu/Menu'
    import { OverlayTrigger } from '../OverlayTrigger/OverlayTrigger'
    import { useI18nContext } from '../_hooks/I18n'
    import { OverflowObserver } from '../_hooks/OverflowObserver'
    import { addSubcomponents } from '../_utils/addSubcomponents'
    import { mergeRefs } from '../_utils/mergeRefs'
    import { ButtonAttributes, DivAttributes, Props } from '../_utils/types'
    import {
      StyledAction,
      StyledActionsTrigger,
      StyledBannerContainer,
      StyledBody,
      StyledContent,
      StyledExpandableContent,
      StyledExpandableContentContainer,
      StyledIconContainer,
      StyledMiniBannerContainer,
      StyledTitle,
    } from './Banner.styles'
    import {
      BannerExpandableContentProps,
      BannerIconProps,
      BannerProps,
      BannerVariant,
    } from './Banner.types'

    /**

     We use banners to contextually convey complicated or supplemental information
     to a user. Depending on the type of banner, we can provide more information
     about a feature or page the user is on, an action the user needs to perform,
     or an error the user has encountered.

     Procore banners are informative and actionable. Always explain what the user
     needs to know (and in some cases, why they’re seeing the banner), and provide
     an actionable next step.

     @since 10.19.0

     @see [Storybook](https://procore.github.io/core/core-react/latest/?path=/story/demos-banner--demo)

     @see [Design Guidelines](https://design.procore.com/banner)

     */
    const Banner_ = React.forwardRef<HTMLDivElement, DivAttributes & BannerProps>(
      function Banner({ children, variant, ...props }, ref) {
        const [expandableContentNodes, content] = partition(
          (element: React.ReactNode) =>
            React.isValidElement(element) && element.type === ExpandableContent,
          React.Children.toArray(children)
        ) as [React.ReactElement[], React.ReactElement[]]

        const isExpandable = expandableContentNodes.length !== 0

        return (
          <StyledBannerContainer
            ref={ref}
            isExpandable={isExpandable}
            variant={variant}
            {...props}
          >
            {isExpandable ? (
              <>
                <StyledExpandableContentContainer
                  justifyContent="space-between"
                  alignItems="center"
                >
                  {content}
                </StyledExpandableContentContainer>
                {expandableContentNodes}
              </>
            ) : (
              content
            )}
          </StyledBannerContainer>
        )
      }
    )

    const Content = React.forwardRef<HTMLDivElement, DivAttributes & Props>(
      function Content({ children, ...props }, ref) {
        return (
          <StyledContent {...props} ref={ref}>
            {children}
          </StyledContent>
        )
      }
    )

    const ExpandableContent = React.forwardRef<
      HTMLDivElement,
      DivAttributes & BannerExpandableContentProps
    >(function ExpandableContent(
      { children, expanded = false, expandableContentMaxHeight = 120, ...props },
      ref
    ) {
      const containerRef = React.useRef<HTMLDivElement>(null)

      return expanded ? (
        <OverflowObserver>
          {({ ref: overflowRef, isOverflowingY }) => (
            <StyledExpandableContent
              ref={mergeRefs(ref, containerRef)}
              data-qa="core-banner-expandable-content"
              onAnimationEnd={() => overflowRef(containerRef.current)}
              isOverflowingY={isOverflowingY}
              expandableContentMaxHeight={expandableContentMaxHeight}
              {...props}
              {...(isOverflowingY && { tabIndex: 0 })}
            >
              {children}
            </StyledExpandableContent>
          )}
        </OverflowObserver>
      ) : null
    })

    const Title = React.forwardRef<HTMLDivElement, DivAttributes & Props>(
      function Title({ children, ...props }, ref) {
        return (
          <StyledTitle {...props} ref={ref}>
            {children}
          </StyledTitle>
        )
      }
    )

    const Body = React.forwardRef<HTMLDivElement, DivAttributes & Props>(
      function Body({ children, ...props }, ref) {
        return (
          <StyledBody {...props} ref={ref}>
            {children}
          </StyledBody>
        )
      }
    )

    const Action = React.forwardRef<HTMLDivElement, DivAttributes & Props>(
      function Action({ children, ...props }, ref) {
        return (
          <StyledAction {...props} ref={ref}>
            {children}
          </StyledAction>
        )
      }
    )

    const DropdownAction = React.forwardRef<HTMLDivElement, DivAttributes & Props>(
      function DropdownAction({ children, ...props }, ref) {
        return (
          <Menu.Item ref={ref} item={null} {...(props as any)}>
            {children}
          </Menu.Item>
        )
      }
    )

    const Actions = React.forwardRef<HTMLButtonElement, ButtonAttributes & Props>(
      function Actions({ children, ...props }, ref) {
        const actionButtons = React.Children.toArray(children).filter(
          (element: React.ReactNode) =>
            React.isValidElement(element) && element.type === Action
        ) as React.ReactElement[]

        return (
          <OverlayTrigger
            overlay={
              <Card>
                <Menu
                  ref={(node) => node?.focus()}
                  usingHook={useMenu({
                    isSelectable: ({ type }) => type === DropdownAction,
                  })}
                >
                  <Menu.Options>
                    {actionButtons.map(({ props: actionButtonProps }, idx) => (
                      <DropdownAction key={idx} {...actionButtonProps} />
                    ))}
                  </Menu.Options>
                </Menu>
              </Card>
            }
            ref={ref}
            placement="bottom-right"
          >
            <StyledActionsTrigger
              data-qa="core-banner-actions-trigger"
              variant="tertiary"
              arrow={false}
              icon={<EllipsisVertical />}
              {...props}
            />
          </OverlayTrigger>
        )
      }
    )

    const Icon = React.forwardRef<HTMLDivElement, DivAttributes & BannerIconProps>(
      function Icon({ children, icon, ...props }, ref) {
        return (
          <StyledIconContainer ref={ref} aria-hidden="true" {...props}>
            {icon}
          </StyledIconContainer>
        )
      }
    )

    const Dismiss = React.forwardRef<HTMLButtonElement, ButtonAttributes & Props>(
      function Dismiss({ children, ...props }, ref) {
        const I18n = useI18nContext()

        return (
          <Button
            aria-label={I18n.t('core.banner.dismissAlert')}
            ref={ref}
            {...props}
            icon={<Clear />}
            variant="tertiary"
          />
        )
      }
    )

    export const ErrorBanner = React.forwardRef<
      HTMLDivElement,
      DivAttributes & Props
    >(function ErrorBanner({ children, ...props }, ref) {
      return (
        <Banner ref={ref} variant="error" {...props}>
          <Icon icon={<Error size="lg" />} />
          {children}
        </Banner>
      )
    })

    /**
     * @deprecated Component will be removed in a future version. Instead, please consider using "success" variant of Toast component.
     * @deprecatedSince 10.7.0
     */
    export const SuccessBanner = React.forwardRef<
      HTMLDivElement,
      DivAttributes & Props
    >(function SuccessBanner({ children, ...props }, ref) {
      return (
        <Banner ref={ref} variant="success" {...props}>
          <Icon icon={<Check size="lg" />} />
          {children}
        </Banner>
      )
    })

    export const InfoBanner = React.forwardRef<
      HTMLDivElement,
      DivAttributes & Props
    >(function InfoBanner({ children, ...props }, ref) {
      return (
        <Banner ref={ref} variant="info" {...props}>
          <Icon icon={<Info size="lg" />} />
          {children}
        </Banner>
      )
    })

    export const ActionBanner = React.forwardRef<
      HTMLDivElement,
      DivAttributes & Props
    >(function ActionBanner({ children, ...props }, ref) {
      return (
        <Banner ref={ref} variant="action" {...props}>
          <Icon icon={<Warning size="lg" />} />
          {children}
        </Banner>
      )
    })

    export const UNSAFE_MiniBanner = React.forwardRef<
      HTMLDivElement,
      DivAttributes & Props & { variant?: BannerVariant }
    >(function MiniBanner({ children, variant = 'info', ...props }, ref) {
      return (
        <StyledMiniBannerContainer ref={ref} variant={variant} {...props}>
          {children}
        </StyledMiniBannerContainer>
      )
    })

    Banner_.displayName = 'Banner'

    Body.displayName = 'Banner.Body'

    Content.displayName = 'Banner.Content'

    ExpandableContent.displayName = 'Banner.ExpandableContent'

    Title.displayName = 'Banner.Title'

    Action.displayName = 'Banner.Action'

    Actions.displayName = 'Banner.Actions'

    DropdownAction.displayName = 'Banner.DropdownAction'

    Icon.displayName = 'Banner.Icon'

    Dismiss.displayName = 'Banner.Dismiss'

    ErrorBanner.displayName = 'ErrorBanner'

    SuccessBanner.displayName = 'SuccessBanner'

    InfoBanner.displayName = 'InfoBanner'

    ActionBanner.displayName = 'ActionBanner'

    UNSAFE_MiniBanner.displayName = 'MiniBanner'

    export const Banner = addSubcomponents(
      {
        Body,
        Content,
        ExpandableContent,
        Title,
        Action,
        Actions,
        Icon,
        Dismiss,
      },
      Banner_
    )