mirador

️此專案適用於 Mirador 3，即 Mirador 的最新版本。關於 Mirador 2，請參閱 ProjectMirador/mirador2 或 Mirador 2 wiki 上的舊文件。請注意，社區的重點是 Mirador 3，不太可能接受 Pull 請求或為 Mirador 2 提供支援。

米拉多爾

對於 Mirador 用戶

您可以透過重新混合 mirador-start Glitch 來快速使用和配置 Mirador。

我們建議使用 JavaScript 套件管理器（例如 npm 或 YARN）安裝 Mirador。

$ npm install mirador 

# or

$ yarn add mirador

如果您有興趣將 Mirador 與外掛程式整合到您的專案中，我們建議使用 webpack 或 Parcel 來整合 es 版本的軟體包。範例如下：

https://github.com/ProjectMirador/mirador-integration

如果您只想將 Mirador 嵌入 HTML 頁面而不進行進一步自訂，請包含 Mirador UMD 版本：

 <script src="https://unpkg.com/mirador@latest/dist/mirador.min.js"></script>

有關嵌入 Mirador 的更多範例，請造訪 https://github.com/ProjectMirador/mirador/wiki/M3-Embedding-in-Another-Environment#in-an-html-document-with-javascript。

向 Mirador 新增翻譯

有關新增翻譯的協助，請參閱 src/locales/README.md

在本地運行 Mirador 進行開發

Mirador本地開發需要安裝nodejs。

1. 執行npm install以安裝相依性。

啟動專案

$ npm start

然後導航到http://127.0.0.1:4444/

實例化 Mirador

 var miradorInstance = Mirador . viewer ( {
  id : 'mirador' // id selector where Mirador should be instantiated
} ) ;

> miradorInstance
{ actions , store }

範例操作

新增一個視窗：

 store . dispatch ( actions . addWindow ( ) ) ;

要聚焦視窗運行：

 store . dispatch ( actions . focusWindow ( 'window-1' ) )

檢查當前狀態

 store . getState ( ) 

運行測試

$ npm test # For headless CI=true npm test

或持續觀看原始檔案

$ npm run test:watch

檢查項目

$ npm run lint

偵錯

本地實例

以下瀏覽器擴充功能對於調試 Mirador 的本機開發實例非常有用：

• React 開發工具
• Redux 開發工具

測試套件

要調試測試套件，請運行：

$ npm run test:debug

然後啟動 Nodejs 檢查器客戶端並設定一些斷點。請參閱此處，以了解使用 Chrome DevTools 進行偵錯的指南。