npm 包 @atlaskit/dropdown-menu 使用教程

面试官:小伙子,你的代码为什么这么丝滑?

在前端开发中,实现下拉菜单是非常常见的需求,而 Atlassian 在 React 组件库中已经提供了一个非常好用的下拉菜单组件 —— @atlaskit/dropdown-menu

本篇文章将详细介绍该组件的使用方法,为读者提供深入的学习和实践指导。

安装

首先,通过 npm 进行安装:

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

安装完成后,可以在项目中直接 import 导入该组件:

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

基础使用

DropdownMenu

DropdownMenu 是该组件的主要内容,它可以包含任意类型的子组件作为菜单项显示,如 DropdownItemGroup 和 DropdownItem。

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

在该例子中,trigger 选项指定了下拉菜单的触发器,该触发器可以是任意的字符串或组件,并在 DropdownMenu 显示时被渲染。在这里,我们使用了一个字符串 “下拉菜单”。

triggerType 选项指定了触发器的类型,可以是 button、link、menu、custom 等多种类型,用于控制如何渲染触发器组件。此处使用 button,即触发器被渲染成按钮形式。

isMenuFixed 选项指定了下拉菜单是否可滚动,默认为 false,当把它设为 true 时,可以让下拉菜单在弹出时固定在页面上,而不是跟随页面滚动。

shouldFlip 选项在下拉菜单超出视窗时会自动反转组件的方向以保证它完全可见。

DropdownMenu 还有许多其他的选项,包括:

  • appearance:下拉菜单的主题样式
  • boundariesElement:边界元素,控制下拉菜单弹出时的位置边界范围
  • isLoading:菜单项是否正在 loading 中
  • shouldAllowMultilineItems:指定是否允许多行显示某个菜单项
  • shouldFitContainer:指定是否将菜单宽度适配为容器的宽度
  • onKeyDown:键盘操作时的回调

DropdownItemGroup 和 DropdownItem

DropdownItemGroup 和 DropdownItem 是两种常用的菜单项子组件,前者可用于分组显示一组菜单项,后者用于显示一个单独的菜单项。

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

DropdownItem 还有以下重要的选项:

  • isDisabled:菜单项是否禁用
  • isSelected:菜单项是否被选中
  • onClick:菜单项点击时的回调

进阶使用

菜单定位

DropdownMenu 默认的菜单位置是相对于触发器的左上角在屏幕上弹出。但在实际项目中,我们经常需要针对不同的触发器位置进行不同的菜单排布。

DropdownMenu 通过 boundariesElement 选项需要您明确制定菜单边界,如不指定则默认为 scrollParent。

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

选择一个边界元素时,您可以使用 document.documentElement、菜单元素或一个父级元素,也可以使用 "viewport"、 "window" 或 "scrollParent" 参数,优先级按照这个列表从高到低排序。

在菜单打开时向 boundariesElement 传递一个运行函数可以捕获菜单打开时的预计边界。

自定义触发器

您可以通过使用 DropdownMenu 的 render 接口并提供一个自定义渲染函数来自定义触发器,并且还可以使用原生 HTML 作为触发器,以实现自己定制化的应用。

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

在 renderTrigger 回调函数中,使用 isOpen 参数控制文本提示信息的变化,使用 toggle 函数来切换菜单的打开或关闭。

动态菜单项

DropdownMenu 对于数据源的处理能力是扩展的。如果您有一个可变的数据源,并且需要每次更新组件时都获取数据,下面就是一个可以实现该功能的示例:

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

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

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

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

在这个示例中,我们使用 useState 来存储一个可变的数据源,并在 onOpenChange 回调中,在菜单关闭时获取新的菜单项列表。菜单项列表的更新也是通过 setItems 函数来实现的。

总结

通过本文的介绍,您应该已经掌握了 @atlaskit/dropdown-menu 组件的基础用法、进阶用法以及一些潜在难点。在实际开发中,您可以根据具体需求进行定制,为您的应用程序提供美观、易用的下拉菜单功能。

完整代码示例:https://codesandbox.io/s/atlaskit-dropdown-menu-6h8lg

来源:JavaScript中文网 ,转载请联系管理员! 本文地址:https://www.javascriptcn.com/post/atlaskit-dropdown-can-menu


