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

介绍

@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


猜你喜欢

  • npm 包 automatic-release 使用教程

    介绍 automatic-release 是一个 npm 包,用来自动化管理你的项目的版本发布和更新。它能够自动化处理以下事项: 生成 changelog 和 发布日志 打 tag 和发布到 npm...

    4 年前
  • npm 包 simple-progress-webpack-plugin 使用教程

    介绍 simple-progress-webpack-plugin 是一个 webpack 插件,用于在 webpack 构建过程中展示进度条。它使用了 term-size 和 cli-progres...

    4 年前
  • 使用 platform-select 进行前端开发

    使用 platform-select 进行前端开发 介绍 npm(Node Package Manager)是 Node.js 的包管理工具,它可以方便地将包安装到本地,以便在项目中使用。

    4 年前
  • npm 包 unicode-emoji-modifier-base 使用教程

    npm 包 unicode-emoji-modifier-base 使用教程 什么是 unicode-emoji-modifier-base? unicode-emoji-modifier-base ...

    4 年前
  • npm 包 skin-tone 使用教程

    在 Emoji 中,肤色调整是指将默认的黄色皮肤调整为其他五种肤色。这个功能已经在各种社交媒体和聊天应用程序中得到了广泛使用。npm 包 skin-tone 的出现,为前端开发人员提供了一种方便的方法...

    4 年前
  • npm 包 emoj 使用教程

    Emoj 是一个简单而有趣的 JavaScript 库,可以让您的网页增加可爱的表情符号。使用它,您可以在您的网页上轻松地添加表情符号。在本教程中,我们将向您介绍如何使用 npm 包 emoj,轻松地...

    4 年前
  • npm 包 format-io 使用教程

    前言 对于前端开发人员来说,有效地处理和转换数据格式是一个不可避免的问题。曾经,我们需要手动编写代码来完成这个任务,但是随着技术的进步,现在我们可以使用 npm 包来更轻松地完成这个任务。

    4 年前
  • npm 包 cmdify 使用教程

    在前端开发中,使用命令行可以提高效率。但是,有些命令行参数或路径中包含空格或其他特殊字符,需要进行转义才能正常执行。此时,使用 npm 包 cmdify 可以解决这个问题。

    4 年前
  • NPM 包 mock-globals 使用教程

    在前端开发中,我们经常需要模拟一些全局变量来测试页面的兼容性和功能性。这时候,mock-globals 包就非常有用了。它可以让你轻松地创建和使用虚拟的全局变量。 安装 使用 npm 安装 mock-...

    4 年前
  • npm 包 normalize-arguments 使用教程

    前言 在前端开发中,我们常常需要处理函数参数。有时候我们并不知道函数参数的传递方式,或者说传递的参数不完全满足我们的需求。这时候,我们就需要使用一些参数标准化工具,比如 normalize-argum...

    4 年前
  • npm 包 prop-schema 使用教程

    随着前端技术的不断发展,我们经常会需要使用大量的第三方库和组件,这些组件很可能接收一组固定的 props,这些 props 通常是有具体类型和限制条件的。在应用开发中有时候需要对这些 props 进行...

    4 年前
  • npm 包 mockdown 使用教程

    简介 mockdown 是一个 Node.js 的 npm 包,它提供了一个简单但功能强大的方式来快速生成假数据,以帮助我们快速开发前端应用程序。不像其他的 mock 工具,mockdown 可以生成...

    4 年前
  • npm 包 autocreate 使用教程

    在前端开发中,我们经常需要创建一些模板代码或者组件文件,这可能会花费很多时间和精力。幸运的是,有一个叫做 autocreate 的 npm 包可以帮助我们自动生成模板代码或组件文件,从而提高我们的开发...

    4 年前
  • npm 包 should-proxy 使用教程

    在前端开发中,为了更好地开发和调试,我们通常需要使用代理工具去请求真正的 API 接口。而 npm 包 should-proxy 则可以让你更加容易地配置代理规则,本文将详细介绍该包的使用方法及注意事...

    4 年前
  • npm 包 cloudflare 使用教程

    前言 随着互联网的迅速发展,网站的访问量也越来越大,而云技术的出现可以很好地解决这个问题。Cloudflare 就是一家提供全球 CDN、DNS、防火墙等一系列云服务的公司,可以帮助用户提升网站的速度...

    4 年前
  • npm 包 tweetsodium 使用教程

    npm 包 tweetsodium 使用教程 前言 在现代Web开发中,数据加密和安全性非常重要,特别是对于一些敏感数据或密码等信息。 tweetsodium 是一个npm包,它是 Twitter 开...

    4 年前
  • npm 包 @octetstream/promisify 使用教程

    Promise 是 JavaScript 中的一个重要特性,它能够在异步操作中提供可读性和可靠性。@octetstream/promisify 是一个能够将 Node.js 中的异步函数转化为 Pro...

    4 年前
  • npm 包 promise-fs 使用教程

    什么是 promise-fs? promise-fs 是一个基于 Promise 的文件系统操作库,它能够提供与原生文件系统 API 相同的功能,同时还支持链式调用、错误处理等特性。

    4 年前
  • npm 包 @sindresorhus/transliterate 使用教程

    前言 在前端开发过程中,我们难免要处理一些字符串相关的问题,比如中文转换成拼音、特殊字符转义等等。这时候就需要一些好用的工具来帮助我们解决问题。其中,一个非常好用的工具就是 npm 包 @sindre...

    4 年前
  • npm 包 @octetstream/eslint-config 使用教程

    前言 在现在的前端开发中,静态代码分析工具的重要性越来越凸显。其中,eslint 是一个非常受欢迎且广泛应用的静态代码分析工具,它的配置也变得越来越重要。本文将介绍一个免费的 npm 包 @octet...

    4 年前

相关推荐

    暂无文章