All files / src/UI Document.tsx

80.39% Statements 41/51
61.11% Branches 33/54
50% Functions 2/4
75.61% Lines 31/41

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                              3x 3x                 3x                     3x 3x 3x 3x                                       3x         30x 30x 30x 30x 30x 30x 30x 30x 30x 30x 30x 30x 30x 30x 30x 30x 30x       30x     30x                 30x                                   30x   30x                                             36x                                                                      
/*
    Copyright (C) 2017 Red Hat, Inc.
 
    Licensed under the Apache License, Version 2.0 (the "License");
    you may not use this file except in compliance with the License.
    You may obtain a copy of the License at
 
            http://www.apache.org/licenses/LICENSE-2.0
 
    Unless required by applicable law or agreed to in writing, software
    distributed under the License is distributed on an "AS IS" BASIS,
    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
    See the License for the specific language governing permissions and
    limitations under the License.
*/
import { AngleDownIcon, AngleRightIcon } from '@patternfly/react-icons';
import {
  Button,
  Card,
  CardActions,
  CardBody,
  CardHeader,
  CardTitle,
  Title,
} from '@patternfly/react-core';
import React, {
  HTMLAttributes,
  KeyboardEvent,
  MouseEvent,
  PropsWithChildren,
  ReactElement,
  ReactNode,
  forwardRef,
  useCallback,
} from 'react';
 
import { TruncatedString } from './TruncatedString';
import { css } from '@patternfly/react-styles';
import styles from './Document.module.css';
import { useToggle } from '../impl/utils';
 
export interface IDocumentProps
  extends Omit<HTMLAttributes<HTMLDivElement>, 'title'> {
  title?: string;
  actions?: (ReactElement | null | undefined)[];
  footer?: ReactNode;
  selected?: boolean;
  selectable?: boolean;
  dropTarget?: boolean;
  dropAccepted?: boolean;
  stacked?: boolean;
  scrollIntoView?: boolean;
  noPadding?: boolean;
  noShadows?: boolean;
  startExpanded?: boolean;
  onSelect?: () => void;
  onDeselect?: () => void;
}
 
export const Document = forwardRef<
  HTMLDivElement,
  PropsWithChildren<IDocumentProps>
>(function Document(
  {
    id,
    title,
    actions,
    footer,
    selected = false,
    dropTarget = false,
    dropAccepted = false,
    stacked = true,
    selectable = false,
    scrollIntoView = false,
    noPadding = false,
    noShadows = false,
    startExpanded,
    onSelect,
    onDeselect,
    children,
    ...props
  },
  ref,
) {
  const { state: isExpanded, toggle: toggleExpanded } = useToggle(
    startExpanded!,
  );
  const handleClick = useCallback(
    (event: MouseEvent) => {
      event.stopPropagation();
      if (onSelect) {
        onSelect();
      }
    },
    [onSelect],
  );
  const handleKey = useCallback(
    (event: KeyboardEvent) => {
      switch (event.key) {
        case 'Enter':
        case 'Space':
          if (onSelect) {
            onSelect();
          }
          break;
        case 'Escape':
          if (onDeselect) {
            onDeselect();
          }
          break;
      }
    },
    [onDeselect, onSelect],
  );
  const makeCardSelected = selected || dropTarget || dropAccepted;
 
  return (
    <div
      className={css(stacked && styles.stacked)}
      onClick={handleClick}
      onKeyDown={handleKey}
      ref={ref}
      {...props}
    >
      <Card
        isCompact={true}
        className={css(
          styles.card,
          noShadows && styles.noShadows,
          dropAccepted && !dropTarget && styles.dropAccepted,
          dropTarget && styles.dropTarget,
        )}
        isSelected={makeCardSelected}
        isSelectable={makeCardSelected || selectable}
        aria-label={title}
      >
        {(title || actions) && (
          <CardHeader data-codemods="true" className={css(styles.head)}>
            <CardActions className={css(styles.actions)}>
              {actions?.filter((a) => a)}
            </CardActions>
            {title && (
              <CardTitle className={css(styles.header)}>
                <Button
                  variant={'plain'}
                  onClick={toggleExpanded}
                  aria-label={'Expand/collapse this card'}
                  data-testid={`expand-collapse-${title}-button`}
                  className={css(styles.headerButton)}
                >
                  <Title size="lg" headingLevel={'h2'} aria-label={title}>
                    <TruncatedString title={title}>
                      {isExpanded ? <AngleDownIcon /> : <AngleRightIcon />}{' '}
                      {title}
                    </TruncatedString>
                  </Title>
                </Button>
              </CardTitle>
            )}
          </CardHeader>
        )}
        <CardBody
          className={css(
            noPadding ? styles.bodyNoPadding : styles.bodyWithPadding,
            !isExpanded && styles.hidden,
          )}
        >
          {children}
        </CardBody>
        {footer}
      </Card>
    </div>
  );
});