react with async fonts

反应与assync-fonts

React模块，用于基于fontfaceobserver异步加载的自定义Web字体。

注意：版本4.x引入了新API的破坏变化。它解决了许多问题，包括取消承诺，更好的性能和TS打字。

• 快速开始
• API
  • FontObserver组件
  • FontSubscriber组件
  • withFonts Hoc
  • Font类型
• 例子
  • 基本的FontSubscriber
  • 基本with withFonts
  • 带有styled-components
  • 嵌套的FontObserver
  • 自定义fontfaceobserver选项
• 执照

快速开始

1. 安装react-with-async-fonts ：

NPM：

npm install --save react-with-async-fonts

纱：

yarn add react-with-async-fonts

2. 用FontObserver包裹根部组件：

用字体名称设置道具。您可以稍后在FontSubscriber中访问它，以检查是否准备就绪。

 import { FontObserver } from 'react-with-async-fonts' ;
import { render } from 'react-dom' ;
import App from './app' ;

render (
  < FontObserver openSans = "Open Sans" >
    < App />
  </ FontObserver > ,
  document . getElementById ( 'root' ) ,
) ;

3. 用FontSubscriber组件包装目标：

提示：如果您真的喜欢HOC，也可以withFonts API一起使用。

请注意， FontSubscriber使用儿童渲染道具。提供的函数将用单个参数调用，该参数是带有已加载字体键的对象。

 import { FontSubscriber } from 'react-with-async-fonts' ;

const Heading = ( { children } ) => (
  < FontSubscriber >
    { fonts => (
      < h1 className = { fonts . openSans ? 'opens-sans-font' : 'system-font' } >
        { children }
      </ h1 >
    ) }
  </ FontSubscriber >
) ;

export default Heading ; 

API

FontObserver组件

 import { FontObserver } from 'react-with-async-fonts' ;

支柱	类型	描述
text	string	fontfaceobserver 's .load文本选项
timeout	number	fontfaceobserver的.load超时选项
[key]	Font | string	字体族字符串或Font对象。

FontSubscriber组件

 import { FontSubscriber } from 'react-with-async-fonts' ;

支柱	类型	描述
children	(fonts: Object) => React.Element<any>	儿童渲染功能。接受带有加载字体的对象。准备好后，它将包含Font类型的对象。

withFonts Hoc

 import { withFonts } from 'react-with-async-fonts' ;

争论	类型	描述
成分	React.ComponentType<any>	与HOC包裹的组件。注入fonts对象。

Font类型

 type Font = {
  family : String ,
  weight ?:
    | 'normal'
    | 'bold'
    | 'bolder'
    | 'lighter'
    | '100'
    | '200'
    | '300'
    | '400'
    | '500'
    | '600'
    | '700'
    | '800'
    | '900' ,
  style ?: 'normal' | 'italic' | 'oblique' ,
  stretch ?:
    | 'normal'
    | 'ultra-condensed'
    | 'extra-condensed'
    | 'condensed'
    | 'semi-condensed'
    | 'semi-expanded'
    | 'expanded'
    | 'extra-expanded'
    | 'ultra-expanded' ,
} ; 

例子

小心！每个示例都需要用FontObserver包装您的应用程序：

 import React from 'react' ;
import { render } from 'react-dom' ;
import { FontObserver } from 'react-with-async-fonts' ;
import App from './app' ;

render (
  < FontObserver montserrat = "Montserrat" >
    < App />
  </ FontObserver > ,
  document . getElementById ( 'root' ) ,
) ;

基本的FontSubscriber

 import React from 'react' ;
import { FontSubscriber } from 'react-with-async-fonts' ;

const Heading = ( { children } ) => (
  < FontSubscriber >
    { fonts => (
      < h1 className = { fonts . montserrat && 'montserrat-font' } > { children } </ h1 >
    ) }
  </ FontSubscriber >
) ;

export default Heading ;

基本with withFonts

如果要组成组件，则可以withFonts HOC一起使用。请注意，它在引擎盖下使用相同的FontSubscriber 。

 import React from 'react' ;
import { withFonts } from 'react-with-async-fonts' ;

const Heading = ( { children , fonts } ) => (
  < h1 className = { fonts . montserrat && 'montserrat-font' } > { children } </ h1 >
) ;

export default withFonts ( Heading ) ;

带有styled-components

与styled-components一起使用的最优雅的方法是withFonts HOC一起使用。

 import styled from 'styled-components' ;
import { withFonts } from 'react-with-async-fonts' ;

const Heading = styled . h2 `
  font-weight: 300;
  font-family: ${ props =>
    props . fonts . montserrat
      ? '"Open Sans", sans-serif'
      : 'Helvetica, sans-serif' } ;
` ;

export default withFonts ( Heading ) ;

嵌套的FontObserver

您可以嵌套FontObserver合并字体。如果定义了具有相同代码的字体，则儿童实例将覆盖父级。

 import { FontObserver , FontSubscriber } from 'react-with-async-fonts' ;

const Article = ( { title , children } ) => (
  < FontObserver roboto = "Roboto" >
    < FontObserver ptSans = "PT Sans" >
      < FontSubscriber >
        { fonts => (
          < article >
            < h1 className = { fonts . roboto ? 'roboto' : 'sans-serif' } > { title } </ h1 >
            < p className = { fonts . ptSans ? 'ptsans' : 'serif' } > { children } </ p >
          </ article >
        ) }
      </ FontSubscriber >
    </ FontObserver >
  </ FontObserver >
) ;

export default Article ;

自定义fontfaceobserver选项

您可以为fontfaceobserver的.load方法提供具有相同道具的text和timeout选项。

 import { FontObserver , FontSubscriber } from 'react-with-async-fonts' ;

const Heading = ( { children } ) => (
  < FontObserver text = { children } timeout = { 2500 } roboto = "Roboto" >
    < FontSubscriber >
      { fonts => < h1 className = { fonts . roboto && 'roboto' } > { children } </ h1 > }
    </ FontSubscriber >
  </ FontObserver >
) ;

export default Heading ; 

执照

麻省理工学院©Sergey Bekrin