npm 包 @n3/ng-api-classifier-list 使用教程

简介

@n3/ng-api-classifier-list 是一个 Angular 的 npm 包,它为 Angular 应用程序提供了一种方便的方法来分类显示项目中的 API 列表。该包使用 Angular CDK 的 Virtual Scrolling 功能来提高性能,并允许您自定义列表行的呈现方式。

安装

要使用 @n3/ng-api-classifier-list,请输入以下命令:

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

安装完毕后,您需要将 @n3/ng-api-classifier-list 加入到您的 Angular 模块中:

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

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

使用

添加 @n3/ng-api-classifier-list 到您的应用程序后,您可以在组件中使用以下 HTML 模板:

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

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

其中,data 是您要显示的 API 列表数据,onApiClick 是当用户点击列表项时调用的回调函数。

apiClassifierListHeader 和 apiClassifierListItem 是可选的,它们允许您自定义呈现在列表中的分类标题和 API 列表项,而不是使用默认标题和列表项。

以下是一个样例数据:

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

运行应用程序,您将看到类似于以下的分类 API 列表:

自定义

@n3/ng-api-classifier-list 还提供了一些选项来自定义显示在列表中的内容:

headerHeight:

用于定制分类标题的高度,默认为 40 像素。

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

itemHeight:

用于定制 API 列表项的高度,默认为 32 像素。

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

grouped:

用于指示是否将 API 列表分组展示,可选值为 true 或 false,默认为 true。

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

将 grouped 设为 false 后,您将看到一个扁平化的 API 列表:

结束语

现在您已经知道如何使用 @n3/ng-api-classifier-list 将您的 API 列表分类显示了!希望这篇文章能够对您的前端开发工作有所帮助。如果您在使用过程中遇到了任何问题或建议,请随时在评论区留言!

来源:JavaScript中文网 ,转载请联系管理员! 本文地址:https://www.javascriptcn.com/post/60066bcd967216659e244a4e


