react fontawesome
General cleanup and documentation fixes
字體令人陶醉的圖標庫的一個反應組件。
如果您使用的是Awesome V5+,請使用官方的React組件! react-fontawesome不支持fontawesome V5!
該項目不再積極維護。如果可以的話,請嘗試使用上面的官方組件!
npm install --save react-fontawesome注意:此組件不包括任何字體很棒的CSS或字體,因此您需要確保通過將它們添加到構建過程中或鏈接到CDN版本,以某種方式將其包含在某種程度上。
最快開始的方法是在頁面的<head>中使用鏈接標籤導入fontawesome:
< link href =" https://maxcdn.bootstrapcdn.com/font-awesome/4.7.0/css/font-awesome.min.css " rel =" stylesheet " />您可以更改版本編號,以使用任何版本的Fontawesome。
如果您使用的是WebPack,則需要安裝Fontawesome,導入Fontawesome Sass/LINS並配置字體路徑。請參閱此博客文章,介紹如何使WebPack和Fontawesome一起工作。
var React = require ( 'react' )
var FA = require ( 'react-fontawesome' )
React . render ( < FA name = "rocket" /> , document . body ) className名稱,樣式和其他道具(所有其他道具都直接傳遞給組件)。 定期使用
var React = require ( 'react' )
var FontAwesome = require ( 'react-fontawesome' )
var MyComponent = React . createClass ( {
render : function ( ) {
return (
< FontAwesome
className = "super-crazy-colors"
name = "rocket"
size = "2x"
spin
style = { { textShadow : '0 1px 0 rgba(0, 0, 0, 0.1)' } }
/>
)
} ,
} )使用CSS模塊
import React from 'react'
import FontAwesome from 'react-fontawesome'
import faStyles from 'font-awesome/css/font-awesome.css'
var MyComponent = React . createClass ( {
render : function ( ) {
return (
< FontAwesome
className = "super-crazy-colors"
name = "rocket"
cssModule = { faStyles }
size = "2x"
spin
style = { { textShadow : '0 1px 0 rgba(0, 0, 0, 0.1)' } }
/>
)
} ,
} )以上將創建這樣的輸出:
<span class="font-awesome__fa___2otTb font-awesome__fa-rocket___lfSov font-awesome__super-crazy-colors___3k583"></span>
請參閱API文檔以獲取完整文檔。
歡迎拉請求!
使用npm test運行測試套件,並使用npm run format格式化代碼。確保測試通過,並為新功能編寫測試,並通過對JSDOC進行更新的API進行文檔更改。
在提交拉動請求之前,請運行npm run dist以構建項目並進行更改。
麻省理工學院©Dana Woodman