@fontsource/open-sans

What is @fontsource/open-sans?

@fontsource/open-sans is an npm package that allows you to self-host the Open Sans font in your web projects. It provides a convenient way to include the font in your project without relying on external CDNs, ensuring better performance and control over the font loading process.

What are @fontsource/open-sans's main functionalities?

Basic Usage

This code imports the default weight and style of the Open Sans font into your project.

import '@fontsource/open-sans';

Specific Weight and Style

This code imports specific weights (400 and 700) of the Open Sans font, allowing you to use different font weights in your project.

import '@fontsource/open-sans/400.css';
import '@fontsource/open-sans/700.css';

Variable Fonts

This code imports the variable font version of Open Sans, which allows for more flexible and responsive typography.

import '@fontsource/open-sans/variable.css';

Subsetting

This code imports only the Latin subset of the Open Sans font, which can reduce the font file size and improve loading times if you only need Latin characters.

import '@fontsource/open-sans/latin.css';

Other packages similar to @fontsource/open-sans

@fontsource/roboto

@fontsource/roboto provides the Roboto font in a similar manner to @fontsource/open-sans. It allows you to self-host the Roboto font, offering various weights, styles, and subsets for better performance and control.

typeface-open-sans

typeface-open-sans is another package that allows you to self-host the Open Sans font. It is similar to @fontsource/open-sans but may not offer as many customization options or subsets.

@fontsource/lato

@fontsource/lato provides the Lato font, another popular sans-serif typeface. It offers similar features to @fontsource/open-sans, including various weights, styles, and subsets for self-hosting.

README

Fontsource Open Sans

The CSS and web font files to easily self-host the “Open Sans” font. Please visit the main Fontsource monorepo to view more details on this package.

Installation

Fontsource assumes you are using a bundler, such as Webpack, to load in CSS. Solutions like CRA, Gatsby and Next.js are prebuilt examples that are compatible.

yarn add @fontsource/open-sans // npm install @fontsource/open-sans

Then within your app entry file or site component, import it in. For example in Gatsby, you could choose to import it into a layout template (layout.js), page component (index.js), or gatsby-browser.js.

import "@fontsource/open-sans" // Defaults to weight 400.

Fontsource allows you to select weights and even individual styles, allowing you to cut down on payload sizes to the last byte! Utilizing the CSS unicode-range selector, all language subsets are accounted for.

import "@fontsource/open-sans/500.css" // Weight 500.
import "@fontsource/open-sans/900-italic.css" // Italic variant.

Alternatively, the same solutions could be imported via SCSS!

@import "~@fontsource/open-sans/index.css"; // Weight 400.
@import "~@fontsource/open-sans/300-italic.css";

For more advanced setups, you can use our highly customisable Sass mixins that can modify many of the existing @font-face variables.

@import "~@fontsource/open-sans/scss/mixins";

// Uses a unicode-range map to automatically generate multiple @font-face rules.
@include fontFace(
  $weight: 500,
  $display: fallback,
  $fontDir: "~@fontsource/open-sans/files"
);

// Fully customisable single @font-face mixin.
@include fontFaceCustom(
  $weight: 600,
  $display: optional,
  $woff2Path: "#{$fontDir}/custom-file.woff2",
  $unicodeRange: false
);
// More options available in link below.

We also have default variables that you can use!

@import "~@fontsource/open-sans/scss/mixins";

$style: italic;

@include fontFace($weight: 500);
@include fontFace($weight: 600);

// Applies italic to both @includes.

You can see all of the existing inputtable mixin variables here.

These examples may not reflect actual compatibility. Please refer below.

Supported variables:

• Weights: [300,400,600,700,800]
• Styles: [italic,normal]

Finally, you can reference the font name in a CSS stylesheet, CSS Module, or CSS-in-JS.

body {
  font-family: "Open Sans";
}

Additional Options

In the rare case you need to individually select a language subset and not utilize the CSS unicode-range selector, you may specify the import as follows. This is especially not recommended for languages, such as Japanese, with a large amount of characters.

import "@fontsource/open-sans/latin-ext.css" // All weights with normal style included.
import "@fontsource/open-sans/cyrillic-ext-500.css" // Weight 500 with normal style.
import "@fontsource/open-sans/greek-900-italic.css" // Italic variant.

• Supported subsets: [cyrillic,cyrillic-ext,greek,greek-ext,latin,latin-ext,vietnamese]

Licensing

It is important to always read the license for every font that you use. Most of the fonts in the collection use the SIL Open Font License, v1.1. Some fonts use the Apache 2 license. The Ubuntu fonts use the Ubuntu Font License v1.0.

Google Fonts License Attributions

Other Notes

Font version (provided by source): v18.

Feel free to star and contribute new ideas to this repository that aim to improve the performance of font loading, as well as expanding the existing library we already have. Any suggestions or ideas can be voiced via an issue.