# All files / src/responsive-item ResponsiveItemContainer.tsx

100% Statements 181/181
100% Branches 2/2
100% Functions 2/2
100% Lines 181/181

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
    1821x
    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
    8x
    8x
    8x
    8x
    8x
    8x
    8x
    8x
    8x
    8x
    8x
    8x
    8x
    8x
    8x
    8x
    8x
    8x
    8x
    8x
    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
    7x
    7x
    7x
    7x
    7x
    7x
    7x
    7x
    7x
    7x
    7x
    7x
    7x
    7x
    7x
    7x
    7x
    7x
    7x
    7x
    7x
    7x
    7x
    7x
     import { cnb } from "cnbuilder";
    import { forwardRef, type HTMLAttributes } from "react";
    import { bem } from "../utils/bem.js";

    const styles = bem("rmd-responsive-item-container");

    /** @remarks \@since 6.0.0 */
    export interface ResponsiveItemContainerClassNameOptions {
      className?: string;

      /**
       * Set this to `true` if the container should gain the following styles:
       *
       * ```scss
       * display: block;
       * width: 100%;
       * ```
       *
       * @defaultValue `false`
       */
      fullWidth?: boolean;

      /**
       * Set this to a custom aspect ratio to use.
       *
       * @example
       * Valid Aspect Ratios
       * ```tsx
       * aspectRatio="16-9"
       * aspectRatio="9-16"
       * aspectRatio="3-4"
       * aspectRatio="4-3"
       * aspectRatio="1-1"
       * ```
       *
       * These values are based on the `core.$responsive-item-aspect-ratios` map.
       *
       * @defaultValue `""`
       */
      aspectRatio?: `${number}-${number}`;

      /**
       * Set this to `"manual"` if you want to manually specify which elements are
       * responsive items using custom class names. You probably don't really want
       * to use this.
       *
       * Set this to `"auto"` to automatically update all visual media that appear
       * as a child in this component to a responsive item.
       *
       * Set this to `"container"` to automatically update all visual media that
       * appear as a child in this component to be a responsive item that scales to
       * the container's dimensions.
       *
       * Note: The `"auto"` and `"container"` values use the
       * `core.$responsive-item-selectors` value for their behavior.
       *
       * @defaultValue `"auto"`
       */
      responsive?: "auto" | "manual" | "container";
    }

    /** @remarks \@since 6.0.0 */
    export function responsiveItemContainer(
      options: ResponsiveItemContainerClassNameOptions = {}
    ): string {
      const {
        className,
        fullWidth = false,
        aspectRatio = "",
        responsive = "auto",
      } = options;

      return cnb(
        styles({
          auto: responsive !== "manual",
          "auto-scale": responsive === "container",
          "aspect-ratio": aspectRatio,
          [aspectRatio]: aspectRatio,
          "full-width": fullWidth,
        }),
        className
      );
    }

    /**
     * @remarks
     * \@since 6.0.0 Renamed from `MediaContainerProps` to
     * `ResponsiveItemContainerProps`
     * \@since 6.0.0 The `height` and `width` props were removed in favor of the
     * `aspectRatio` props since the latest typescript string interpolation supports
     * enforcing the correct format.
     * \@since 6.0.0 The `auto` prop was removed in favor of the new
     * {@link ResponsiveItemContainerProps.responsive} prop.
     */
    export interface ResponsiveItemContainerProps
      extends HTMLAttributes<HTMLSpanElement>,
        ResponsiveItemContainerClassNameOptions {}

    /**
     * **Server Component**
     *
     * @example
     * Image Example
     * ```tsx
     * import { ResponsiveItemContainer } from "@react-md/core";
     * import type { ReactElement } from "react";
     *
     * function Example(): ReactElement {
     *   return (
     *     <ResponsiveItemContainer>
     *       <img alt="" src="/some-image.png" />
     *     </ResponsiveItemContainer>
     *   );
     * }
     * ```
     *
     * @example
     * Iframe Example
     * ```tsx
     * import { ResponsiveItemContainer } from "@react-md/core";
     * import type { ReactElement } from "react";
     *
     * function Example(): ReactElement {
     *   return (
     *     <ResponsiveItemContainer>
     *       <iframe
     *         src="https://youtube.com/some-video-url"
     *         title="Some YouTube video"
     *         allowFullScreen
     *       />
     *     </ResponsiveItemContainer>
     *   );
     * }
     * ```
     *
     * @example
     * Forced Aspect Ratio
     * ```tsx
     * import { ResponsiveItemContainer } from "@react-md/core";
     * import type { ReactElement } from "react";
     *
     * function Example(): ReactElement {
     *   return (
     *     <ResponsiveItemContainer aspectRatio="16-9">
     *       <img alt="" src="/some-image.png" />
     *     </ResponsiveItemContainer>
     *   );
     * }
     * ```
     *
     * @remarks \@since 6.0.0 Renamed from `MediaContainer` to
     * `ResponsiveItemContainer` and renders a `<span>` instead of a `<div>`.
     */
    export const ResponsiveItemContainer = forwardRef<
      HTMLSpanElement,
      ResponsiveItemContainerProps
    >(function ResponsiveItemContainer(props, ref) {
      const {
        className,
        fullWidth = false,
        aspectRatio,
        responsive = "auto",
        children,
        ...remaining
      } = props;

      return (
        <span
          {...remaining}
          ref={ref}
          className={responsiveItemContainer({
            className,
            fullWidth,
            aspectRatio,
            responsive,
          })}
        >
          {children}
        </span>
      );
    });