猜你喜欢

  • npm 包 @nodert-win10/windows.applicationmodel.socialinfo.provider 使用教程

    简介 在前端开发中,社交媒体一直是非常重要的一部分。为了方便前端开发人员进行社交媒体相关开发,微软推出了@nodert-win10/windows.applicationmodel.socialinf...

    4 年前
  • npm 包 @nodert-win10/windows.applicationmodel.wallet.system 使用教程

    在使用网上支付的时候,我们通常都会使用钱包来管理我们的卡片信息,而在 Windows 10 中也有一个 Wallet 功能可以让我们来管理一些需要使用卡片的应用。其中, @nodert-win10/w...

    4 年前
  • npm 包 @nodert-win10/windows.applicationmodel.wallet 使用教程

    前言 @nodert-win10/windows.applicationmodel.wallet 是 Node.js 安装在 Windows 系统上的一个 npm 包,用于在 Windows 应用程序...

    4 年前
  • npm 包 @nodert-win10/windows.applicationmodel.voicecommands 使用教程

    在前端开发中,我们需要经常使用各种各样的 npm 包来完成任务。其中,@nodert-win10/windows.applicationmodel.voicecommands 这个 npm 包是用来实...

    4 年前
  • npm 包 @nodert-win10/windows.applicationmodel.userdataaccounts 使用教程

    介绍 在 Windows 10 操作系统中,应用程序可以使用 UserDataAccounts API 来管理和访问本地和云存储的用户数据帐户。@nodert-win10/windows.applic...

    4 年前
  • npm 包 @nodert-win10/windows.data.json 使用教程

    简介 npm 包 @nodert-win10/windows.data.json 是一个用于获取 Windows 平台相关数据的工具。使用此工具可以轻松获取 Windows 系统版本、CPU 架构等详...

    4 年前
  • npm 包 @nodert-win10/windows.devices.adc 使用教程

    前言 @nodert-win10/windows.devices.adc 是一个用于 Windows 10 设备的模块,可用于采集模拟传感器数据。如果你是前端开发人员,那么你可能需要此模块来帮助你实现...

    4 年前
  • npm 包 pilot.min.js 使用教程

    在现代网站开发中,JavaScript 的作用越来越重要。npm 是 JavaScript 的包管理工具,它可以帮助前端开发者快速获取各种 JavaScript 库并使用它们。

    4 年前
  • npm 包 pid.min.js 使用教程

    在前端开发中,为了提高开发效率和代码可重用性,npm 包是必不可少的工具之一。pid.min.js是一个轻量级的 JavaScript 库,可以用于实现进程 ID 算法。

    4 年前
  • npm 包 ping.min.js 使用教程

    在前端开发过程中,我们经常需要检测某个 IP 地址或域名的可达性。这时候,就可以使用 ping.min.js 这个 npm 包来实现。 安装 使用 npm 安装 ping.min.js --- ---...

    4 年前
  • npm 包 picture.min.js 使用教程

    在前端开发中,处理图片是必不可少的一部分。而 npm 包 picture.min.js 就是一个非常好用的处理图片的工具。本篇文章将会详细介绍该包的使用方法和注意事项。

    4 年前
  • npm 包 pit.min.js 使用教程

    在前端开发中,使用第三方开源库可以大大提高开发效率。而 npm 是前端最流行的包管理器之一,它提供了大量的可用包,其中包括了 pit.min.js。 什么是 pit.min.js? pit.min.j...

    4 年前
  • npm 包 pin.min.js 使用教程

    前言 在前端开发中,我们常常需要实现元素的固定或滚动时的效果,例如在某个位置停留固定、随页面滚动而滑动等。这时,我们可以使用第三方库 pin.min.js 来实现这样的效果。

    4 年前
  • npm 包 plus.min.js 使用教程

    npm 是 Node.js 的包管理工具,我们可以通过它来获取各种前端组件和工具。其中包括名为 plus.min.js 的 npm 包。 plus.min.js 是一个轻量级的前端工具库,提供了一系列...

    4 年前
  • npm 包 play.min.js 使用教程

    介绍 play.min.js 是一个基于 HTML5 的音频播放器库,提供了音频播放器的基本功能,同时也支持自定义皮肤以及嵌入式播放器等功能。它可以轻松地嵌入到网站或应用程序中,并且拓展性很强,非常灵...

    4 年前
  • npm 包 planet.min.js 使用教程

    在前端开发中,经常需要使用到各种第三方库或插件,而 npm 是目前最常用的包管理工具之一。其中一个非常有用的 npm 包就是 planet.min.js。这个包主要用于生成一个类似行星系统的动态效果,...

    4 年前
  • npm 包 police.min.js 使用教程

    前言 在进行前端开发过程中,我们常常会使用各种第三方库和框架,以提高效率和降低开发成本。其中,npm 是前端开发中最受欢迎的包管理工具之一。npm 上有许多实用的开源包,比如我们今天要介绍的 poli...

    4 年前
  • npm 包 plugin.min.js 使用教程

    前言 在现代的 Web 开发中,使用 npm 包成为了不可或缺的一部分。npm 包的数量增长迅速,它们可以用于构建网站、应用程序、工具等各种场景。 在此文中,我们将介绍一款名为 plugin.min....

    4 年前
  • npm 包 place.min.js 使用教程

    介绍 place.min.js 是一款小巧的 JavaScript 库,它可以方便地生成占位图片。在进行前端页面的开发时,我们常常需要在代码调试的过程中插入一些占位图片来填充页面内容。

    4 年前
  • npm 包 plug.min.js 使用教程

    简介 npm 是 Node.js 包管理工具,提供了一种方便的方式来管理和分享代码的方式。plug.min.js 是一款基于 jQuery 开发的插件,可用于创建模态窗口、提示框等常见的页面弹窗。

    4 年前

相关推荐

    暂无文章