react with async fonts

React-with-async-fontes

Módulo React para trabalhar com fontes da Web personalizadas carregadas com assíncronas, com base no fontfaceobserver .

Nota: Versão 4.x apresenta mudanças de quebra com a nova API. Ele aborda o grupo de questões, incluindo cancelamento de promessas, melhor desempenho e tímidos de TS.

• Início rápido
• API
  • Componente FontObserver
  • Componente do FontSubscriber
  • withFonts Hoc
  • Tipo de Font
• Exemplos
  • Básico com FontSubscriber
  • Básico com withFonts
  • Com styled-components
  • FontObserver aninhado
  • Opções personalizadas fontfaceobserver
• Licença

Início rápido

1. Instale react-with-async-fonts :

NPM:

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

fio:

yarn add react-with-async-fonts

2. Enrole seu componente raiz com FontObserver :

Defina o suporte com o nome da fonte. Você pode acessá -lo posteriormente no FontSubscriber para verificar se está pronto.

 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. Enrole seu alvo com o componente FontSubscriber :

Dica: você também pode usar a API withFonts se você realmente gosta de hocs.

Observe que o FontSubscriber usa crianças renderizando Prop. A função fornecida seria chamada com um único argumento, que é um objeto com teclas de fonte carregadas.

 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

Componente FontObserver

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

Prop	Tipo	Descrição
text	string	fontfaceobserver Opções de texto .load
timeout	number	Opções de tempo .load do fontfaceobserver
[key]	Font | string	Família de fonte String ou um objeto Font .

Componente do FontSubscriber

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

Prop	Tipo	Descrição
children	(fonts: Object) => React.Element<any>	As crianças renderizam a função. Aceita objeto com fonte carregada. Uma vez pronto, ele conteria o objeto do tipo Font .

withFonts Hoc

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

Argumento	Tipo	Descrição
componente	React.ComponentType<any>	Componente para envolver com hoc. Injeta o objeto fonts .

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

Exemplos

Atenção! Cada exemplo requer envolver seu aplicativo com 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' ) ,
) ;

Básico com 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 ;

Básico com withFonts

Você pode usar o Hoc withFonts se quiser compor seu componente. Observe que ele usa o mesmo FontSubscriber sob o capô.

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

Com styled-components

A maneira mais elegante de usá-lo com styled-components é withFonts o hoc do FONTS.

 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 aninhado

Você pode aninhar FontObserver para mesclar fontes. As instâncias das crianças substituem os pais se a fonte pelo mesmo código foi definida.

 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 ;

Opções personalizadas fontfaceobserver

Você pode fornecer opções text e timeout para o método .load do fontfaceobserver com os mesmos adereços.

 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 ; 

Licença

MIT © Sergey Bekrin