# All files / src/form SliderValueMarks.tsx

0% Statements 0/220
0% Branches 0/1
0% Functions 0/1
0% Lines 0/220

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

     import {
      Fragment,
      type HTMLAttributes,
      type ReactElement,
      type ReactNode,
    } from "react";
    import { getPercentage } from "../utils/getPercentage.js";
    import {
      getRangeSteps,
      type RangeStepsOptions,
    } from "../utils/getRangeSteps.js";
    import { SliderMark } from "./SliderMark.js";
    import {
      SliderMarkLabel,
      type CustomizableSliderMarkLabelProps,
    } from "./SliderMarkLabel.js";

    /**
     * @remarks \@since 6.0.0
     */
    export interface SliderValueMark {
      /**
       * An optional label to display alongside the current mark. This will be
       * positioned below the mark for horizontal sliders and to the right for
       * vertical sliders.
       */
      label?: ReactNode;

      /**
       * The value of the mark that should be a valid step within the slider.
       */
      value: number;
    }

    /**
     * @remarks \@since 6.0.0
     */
    export interface SliderValueMarkState {
      /** The {@link SliderValueMark.value} */
      value: number;

      /**
       * No idea if this is actually useful (maybe custom styles?), but it is the
       * current percentage the mark is offset and is what is set as the
       * `left`/`top` values for the mark.
       */
      offset: string;

      /**
       * This will be `true` when the mark is being covered by the slider track's
       * active state.
       */
      active: boolean;
    }

    /**
     * @remarks \@since 6.0.0
     */
    export interface SliderMarksOptions {
      /**
       * Set this to `true` to display a mark for each step within the slider. This
       * can be used alongside the {@link getMarkProps} and
       * {@link getMarkLabelProps} to customize the styles or display a label for
       * the mark.
       *
       * @example
       * Custom Marks
       * ```tsx
       * const slider = useSlider({ step: 10 });
       *
       * <Slider
       *   {...slider}
       *   marks={[
       *     { value: 0, label: "Minimum" },
       *     { value: 10 },
       *     { value: 20 },
       *     { value: 30 },
       *     { value: 40 },
       *     { value: 50, label: "Medium" },
       *     { value: 60 },
       *     { value: 70 },
       *     { value: 80 },
       *     { value: 90 },
       *     { value: 100, label: "Maximum" },
       *   ]}
       * />
       * ```
       */
      marks?: boolean | readonly SliderValueMark[];

      /**
       * This can be used to override any styles for the specific mark.
       */
      getMarkProps?(
        options: SliderValueMarkState
      ): HTMLAttributes<HTMLSpanElement> | void;

      /**
       * This can be used to override any styles for a specific mark's label or
       * display a label dynamically.
       *
       * @example
       * Dynamic Labels
       * ```tsx
       * <Slider
       *   {...slider}
       *   marks
       *   getMarkLabelProps={({ active, value }) => {
       *     if (value % 10 !== 0) {
       *       return;
       *     }
       *
       *     return {
       *       children: `${value} degrees`,
       *       className: cnb(active && styles.somethingCustom),
       *     };
       *   }}
       * />
       * ```
       */
      getMarkLabelProps?(
        options: SliderValueMarkState
      ): Partial<CustomizableSliderMarkLabelProps> | void;
    }

    /**
     * @internal
     * @remarks \@since 6.0.0
     */
    export interface SliderValueMarksProps
      extends RangeStepsOptions,
        Required<SliderMarksOptions> {
      vertical: boolean;
      thumb1Value: number;
      thumb2Value: number;
      isRangeSlider: boolean;
    }

    /**
     * **Server Component**
     *
     * @internal
     * @remarks \@since 6.0.0
     */
    export function SliderValueMarks(props: SliderValueMarksProps): ReactElement {
      const {
        min,
        max,
        step,
        marks: propMarks,
        vertical,
        thumb1Value,
        thumb2Value,
        isRangeSlider,
        getMarkProps,
        getMarkLabelProps,
      } = props;

      let marks: readonly SliderValueMark[];
      if (typeof propMarks === "boolean") {
        const steps = getRangeSteps({ min, max, step }) + 1;
        marks = Array.from({ length: steps }, (_, i) => ({
          value: min + i * step,
        }));
      } else {
        marks = propMarks;
      }

      return (
        <>
          {marks.map(({ value, label: markLabel }) => {
            // I can't think of a good name, but this is when the slider's track's
            // active color is covering the mark which requires different styles
            let active: boolean;
            let percentage = getPercentage({ min, max, value }) * 100;
            let markValue = value;
            if (vertical) {
              // need to reverse the percentage since it uses `top` for positioning
              // where the max value is at the top instead of bottom
              percentage = 100 - percentage;

              // need to reverse the mark's value as well for the same reason as
              // above
              markValue = max - value;
            }

            if (isRangeSlider) {
              active = markValue > thumb1Value && markValue < thumb2Value;
            } else {
              active = markValue < thumb1Value;
            }

            const offset = `${percentage}%`;
            const markProps = getMarkProps({ value, active, offset });
            const labelProps = getMarkLabelProps({ value, active, offset });
            const label = markLabel ?? labelProps?.children ?? null;

            return (
              <Fragment key={value}>
                <SliderMark
                  {...markProps}
                  offset={offset}
                  active={active}
                  vertical={vertical}
                />
                {label !== null && (
                  <SliderMarkLabel
                    {...labelProps}
                    offset={offset}
                    vertical={vertical}
                  >
                    {label}
                  </SliderMarkLabel>
                )}
              </Fragment>
            );
          })}
        </>
      );
    }