@readr-media/react-image · 
Feature
- 可依據傳入的多個圖片URL，由小至大依序載入。
- 當所有圖片URL皆載入失敗時，載入預設圖片。
- 實作圖片載入動畫效果。
- 實作圖片懶載入（lazy load）。
How to Use This Pkg as React Component ?
- Install the npm package
yarn add @readr-media/react-image - Import component in the desired place
import CustomImage from '@readr-media/react-image'
const IMAGES_URL = { w400: "400.png", original: "original.png"}
export default function SomeComponent() {
return (
<div>
<OtherComponent/>
<CustomImage images={IMAGES_URL}/>
</div>
)
}
Props
| 名稱 | 資料型別 | 必須 | 預設值 | 說明 |
|---|---|---|---|---|
| images | Object | V |
{original: ""} |
圖片設定，範例： { w400: '400.png',w800 : '800.png', w1200: '1200.png', original: 'original.png' }。會由w400、w800、w1200、original依序載入 |
| defaultImage | String | "" |
預設圖片。當image皆載入失敗時，則載入預設圖片。當 loadingImage未傳入時，則以預設圖片作為圖片載入動畫效果。 |
|
| loadingImage | String | "" |
載入動畫效果，作為載入圖片的動畫。目前僅接受圖片檔URL。 | |
| alt | String | "" |
替代文字 | |
| objectFit | String | "cover" |
圖片區塊填滿設定，即為CSS property object-fit
|
|
| height | String | "100%" |
圖片高度 | |
| width | String | "100%" |
圖片寬度 | |
| debugMode | Boolean | false |
是否開啟開發模式，若開啟，則在載入圖片成功或失敗時，透過console.log顯示相關訊息 |
Precautions
若使用該套件時，禁用了瀏覽器的cache，則同張圖片會載入兩次（一次在函式loadImage()中載入各個大小的圖片，一次則在useEffect中，將成功載入的圖片掛載至<img>上），這是正常的現象。
之所以要分載入兩次，而不是在loadImage()中嘗試載入圖片並掛載至<img>，是因為這樣才能在圖片載入時顯示loadingImage。
若無禁用瀏覽器快取，則僅會載入一次圖片。
Installation
yarn install
Development
$ yarn dev
// or
$ npm run dev
// or
$ make dev
Build (Webpack Bundles and ES5 Transpiling)
$ npm run build
// or
$ make build
Build Webpack Bundles
$ make build-dist
Transpile React, ES6 Codes to ES5
$ make build-lib
NPM Publish
After executing Build scripts, we will have ./dist and /lib folders,
and then we can execute publish command,
npm publish
Note: before publish npm package, we need to bump the package version first.
TODOs
- [ ] 建立 CI pipeline，透過 CI 產生 npm package，並且上傳至 npm registry
- [ ] 透過 Lerna 控制 packages 之間的版號
- [ ] 實作Responsive Image，並由螢幕寬度決定載入圖片大小。
- [ ] 在禁用瀏覽器的快取情況下，仍僅需載入圖片一次。