react with async fonts

reagieren mit async-fonts

React -Modul für die Arbeit mit async geladenen benutzerdefinierten Web -Schriftarten basierend auf fontfaceobserver .

HINWEIS: Version 4.x führt brechen Änderungen mit neuer API ein. Es befasst sich mit einer Reihe von Problemen, einschließlich der Absage von Versprechen, besseren Leistung und TS -Typierungen.

• Schneller Start
• API
  • FontObserver -Komponente
  • FontSubscriber -Komponente
  • withFonts hoc
  • Font Typ
• Beispiele
  • Basic mit FontSubscriber
  • Einfach mit withFonts
  • Mit styled-components
  • Verschachtelter FontObserver
  • Benutzerdefinierte fontfaceobserver -Optionen
• Lizenz

Schneller Start

1. Installieren Sie react-with-async-fonts :

NPM:

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

Garn:

yarn add react-with-async-fonts

2. Wickeln Sie Ihre Root -Komponente mit FontObserver :

Setzen Sie die Prop mit Schriftart. Sie können später in FontSubscriber darauf zugreifen, um zu überprüfen, ob es fertig ist.

 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. Wickeln Sie Ihr Ziel mit FontSubscriber -Komponente ein:

TIPP: Sie können auch withFonts -API verwenden, wenn Sie sich wirklich für hohswerte HOCs interessieren.

Beachten Sie, dass FontSubscriber Kinder -Render -Requisiten verwendet. Vorausgesetzt, die Funktion würde mit einem einzigen Argument aufgerufen, das ein Objekt mit geladenen Schriftschlüssel ist.

 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 -Komponente

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

Stütze	Typ	Beschreibung
text	string	fontfaceobserver .LOAD .load
timeout	number	fontfaceobserver .load -Zeitüberschreitungsoptionen
[key]	Font | string	Schriftfamilie Schnur oder ein Font Objekt.

FontSubscriber -Komponente

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

Stütze	Typ	Beschreibung
children	(fonts: Object) => React.Element<any>	Kinder machen Funktionen. Akzeptiert Objekt mit geladener Schrift. Sobald es fertig ist, würde es ein Objekt des Font enthalten.

withFonts hoc

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

Argument	Typ	Beschreibung
Komponente	React.ComponentType<any>	Komponente zum Wickeln mit hoc. Injiziert fonts .

Font Typ

 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' ,
} ; 

Beispiele

Kopf hoch! Jedes Beispiel erfordert, dass Sie Ihre App mit FontObserver einwickeln:

 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' ) ,
) ;

Basic mit 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 ;

Einfach mit withFonts

Sie können withFonts hoc verwenden, wenn Sie Ihre Komponente komponieren möchten. Bitte beachten Sie, dass dieselbe FontSubscriber unter der Motorhaube verwendet wird.

 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 ) ;

Mit styled-components

Die eleganteste Art, es mit styled-components zu verwenden, ist 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 ) ;

Verschachtelter FontObserver

Sie können FontObserver nisten, um Schriftarten zusammenzuführen. Kinderinstanzen außer Kraft gesetzt, wenn eine Schriftart mit demselben Code definiert wurde.

 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 ;

Benutzerdefinierte fontfaceobserver -Optionen

Sie können text und timeout für die LOAD -Methode von fontfaceobserver mit denselben Requisiten bereitstellen.

 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 ; 

Lizenz

Mit © Sergey Bekrin