猜你喜欢

  • 如何在 Express.js 中使用 JWT 进行身份验证?

    随着互联网及移动互联网的快速发展,越来越多的应用程序需要进行用户身份验证及管理。为了满足这些需求,使用 JSON Web Token(JWT)进行用户身份验证已经成为技术领域的常见做法。

    3 小时前
  • 在 GraphQL 中处理复杂的对象关系

    在现代的 web 应用中,对象之间的关系变得越来越复杂。例如,一个出售商品的商店可能会有许多不同的商品,其中每个商品可能会有多个大小、颜色、类型等变体。在以前,为了处理这种情况,我们需要在后端编写各种...

    3 小时前
  • 如何使用 Jest 测试 Node.js 应用?

    Jest 是一款由 Facebook 开发的开源 JavaScript 测试框架。它被广泛用于前端和 Node.js 应用程序的单元测试、集成测试和端到端测试。在本篇文章中,我们将学习如何使用 Jes...

    3 小时前
  • Android 开发中 Material Design 中 TabLayout 的使用技巧

    前言 随着移动互联网的快速发展,在 Android 开发中,Material Design 成为了最流行的设计指南之一。TabLayout 是 Material Design 中一个重要的组件,具有良...

    3 小时前
  • PM2 与 NGINX:构建高性能的 Node.js 应用程序

    Node.js 是一个快速而又高效的 JavaScript 运行环境,正因为如此,它已经成为了构建 Web 应用、REST API 和实时应用的理想选择。但随着 Node.js 应用程序的愈加复杂,它...

    3 小时前
  • Headless CMS 中使用 Webhooks 实现自动构建

    随着静态网页生成器的流行,Headless CMS 越来越受到开发者们的重视。Headless CMS 不仅提供了现代化的管理界面,还允许开发者通过 API 或 Webhooks 来获取内容。

    3 小时前
  • ES10 实战教程

    前言 ES10,也就是 ECMAScript 2019,是 JavaScript 的最新版本。自 2015 年发布了 ES6 以来,JavaScript 变得越来越流行,并且在近几年里,前端技术发展迅...

    3 小时前
  • Serverless 如何实现自动备份?

    在 Serverless 架构中,由于无需维护服务器,开发者可以更专注于实现业务逻辑。但是,我们还是需要解决一些重要问题,如数据备份、数据恢复和灾难恢复等。在本文中,我们将探讨如何使用 Serverl...

    3 小时前
  • Jest 测试 React 组件中使用 context 的方法探究

    在 React 应用中,我们可能需要在组件间共享一些数据或者函数,这时可以通过 Context 来实现。但是在测试使用 Context 的组件时,我们可能会遇到一些问题。

    3 小时前
  • SSE 如何设置头信息?

    简介 SSE(Server-Sent Events)是一种轻量级的实时推送技术,在前端开发中经常用于推送服务器实时消息,比如聊天、订阅等。SSE 可以通过 HTTP 协议进行传输,因此需要设置合适的头...

    3 小时前
  • 在 Docker 容器中使用 SSH

    随着前端应用程序的复杂性增加,开发环境的设置变得越来越麻烦。 Docker 是一个流行的容器化解决方案,它可以帮助我们在标准化的环境中进行开发。在这篇文章中,我们将学习如何在 Docker 容器中使用...

    3 小时前
  • CSS Grid 游戏(Grid Garden)学习笔记

    CSS Grid 游戏(Grid Garden)学习笔记 CSS Grid 是一个强大的布局工具,它可以让我们轻松地实现复杂的网页布局。但是,学习 CSS Grid 的过程可能会有些枯燥。

    3 小时前
  • React 中使用 setInterval 时的注意事项

    引言 在 React 中,我们很常见地使用 setInterval 来创建周期性的任务。在实际开发中,我们需要注意一些细节和陷阱,以确保周期性任务能够正确地运行。本文将会介绍 React 中使用 se...

    3 小时前
  • 如何在使用 CSS Reset 的情况下保持 flexbox 布局?

    什么是 CSS Reset? 在我们开始探讨在使用 CSS Reset 的情况下保持 flexbox 布局之前,我们需要先了解什么是 CSS Reset。CSS Reset 是一种用于归零不同浏览器之...

    3 小时前
  • 使用 Web Components 构建可重用的模态框组件

    Web Components 是 Web 技术的一种新型组成部分,可以让开发者创建封装的自定义元素。通过 Web Components,开发者可以更加轻松地构建可重用的 UI 组件。

    3 小时前
  • 如何优化 iOS 应用程序的性能

    作为一名前端开发人员,我们常常需要优化我们的应用程序的性能,以提供更好的用户体验。在 iOS 平台上,优化应用程序的性能尤为重要。本文将介绍一些优化 iOS 应用程序性能的技巧和策略,帮助开发人员提高...

    3 小时前
  • 响应式设计中的样式调整

    随着移动设备的普及,人们越来越多地使用手机和平板电脑浏览网站。因此,响应式设计已成为现代 Web 设计的必要趋势。在响应式设计中,我们需要针对不同的设备大小和屏幕分辨率,调整样式和布局以确保网站能够良...

    3 小时前
  • 在 Fastify 中处理文件上传

    Fastify 是一个快速、低开销和易于学习的 Web 框架,其性能排名领先。在开发过程中,我们经常需要处理文件上传。本文将介绍如何在 Fastify 中处理文件上传。

    3 小时前
  • ES11 中的 Object.fromEntries() - 一个实用工具

    ES11 中的 Object.fromEntries() - 一个实用工具 在 ES2019 中,一个新的 Object 静态方法 fromEntries() 加入了 JavaScript。

    3 小时前
  • 如何用良好的界面设计提升 App 无障碍性?

    随着技术的不断进步和社会的不断发展,越来越多的人开始重视无障碍性设计,这样有助于让更多的人都能够顺利、愉快地使用各种应用程序。尤其是在移动应用程序中,良好的界面设计不仅可以提高用户的使用体验,还可以提...

    3 小时前