react with async fonts

reaksi-dengan-async-font

React Modul untuk bekerja dengan async dimuat font web khusus, berdasarkan fontfaceobserver .

Catatan: Versi 4.x memperkenalkan perubahan yang melanggar dengan API baru. Ini membahas banyak masalah, termasuk membatalkan janji, kinerja yang lebih baik, dan pengetikan TS.

• Awal yang cepat
• API
  • Komponen FontObserver
  • Komponen FontSubscriber
  • withFonts Hoc
  • Jenis Font
• Contoh
  • Dasar dengan FontSubscriber
  • Dasar dengan withFonts
  • Dengan styled-components
  • FontObserver bersarang
  • Opsi fontfaceobserver khusus
• Lisensi

Awal yang cepat

1. Instal react-with-async-fonts :

NPM:

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

benang:

yarn add react-with-async-fonts

2. Bungkus komponen root Anda dengan FontObserver :

Atur prop dengan nama font. Anda dapat mengaksesnya nanti di FontSubscriber untuk memeriksa apakah sudah siap.

 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. Bungkus target Anda dengan komponen FontSubscriber :

Kiat: Anda juga dapat menggunakan API withFonts jika Anda benar -benar menyukai HOC.

Perhatikan bahwa FontSubscriber menggunakan anak -anak Render Prop. Fungsi yang disediakan akan dipanggil dengan argumen tunggal yang merupakan objek dengan tombol font yang dimuat.

 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

Komponen FontObserver

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

Menopang	Jenis	Keterangan
text	string	Opsi Teks fontfaceobserver .load
timeout	number	fontfaceobserver Timeout .load
[key]	Font | string	String keluarga font atau objek Font .

Komponen FontSubscriber

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

Menopang	Jenis	Keterangan
children	(fonts: Object) => React.Element<any>	Fungsi Render Anak. Menerima objek dengan font yang dimuat. Setelah siap, itu akan berisi objek tipe Font .

withFonts Hoc

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

Argumen	Jenis	Keterangan
komponen	React.ComponentType<any>	Komponen untuk membungkus dengan hoc. Menyuntikkan objek fonts .

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

Contoh

Kepala! Setiap contoh membutuhkan pembungkus aplikasi Anda dengan 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' ) ,
) ;

Dasar dengan 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 ;

Dasar dengan withFonts

Anda dapat menggunakan withFonts Hoc jika Anda ingin menyusun komponen Anda. Harap dicatat menggunakan FontSubscriber yang sama di bawah kap.

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

Dengan styled-components

Cara paling elegan untuk menggunakannya dengan styled-components adalah 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 bersarang

Anda dapat menyarangkan FontObserver untuk menggabungkan font. Contoh anak -anak mengesampingkan orang tua jika font dengan kode yang sama didefinisikan.

 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 ;

Opsi fontfaceobserver khusus

Anda dapat memberikan opsi text dan timeout untuk metode fontfaceobserver .

 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 ; 

Lisensi

MIT © Sergey Bekrin