# All files / src/icon MaterialSymbolsProvider.tsx

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

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

     "use client";
    import {
      createContext,
      useContext,
      useMemo,
      type CSSProperties,
      type ReactElement,
      type ReactNode,
    } from "react";
    import { type MaterialSymbolFamily } from "./material.js";

    /**
     * Fill gives you the ability to modify the default icon style. A single icon
     * can render both unfilled and filled states.
     *
     * To convey a state transition, use the fill axis for animation or
     * interaction. The values are 0 for default or 1 for completely filled. Along
     * with the weight axis, the fill also impacts the look of the icon.
     *
     * @remarks \@since 6.0.0
     */
    export type MaterialSymbolFill = 0 | 1;

    /**
     * Weight defines the symbol’s stroke weight, with a range of weights between
     * thin (100) and bold (700). Weight can also affect the overall size of the
     * symbol.
     *
     * @remarks \@since 6.0.0
     */
    export type MaterialSymbolWeight = 100 | 200 | 300 | 400 | 500 | 600 | 700;

    /**
     * Weight and grade affect a symbol’s thickness. Adjustments to grade are more
     * granular than adjustments to weight and have a small impact on the size of
     * the symbol.
     *
     * Grade is also available in some text fonts. You can match grade levels
     * between text and symbols for a harmonious visual effect. For example, if
     * the text font has a -25 grade value, the symbols can match it with a
     * suitable value, say -25.
     *
     * You can use grade for different needs:
     *
     * - Low emphasis (e.g. -25 grade): To reduce glare for a light symbol on a
     *   dark background, use a low grade.
     * - High emphasis (e.g. 200 grade): To highlight a symbol, increase the
     *   positive grade.
     *
     * @remarks \@since 6.0.0
     */
    export type MaterialSymbolGrade = -25 | 0 | 200;

    /**
     * Optical Sizes range from 20dp to 48dp.
     *
     * For the image to look the same at different sizes, the stroke weight
     * (thickness) changes as the icon size scales. Optical Size offers a way to
     * automatically adjust the stroke weight when you increase or decrease the
     * symbol size.
     *
     * @remarks \@since 6.0.0
     */
    export type MaterialSymbolOpticalSize = 20 | 24 | 40 | 48;

    /**
     * The comments for each customizable part was copied from
     * https://fonts.google.com/icons?icon.set=Material+Symbols and clicking the
     * info icon next to each property.
     *
     * @see https://fonts.google.com/icons?icon.set=Material+Symbols
     * @remarks \@since 6.0.0
     */
    export interface MaterialSymbolCustomization {
      /**
       * Fill gives you the ability to modify the default icon style. A single icon
       * can render both unfilled and filled states.
       *
       * To convey a state transition, use the fill axis for animation or
       * interaction. The values are 0 for default or 1 for completely filled. Along
       * with the weight axis, the fill also impacts the look of the icon.
       *
       * @defaultValue `0`
       */
      fill?: MaterialSymbolFill;

      /**
       * Weight defines the symbol’s stroke weight, with a range of weights between
       * thin (100) and bold (700). Weight can also affect the overall size of the
       * symbol.
       *
       * @defaultValue `400`
       */
      weight?: MaterialSymbolWeight;

      /**
       * Weight and grade affect a symbol’s thickness. Adjustments to grade are more
       * granular than adjustments to weight and have a small impact on the size of
       * the symbol.
       *
       * Grade is also available in some text fonts. You can match grade levels
       * between text and symbols for a harmonious visual effect. For example, if
       * the text font has a -25 grade value, the symbols can match it with a
       * suitable value, say -25.
       *
       * You can use grade for different needs:
       *
       * - Low emphasis (e.g. -25 grade): To reduce glare for a light symbol on a
       *   dark background, use a low grade.
       * - High emphasis (e.g. 200 grade): To highlight a symbol, increase the
       *   positive grade.
       *
       * @defaultValue `0`
       */
      grade?: MaterialSymbolGrade;

      /**
       * Optical Sizes range from 20dp to 48dp.
       *
       * For the image to look the same at different sizes, the stroke weight
       * (thickness) changes as the icon size scales. Optical Size offers a way to
       * automatically adjust the stroke weight when you increase or decrease the
       * symbol size.
       *
       * @defaultValue `48`
       */
      opticalSize?: MaterialSymbolOpticalSize;

      /**
       * @defaultValue `"outlined"`
       */
      family?: MaterialSymbolFamily;
    }

    /**
     * @remarks \@since 6.0.0
     */
    export type MaterialSymbolConfiguration = Required<MaterialSymbolCustomization>;

    const context = createContext<MaterialSymbolConfiguration>({
      fill: 0,
      weight: 400,
      grade: 0,
      opticalSize: 24,
      family: "outlined",
    });
    context.displayName = "MaterialSymbol";
    const { Provider } = context;

    /**
     * @remarks \@since 6.0.0
     */
    export function useMaterialSymbolConfiguration(): MaterialSymbolConfiguration {
      return useContext(context);
    }

    /**
     * @remarks \@since 6.0.0
     */
    export function useFontVariationSettings(
      options: MaterialSymbolCustomization & { style?: CSSProperties }
    ): { style?: CSSProperties; family: MaterialSymbolFamily } {
      const configuration = useMaterialSymbolConfiguration();
      let { style } = options;
      const {
        fill = configuration.fill,
        grade = configuration.grade,
        opticalSize = configuration.opticalSize,
        weight = configuration.weight,
        family = configuration.family,
      } = options;
      if (
        !style?.fontVariationSettings &&
        (fill !== configuration.fill ||
          grade !== configuration.grade ||
          opticalSize !== configuration.opticalSize ||
          weight !== configuration.weight)
      ) {
        style = {
          ...style,
          fontVariationSettings: `"FILL" ${fill}, "wght" ${weight}, "GRAD" ${grade}, "opsz" ${opticalSize}`,
        };
      }

      return { family, style };
    }

    /**
     * @remarks \@since 6.0.0
     */
    export interface MaterialSymbolsProviderProps
      extends MaterialSymbolCustomization {
      children: ReactNode;
    }

    /**
     * **Client Component**
     *
     * @remarks \@since 6.0.0
     */
    export function MaterialSymbolsProvider(
      props: MaterialSymbolsProviderProps
    ): ReactElement {
      const {
        fill = 0,
        weight = 400,
        grade = 0,
        family: type = "outlined",
        opticalSize = 48,
        children,
      } = props;
      const value = useMemo<MaterialSymbolConfiguration>(
        () => ({
          fill,
          weight,
          grade,
          family: type,
          opticalSize,
        }),
        [fill, grade, opticalSize, type, weight]
      );

      return <Provider value={value}>{children}</Provider>;
    }