npm 包 primo-explore-feedback 使用教程

阅读时长 10 分钟读完

简介

primo-explore-feedback 是一个由 Ex Libris 开发的用于向 Primo 图书馆目录提供反馈的 npm 包。该包提供了一个用户反馈组件,允许用户提交反馈并将其保存在您的 Primo 实例中。此外,该组件还提供了一个管理界面,您可以使用该界面查看和管理提交的反馈。

本教程将指导您如何在您的前端项目中使用 primo-explore-feedback,包括如何安装和配置该包以及如何使用该组件和管理界面。

安装

在使用 primo-explore-feedback 之前,您需要在您的项目中安装该 npm 包。您可以通过运行以下命令来安装它:

配置

在安装了 primo-explore-feedback 之后,您需要对其进行配置。配置包括设置反馈组件以及管理界面的位置和所需的元数据。

配置反馈组件

要配置反馈组件,您需要在您的 Primo 图书馆目录的代码中调用 primoExploreCustomActionsProvider 提供程序,并在它的回调函数中设置反馈组件的位置。该函数的语法如下:

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

在上面的代码中,registerAction() 函数用于注册自定义操作,这里我们注册了一个名为“Feedback”的操作。其中,type 参数指定了操作的类型,这里为“button”表示创建一个按钮。icon 参数指定了要在按钮中显示的图标,通常使用 Primo UI 提供的图标库。最后,action 参数用于设置当点击这个按钮时应该发生什么。

对于 action 参数,您需要在其中设置反馈组件的位置。通常,您会将它放在 Primo 图书馆目录的页面底部。可以使用以下代码来设置反馈组件:

在上面的代码中,after() 函数用于在 #exLdaIII 元素之后插入反馈组件,并将其作为 Primo 图书馆目录的子元素。

配置管理界面

要配置管理界面,您需要在 Primo 后端设置一些元数据,并在 Primo 图书馆目录中添加一个链接,使用户可以访问管理界面。

配置元数据

首先,您需要在 Primo 后端设置一些元数据。可以使用以下代码来设置元数据:

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

在上面的代码中,FeedbackCount 元数据用于保存反馈的数量,该元数据将在管理界面上显示。您可以通过在 Primo 后端中为此字段提供默认值来确保该字段始终存在。

配置链接

接下来,您需要在 Primo 图书馆目录中添加一个链接,使用户可以访问管理界面。可以使用以下代码来设置链接:

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

在上面的代码中,我们在 prmActionListAfter 组件中添加了一个链接,该链接位于 Primo 图书馆目录的页面底部。链接的名称为“feedback-management”,链接的文本为“Feedback Management”;当用户点击该链接时,会打开管理界面。

在链接的实现中,我们使用 Primo 图书馆目录中的 item 控制器获取 Primo 记录的信息,包括 ilsapiid 元数据,该元数据用于标识记录。然后,我们在链接 URL 中使用这一标识符。

还要注意的是,我们将反馈数量添加到了管理界面链接的文本中。要获取反馈数量,请使用上面提到的 FeedbackCount 元数据。

使用

在完成上述配置后,您可以开始使用 primo-explore-feedback 组件了。通过单击 Primo 图书馆目录页面底部的“Feedback”按钮,用户可以使用该组件将反馈提交到您的 Primo 实例中。提交的反馈数据将在 Primo 后端的记录中保存。

示例代码

以下是完整的示例代码,它演示了如何将 primo-explore-feedback 配置到您的 Primo 图书馆目录中:

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

总结

primo-explore-feedback 是一个用于向 Primo 图书馆目录提供反馈的 npm 包,并提供了反馈组件和管理界面。本教程介绍了如何安装和配置该包,并提供了示例代码。通过本教程,您将能够轻松地将该包添加到您的前端项目中,并让您的用户可以提交反馈,支持更好的用户体验。

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

纠错
反馈