# All files / src/box Box.tsx

100% Statements 152/152
100% Branches 1/1
100% Functions 1/1
100% Lines 152/152

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
    1531x
    1x
    1x
    1x
    1x
    1x
    1x
    1x
    1x
    1x
    1x
    1x
    1x
    1x
    1x
    1x
    1x
    1x
    1x
    1x
    1x
    1x
    1x
    1x
    1x
    1x
    1x
    1x
    1x
    1x
    1x
    1x
    1x
    1x
    1x
    1x
    1x
    1x
    1x
    1x
    1x
    1x
    1x
    1x
    1x
    1x
    1x
    1x
    1x
    1x
    1x
    1x
    1x
    1x
    1x
    1x
    1x
    1x
    1x
    1x
    1x
    1x
    1x
    1x
    1x
    1x
    1x
    1x
    1x
    1x
    1x
    1x
    1x
    1x
    1x
    1x
    1x
    1x
    1x
    1x
    1x
    1x
    1x
    1x
    1x
    1x
    1x
    1x
    1x
    1x
    1x
    1x
    1x
    1x
    1x
    1x
    1x
    1x
    1x
    1x
    1x
    1x
    1x
    1x
    1x
    1x
    1x
    1x
    1x
    1x
    1x
    1x
    1x
    3x
    3x
    3x
    3x
    3x
    3x
    3x
    3x
    3x
    3x
    3x
    3x
    3x
    3x
    3x
    3x
    3x
    3x
    3x
    3x
    3x
    3x
    3x
    3x
    3x
    3x
    3x
    3x
    3x
    3x
    3x
    3x
    3x
    3x
    3x
    3x
    3x
    3x
    1x
     import { forwardRef, type HTMLAttributes } from "react";
    import { box, type BoxOptions } from "./styles.js";

    /**
     * @remarks \@since 6.0.0
     */
    export interface BoxProps extends HTMLAttributes<HTMLDivElement>, BoxOptions {}

    /**
     * **Server Component**
     *
     * The `Box` component is a wrapper around the CSS box model and should solve
     * most of your `flex` and `grid` layout requirements for responsive design.
     * There are pass-through props for all of the box module styling properties
     * available by default.
     *
     * @example
     * Default Styles
     * ```scss
     * .box {
     *   align-items: center;
     *   display: flex;
     *   flex-wrap: wrap;
     *   gap: 1rem;
     *   padding: 1rem;
     * }
     * ```
     *
     * ```tsx
     * import { Box } from "@react-md/core";
     * import type { ReactElement } from "react";
     *
     * export default function Example(): ReactElement {
     *   return (
     *     <Box>
     *       <div>Thing 1</div>
     *       <div>Thing 2</div>
     *       <div>Thing 3</div>
     *       <div>Thing 4</div>
     *       <div>Thing 5</div>
     *     </Box>
     *   ):
     * }
     * ```
     *
     * @example
     * Default Grid Styles
     * ```scss
     * .box {
     *   align-items: center;
     *   display: grid;
     *   grid-gap: 1rem;
     *   grid-template-columns: repeat(auto-fit, minmax(8rem, 1fr));
     *   padding: 1rem;
     * }
     * ```
     *
     * ```tsx
     * import { Box } from "@react-md/core";
     * import type { ReactElement } from "react";
     *
     * export default function Example(): ReactElement {
     *   return (
     *     <Box grid>
     *       <div>Thing 1</div>
     *       <div>Thing 2</div>
     *       <div>Thing 3</div>
     *       <div>Thing 4</div>
     *       <div>Thing 5</div>
     *     </Box>
     *   ):
     * }
     * ```
     *
     * @example
     * Custom Grid
     * ```scss
     * @use "@react-md/core" with (
     *   $grids: (
     *     small: (
     *       min: 5rem,
     *     ),
     *     medium: (
     *       min: 7rem,
     *       padding: 2rem,
     *       gap: 0.5rem,
     *     ),
     *   )
     * );
     *
     * ```
     *
     * ```tsx
     * import { Box } from "@react-md/core";
     * import type { ReactElement } from "react";
     *
     * export default function Example(): ReactElement {
     *   return (
     *     <Box grid gridName="medium">
     *       <div>Thing 1</div>
     *       <div>Thing 2</div>
     *       <div>Thing 3</div>
     *       <div>Thing 4</div>
     *       <div>Thing 5</div>
     *     </Box>
     *   ):
     * }
     * ```
     *
     * @remarks \@since 6.0.0
     */
    export const Box = forwardRef<HTMLDivElement, BoxProps>(
      function Box(props, ref) {
        const {
          className,
          children,
          align,
          grid = false,
          gridName = "",
          justify,
          stacked = false,
          reversed = false,
          gridColumns = "fit",
          fullWidth = false,
          disableWrap = false,
          disablePadding = false,
          ...remaining
        } = props;

        return (
          <div
            {...remaining}
            ref={ref}
            className={box({
              className,
              fullWidth,
              grid,
              stacked,
              gridName,
              gridColumns,
              align,
              justify,
              reversed,
              disableWrap,
              disablePadding,
            })}
          >
            {children}
          </div>
        );
      }
    );