npm 包 @dhis2/d2-ui-interpretations 使用教程

阅读时长 5 分钟读完

前言

@dhis2/d2-ui-interpretations 是一个用于管理 DHIS2 数据解释的前端组件库,它可以帮助你解读和共享你的数据。

它包含多个组件,如 InterpretationsPanel、InterpretationComments 和 InterpretationDialog 等,它们可以帮助你方便地创建、编辑和查看 DHIS2 数据解释。本文将详细介绍如何使用这些组件。

安装

要使用 @dhis2/d2-ui-interpretations 组件,需要先安装它:

安装完成后,你就可以使用这些组件了。

组件列表

@dhis2/d2-ui-interpretations 包含多个组件,主要有以下几个:

InterpretationsPanel

InterpretationsPanel 是一个展示解释面板的组件。它接收一个 InterpretationsPanelProps 属性对象,这个对象的属性如下:

  • d2: DHIS2 实例
  • id: 数据集 ID
  • type: 要展示的面板类型(如 dataEntry、dataSet 和 events 等)
  • onRequestClose: 关闭面板时的回调函数

示例代码:

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

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

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

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

InterpretationComments

InterpretationComments 组件是用于展示解释评论的组件,它接收一个对象数组作为评论列表。每个对象包含以下属性:

  • id: 评论 ID
  • createdBy: 评论创建者 ID
  • createdByName: 评论创建者姓名
  • created: 评论创建时间
  • text: 评论内容

示例代码:

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

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

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

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

InterpretationDialog

InterpretationDialog 组件用于创建或编辑解释。它接收一个 InterpretationDialogProps 属性对象,这个对象的属性如下:

  • d2: DHIS2 实例
  • open: 打开对话框时的回调函数
  • interpretation: 要编辑的解释对象
  • onSave: 保存解释时的回调函数
  • onCancelled: 关闭对话框时的回调函数

示例代码:

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

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

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

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

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

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

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

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

结语

@dhis2/d2-ui-interpretations 是一个非常实用的前端组件库,它可以帮助你方便地管理 DHIS2 数据解释。

本文介绍了这个组件库的主要组件,并提供了相应的代码示例。希望对你有所帮助!

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