gatsby-plugin-material-symbols v1.0.3

gatsby-plugin-material-symbols

This plugin exposes a component that you can use in your Gatsby site to add a Material Symbol in a single element.

Behind the scenes, the plugin performs several optimizations at build-time to make the FOIT as quick as possible. In most cases, the plugin removes FOIT all-together, instead opting to delay FCP by a few milliseconds.

How to install

1. Install gatsby-plugin-material-symbols via NPM

   npm install gatsby-plugin-material-symbols

2. Add the plugin to your gatsby-config file

   {
     plugins: [
       "gatsby-plugin-material-symbols"
     ]
   }

3. Import the MaterialSymbol component and use it in your site

   import { MaterialSymbol } from "gatsby-plugin-material-symbols"
   
   export function Page() {
     return <MaterialSymbol icon="search" />
   }

Component props

symbol

Which symbol you'd like to use.

• Default: undefined (must be defined)

!TIP Want to find symbols to use? See the Material Symbols catalogue website. Look for a codepoint once you've found the symbol you want to use.

fill

Should the symbol be filled?

• Default: false
• Accepted types: - true: The symbol is filled - false: The symbol is not filled (hollow)

weight

The weight (at least initially) of the symbol.

• Default: 400
• Accepted types: - MaterialSymbolWeight: A weight

grade

The grade (at least initally) of the symbol.

• Default: 0
• Accepted types: - MaterialSymbolGrade: A grade

size

The size (at least initially) of the symbol.

• Default: inherit
• Accepted types: - number: A size

symbolStyle

Which style the symbol should be.

• Default: 'outlined'
• Accepted types: - 'outlined': The outlined style - 'rounded': The rounded style - 'sharp': The sharp style

!TIP Curious about what each style looks like? You can see on the Material Design website or on the Material Symbols catalogue if you prefer.

removeInlineStyles

Whether or not to remove variable font axes being set per element in the style tag.

• Deafult: false
• Accepted types: - true: Inline styles are removed. You will have to apply the variable font axes yourself - false: Specified variable font axes are set per element via the style tag

!TIP All Material Symbols have 2 classes you can use to style them by default: material-symbol and material-symbol-{symbolStyle}, as well as any others you choose to pass.

Options

embedFonts

Whether to embed the font file(s) into the site's CSS as base64.

• Default: true
• Accepted types: - true: All fonts are embedded in CSS - false: Links to the fonts on gstatic.com which will add more network requests, but make FCP a bit quicker and add a FOIT to all Material Symbols

extraIcons

A list of additional icons to always include, even if they are not found during static analysis. This is useful if you change an icon at runtime, which will not be caught during static analysis. You can optionally include which style the added icon should be associated with. If an added icon is associated with one style, it will not be included in the font(s) for other styles.

• Default: []
• Accepted types: - MaterialSymbolCodepoints[]: A list of codepoints to additionally include in all icon styles - Record<"outlined" | "rounded" | "sharp", MaterialSymbolCodepoints[] | MaterialSymbolCodepoints>: A list of styles and which Material Symbols to always include in the given style

includeFill

Whether or not to always include the entirety of the FILL axis in all styles.

• Default: false
• Accepted types: - true: Always include the entirety of the FILL axis in all font(s) - false: Only include the extents of the FILL axis found during static analysis

weightRange

A range of weights to always include in all styles.

• Default: []
• Accepted types: - MaterialSymbolWeight[]: A range of weights to always include in all styles. Minimum = 100, Maximum = 700 - Example of a range: [210, 600]

gradeRange

A range of grades to always include in all styles.

• Default: []
• Accepted types: - MaterialSymbolGrade[]: A range of grades to always include in all styles. Minimum = 0, Maximum = 225 - Example of a range: [0, 110]

sizeRange

A range of optical sizes to always include in all styles.

• Default: []
• Accepted types: - number[]: A range of optical sizes to always include in all styles. Minimum = 5, Maximum = 1200. Decimal places are allowed - Example of a range: [12.5, 64]

extraStyles

A list of additional styles to always include, even if they are found during static analysis. This is useful if you change a style at runtime, which will not be caught during static analysis.

• Default: []
• Accepted types: - Array<"outlined" | "rounded" | "sharp">: A list of additional styles to always include

!TIP Curious about what each style looks like? You can see on the Material Design website or on the Material Symbols catalogue if you prefer.

verbose

Prints useful or interesting information to the console.

• Default: false
• Accepted types: - true: Prints information to the console - false: Do not print anything to the console relating to gatsby-plugin-material-symbols

Performance optimizations

When requesting assets from the Google Fonts CSS API, you can add several parameters to any given query to trim down the size of the returned font file. Most don't do this because it's pretty annoying to write a script to collect every icon you're using in your site, but doing so is certainly worth it.

With all icons and the full extent of all variable axes included (which is the default font file distributed by Google Fonts), MaterialSymbolsOutlined[FILL,GRAD,opsz,wght].woff2 comes out to 3.16 MB. That's a massive file for any user to download, especially considering you're probably only using a couple dozen of the 3,738 icons included in the font file.

By removing unused variable axes, in this example to only include FILL@1, opsz@20..48, wght@500 and GRAD@0..200, we can cut the font's file size from 3.16 MB to 1.64 MB (1.92x smaller).

Then by only including icons which are used, in this example add, arrow_forward, close, delete, forward, fullscreen, home, menu, open_in_full, open_in_new, redo, refresh, reply, search, star, undo, we can further reduce the font's file size from 1.64 MB to 6.42 KB (255.45x smaller).

Overall, that's a reduction from 3.16 MB to 6.42 KB (504.75x smaller). Yes, really.

By making the font file 500x smaller, Material Symbols go from being quite a large burden (the size of a high-quality image) to probably being smaller than most of the JavaScript you're loading on your site.

Contributing

See CONTRIBUTING.md for instructions on how to contribute changes.