npm 包 @atlaskit/smart-card 使用教程

阅读时长 5 分钟读完

介绍

@atlaskit/smart-card 是一个使用 React 编写的 npm 包,它是一个可用于展示各种卡片的 React 组件,包括 GitHub 仓库卡片、JIRA 问题卡片和 Confluence 链接卡片等。

在本文中,我们将逐步介绍如何使用 @atlaskit/smart-card 这个 npm 包,并提供详细的代码示例,让您快速掌握如何使用这个强大的工具。

安装

使用 @atlaskit/smart-card 前,您需要在项目目录下进行安装。运行以下命令:

使用方法

使用 @atlaskit/smart-card 的方式非常简单。您只需要通过 import 引入相应的组件,然后在需要用到的地方进行使用即可。

以下是一个示例代码,它展示了如何使用 @atlaskit/smart-card 来创建一个 GitHub 仓库卡片:

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

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

为了展示其它类型的卡片,我们可以使用运行以下命令安装相应的资源库:

然后,我们只需修改前面代码片段中的 CustomIconresource 参数即可使用其它类型的卡片。

组件参数

@atlaskit/smart-card 提供了多个可供配置的参数,以下是常用的一些参数:

url 参数

每个卡片都包含一个 url 属性,它定义了卡片内容的来源。例如,在以下示例代码中,我们将 url 属性设定为一个 GitHub 页面的链接 URL:

CustomIcon 参数

当您使用 @atlaskit/smart-card 时,可以通过 CustomIcon 属性添加一个自定义图标来代替卡片的默认图标。例如,在以下示例代码中,我们添加了一张 GitHub 的图标:

onClick 参数

在您的卡片组件中,如需增加一个点击事件,请使用 onClick 属性并提供一个函数。例如,在以下示例代码中,我们创建了一个点击事件,并在点击时打印 "Card clicked!" 的信息:

actions 参数

如果您需要向卡片组件添加选项卡,请使用 actions 参数。这个参数接受一个数组,数组中的每一项都是一个包含 idtext 属性的对象。例如,在以下示例代码中,我们添加了两个选项卡,"Copy Link" 和 "Open in new tab":

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

结论

以上就是我们对 @atlaskit/smart-card npm 包的介绍。通过本文,我们已经详细的了解了如何使用这个强大的工具,并掌握了其常见的参数和用法。希望这篇文章对您有所帮助!

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

纠错
反馈