npm 包 @atlaskit/atlassian-navigation 使用教程

介绍

@atlaskit/atlassian-navigation 是一个由 Atlassian 公司开发的 React 组件库,用于在前端网站中创建 Atlassian 风格的导航栏。这个库的优点在于它提供了完整的 Atlassian 导航栏 UI 组件,支持多种不同的屏幕尺寸,并且可以很容易地进行自定义。

在这篇文章中,我们将学习如何使用 @atlaskit/atlassian-navigation,包括安装和使用步骤,以及一些示例代码,帮助您更好地了解其用法。

安装

要使用 @atlaskit/atlassian-navigation,您需要先在项目中安装它。可以通过以下方式来安装:

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

如果您使用 yarn,则可以运行以下命令来安装:

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

使用

现在我们来看看如何在项目中使用 @atlaskit/atlassian-navigation。以下是一个简单的示例代码:

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

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

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

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

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

在此示例代码中,我们导入了 AtlassianNavigation 组件并在 App 组件中使用它。为了更好地了解如何使用 AtlassianNavigation 组件,我们来分析一下它的属性:

label (string)

设置主标题。

moreLabel (string)

设置下拉菜单标题。

primaryItems (Array<object>)

设置主要导航栏中的项目。每一个项目都是一个对象,包含以下属性:

  • id (string):项目标识符。
  • label (string):项目标签。
  • href (string):项目链接。
  • isActive (bool):是否是当前选择的导航项目。

renderProductHome (function)

设置产品主页部分。该属性应该包含一个函数,该函数返回产品主页的 React 元素。

renderProfile (function)

设置个人资料部分。该属性应该包含一个函数,该函数返回个人资料的 React 元素。

renderHelp (function)

设置帮助部分。该属性应该包含一个函数,该函数返回帮助的 React 元素。

productIcon (function)

设置产品图标。该属性应该包含一个函数,该函数返回产品图标的 React 元素。

onBurgerMenuClick (function)

设置当用户单击汉堡菜单时要执行的函数。

isOpen (bool)

设置汉堡菜单是否应该显示。

createDrawer (function)

设置自定义抽屉的函数。该属性应该包含一个函数,该函数返回自定义抽屉的 React 元素。

总结

现在,您已经学习了如何在项目中使用 @atlaskit/atlassian-navigation,通过以上实例和属性我们便可以使用最优的方式建立 Atlassian 风格的导航栏。我们希望本文可以对您有所帮助,并祝您的项目开发成功!

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


