npm 包 @dbmdz/mirador-manifestbutton 使用教程

阅读时长 5 分钟读完

简介

@dbmdz/mirador-manifestbutton 是一个与 Mirador 兼容的 npm 包,它允许您在 Mirador 框架中添加“Manifest 按钮”,该按钮允许用户一键加载 IIIF 服务中的其他资源。

本文主要介绍 @dbmdz/mirador-manifestbutton 的安装、使用及相关示例。

安装

@dbmdz/mirador-manifestbutton 可以通过 npm 进行安装,安装方法如下:

使用

授权

使用 @dbmdz/mirador-manifestbutton 之前,您需要进行授权。在 Mirador 的授权中,您需要在配置文件(例如 /path/to/your/mirador/config.js)中的 authorization 中设置对应的授权信息:

-- -------------------- ---- -------
----- ------ - -
  -- ---
  -------------- -
    -- --------- ------- --
    -- ------------------------ ----------------- ------------ --------
    -- -----------
    -------- -------------
    ----------------- ----------------
    ------------ -------------------
    -- ---
  --
  -- ---
--

------ ------- -------

注册插件

接着,在 Mirador 的配置文件中进行插件注册,将 @dbmdz/mirador-manifestbutton 注册为 Mirador 的插件。

-- -------------------- ---- -------
------ ------- ---- ----------

----- ------- - -
  -- ---
  -- -- ----------------------------- --
  -
    ----- -------------------------------
    ---------- ---------------------
    ------- ----------------------
  --
--

---------------------- ---------

到此为止,@dbmdz/mirador-manifestbutton 的安装和使用已经完成,接下来是一些有用的使用技巧和示例。

插件参数

ManifestButtonPlugin 有如下参数:

参数 描述
t i18n 对象
manifestUrlSuffix 添加到 IIIF 资源 URL 结尾的字符串
label 按钮标签
icon 按钮图标,应该是可访问的 SVG、PNG 或字体
textVariant 按钮的文字主题
iconVariant 按钮的图标主题

示例

-- -------------------- ---- -------
------ ----- ---- --------

------ - 
  --------------------- 
  ---------------
- ---- --------------------------------

----- -------- - ----- -- ------- --------------------------- ---------------------------------------- ------------- -------- ------------

----- ----------------- - ----- -- -
  ------ ---------------- ----------------------- ---
--

----- ------- - -
  -- ---
  -
    ----- -------------------------------
    ---------- ---------------------
    -- ------ - ----------------------------- ------- ----------
    ------- ----------------------
    -- -------
    ----------------------- -
      -
        ---------- ------------------
        ----- -----------
        ------ -
          ---------- ----------------
        -
      -
    --
    ------------------ -
      -
        ------ --- --------
        ----- --------
      -
    --
    ------------------ ---
    -- ---
  --
  -- ---
--

总结

本文介绍了 @dbmdz/mirador-manifestbutton 的安装、配置和使用,并且展示了部分使用示例。此 npm 包为 Mirador 大幅增强了与 IIIF 服务的集成性,让您的展示系统更加灵活、高效、易用。

来源:JavaScript中文网 ,转载请注明来源 https://www.javascriptcn.com/post/60066efe4c49986ca68d8b0d

纠错
反馈