猜你喜欢

  • npm 包 aedes 使用教程

    前置知识 在学习 aedes 之前,你需要具备以下前置知识: Node.js 基础知识 MQTT 协议基础知识 aedes 简介 aedes 是一个用于实现 MQTT 服务的 Node.js 包。

    4 年前
  • npm 包 aedes-packet 使用教程

    前言 在前端开发中,我们经常需要使用 MQTT 通信协议。而 aedes 是一个高可靠的 MQTT 服务库。aedes-packet 就是由 aedes 实现的 MQTT 包编解码库,用于将 MQTT...

    4 年前
  • npm 包 aedes-persistence 使用教程

    前言 aedes-persistence 是一个 MQTT 服务器库 aedes 的数据存储插件,它可以帮助我们将 MQTT 客户端的数据存储到数据库、文件、内存等不同的存储介质中。

    4 年前
  • npm 包 graphql-mqtt-subscriptions 使用教程

    随着物联网技术的发展,越来越多的设备开始连接到互联网,这也使得许多传统的应用程序需要增加例如实时数据流等新的功能。而 GraphQL 和 MQTT 作为当前比较流行的技术,提供了便捷高效的数据传输方式...

    4 年前
  • `npm`包`graphql-multiplex-subscriptions`使用教程

    npm包graphql-multiplex-subscriptions使用教程 什么是graphql-multiplex-subscriptions graphql-multiplex-subscri...

    4 年前
  • npm 包 mqemitter 使用教程

    介绍 mqemitter 是一个消息代理(message broker)npm 包,可用于实现 WebSocket,TCP 和 HTTP 服务器的消息传递。本教程将介绍如何使用 mqemitter 包...

    4 年前
  • npm 包 openapi-to-graphql 使用教程

    概述 在前端领域,我们经常会涉及到跨网络请求数据,而各种 API 接口规范的使用,也要求我们对接口文档有较好的理解和应用。而一些较为复杂的 API 往往需要依赖于多个接口,且返回的数据也经常需要在前端...

    4 年前
  • npm 包 @graphql-cli/init 使用教程

    简介 @graphql-cli/init 是一个 npm 包,用于帮助开发人员在其项目中初始化 GraphQL,提供了一个简单而快速的方法配置 GraphQL 环境。

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

    什么是 io-ts-types? io-ts-types 是一款 TypeScript 类型检查工具,它可用于检查和验证 JavaScript 对象上的属性和值。 这个工具功能强大,允许我们定义 Ty...

    4 年前
  • npm 包 object-path-immutable 使用教程

    npm 包 object-path-immutable 使用教程 object-path-immutable 是一个常用的 JavaScript 工具库,它提供了一种更加简单、直观的方式来访问和操作 ...

    4 年前
  • npm 包 @loopback/repository-json-schema 使用教程

    前言 在现代 web 应用开发中,数据库和数据模型是不可或缺的一部分。然而,在将数据库和数据模型与应用程序和 API 集成时经常会遇到各种问题。LoopBack 作为现代化的全栈框架,提供了一个灵活的...

    4 年前
  • npm 包 @loopback/openapi-v3 使用教程

    前言 @loopback/openapi-v3 是基于 OpenAPI 3.0.0 规范的 LoopBack 应用程序和 REST API 的生成器。该包提供了一个 OpenAPI 规范文档(原 Sw...

    4 年前
  • npm 包 @openapi-contrib/openapi-schema-to-json-schema 使用教程

    介绍 在编写 API 文档时,我们常常使用 OpenAPI 规范来定义 API。而在实际使用中,也许我们希望将 OpenAPI 规范转换为 JSON Schema 规范,以便更好地与其他系统集成。

    4 年前
  • npm 包 emoji-datasource 使用教程

    在现代网站和应用程序开发中,Emojis 已成为不可或缺的一部分。在 W3C 标准化后,浏览器也开始支持 Emoji 的显示,开发者可以通过 Unicode 值或对应的字符实体来插入表情符号。

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

    简介 json-schema-compare 是一个 npm 上的用于比较 json-schema 差异的工具库,可以在前端项目中帮助我们快速发现不同版本的 schema 的差别,从而更好地管理我们的...

    4 年前
  • npm 包 @loopback/build 使用教程

    随着前端开发的不断发展,我们需要更好的工具来提高我们的开发效率。@loopback/build 作为一个 npm 包,在构建和打包前端应用时提供了全面的支持。本篇文章将介绍如何使用 @loopback...

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

    前言 在前端开发过程中,为了保证代码的一致性并且遵守最佳实践,我们通常需要使用 linter 工具。其中,ESLint 是一种非常流行的 JavaScript 代码检查工具,它可以帮助我们发现代码中的...

    4 年前
  • npm 包 turndown-plugin-gfm 使用教程

    前言 Markdown 是一种轻量级的标记语言,用于在写作过程中快速排版内容。在前端开发中,我们经常需要将 Markdown 转换成 HTML,这时候就可以使用 turndown 来实现。

    4 年前
  • npm 包 tslint-functional-preset 使用教程

    前言 在前端开发中,无论是个人还是团队,代码的规范化一直是一个重要的议题。为了降低代码的维护成本,规范化的代码进而提高代码的可读性和可维护性是非常必要的。而在 TypeScript 的开发中,tsli...

    4 年前
  • npm 包 Aurelia-hot-module-reload 使用教程

    前言 随着前端开发的日益复杂,模块化开发、组件化开发等技术已经成为了前端开发的基本要素之一。为了更好的提升开发效率,减少开发成本,前端工程师们更多的开始使用 npm 包管理工具以及其他一系列的自动化构...

    4 年前

相关推荐

    暂无文章