npm 包 @material/drawer 使用教程

简介

@material/drawer 是一个 Google Material Design 风格的侧边栏菜单组件，它可以用于 Web 应用程序中的导航和用户界面设计。这个 npm 包提供了 Material Design 风格的侧边栏菜单组件，可以通过简单的配置快速实现屏幕边缘的导航栏。

快速开始

要在你的项目中使用 @material/drawer，你需要先安装它。

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

一旦安装成功，你就可以在你的代码中引用它了。

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

API 文档

包内提供了 MDCTemporaryDrawer 类，其 API 详细说明如下：

属性

名称 类型 默认值 描述
open_ boolean false 表示侧边栏是否已打开
drawer_ Element null 侧边栏元素的 DOM 节点
focusTrap_ FocusTrap null 用于限制用户与应用程序其余部分之间的交互的 trap 元素
previousFocus_ Element | null null 先前具有活动状态的元素
handleKeydown_ Function 按下 Esc 按钮时的键盘事件处理函数
handleOpen_ Function 打开侧边栏时的事件处理函数
handleClose_ Function 关闭侧边栏时的事件处理函数

方法

名称 参数 返回值 描述
open void 打开侧边栏
close void 关闭侧边栏
getDefaultFoundation function() => MDCFoundation MDCFoundation 获取默认的 foundation 对象

事件

名称 属性 描述
MDCDrawer:opened Event 当侧边栏已打开时发出的事件
MDCDrawer:closed Event 当侧边栏已关闭时发出的事件

示例代码

初始化

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

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

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

配置选项

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

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

禁用交互

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

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

结论

@material/drawer 可以很方便地添加侧边栏菜单到你的 Web 应用程序中，且支持多种选项和配置，可以灵活地实现你的需求。通过使用这个组件，你可以为你的应用程序提供更好的导航和用户界面设计。

来源：JavaScript中文网 ，转载请联系管理员！ 本文地址：https://www.javascriptcn.com/post/200764

阅读全文

猜你喜欢

  • npm 包 libxmljs2 使用教程

    介绍 libxmljs2 是一个优秀的 Node.js 软件包，用于处理 XML 和 HTML 文档。它是在 libxml2 的基础上进行开发的，对于大多数前端类项目来说，这是一个非常好的选择。

    5 年前
  • npm包 @digabi/exam-engine-core使用教程

    简介 @digabi/exam-engine-core 是一个前端的考试引擎核心库，它提供了一些基本的组件和工具，帮助开发者构建属于自己的考试应用程序。下面我将详细介绍其使用方法。

    5 年前
  • npm 包 yawn-yaml 使用教程

    在前端开发中，我们经常需要处理 YAML 格式的文本数据，而 yawn-yaml 这个 npm 包正是为了解决这个问题而设计的。本文将详细介绍 yawn-yaml 的使用方法，帮助读者快速上手。

    5 年前
  • npm 包 @canopycanopycanopy/b-ber-theme-serif 使用教程

    本文将介绍 npm 包 @canopycanopycanopy/b-ber-theme-serif 的使用教程，该包是一个针对前端开发者的免费企业级字体主题库，包括了多种字体风格，具有易用性和可定制性...

    5 年前
  • npm 包 @canopycanopycanopy/b-ber-theme-sans 使用教程

    在前端开发中，我们经常会使用一些第三方的工具和库来提高我们的效率和质量。npm 是一个非常流行的包管理工具，它可以让我们方便地查找、安装和更新各种 npm 包。@canopycanopycanopy/...

    5 年前
  • npm 包 @canopycanopycanopy/b-ber-shapes-sequences 使用教程

    在前端开发中，我们经常需要使用各种 npm 包来完成任务。其中，@canopycanopycanopy/b-ber-shapes-sequences 是一个非常实用的 npm 包，它提供了许多基于贝尔...

    5 年前
  • NPM 包 @canopycanopycanopy/b-ber-shapes-dublin-core 使用教程

    简介 @canopycanopycanopy/b-ber-shapes-dublin-core 是一个用于 Dublin Core 元数据的 JavaScript 库，提供了多种 Dublin Cor...

    5 年前
  • npm 包 @canopycanopycanopy/b-ber-logger 使用教程

    前言 @canopycanopycanopy/b-ber-logger 是一个用于记录日志的 npm 包，它提供了一种简便的方式来帮助你在你的应用程序中编写日志。在前端开发中，日志记录是非常重要的，因...

    5 年前
  • npm 包 eslint-plugin-sonarjs 使用教程

    什么是 eslint-plugin-sonarjs？ eslint-plugin-sonarjs 是一个基于 ESLint 的插件，它的作用是通过静态分析 JavaScript 代码，然后提供一些规则...

    5 年前
  • npm 包 html-encoder-decoder 使用教程

    简介 html-encoder-decoder 是一个可用于前端开发的 npm 包，它提供了一种将 HTML 实体编码和解码的方法。HTML 实体是在 HTML 文档中使用的特殊字符，例如 amper...

    5 年前
  • npm 包 @types/linkify-it 使用教程

    在前端开发过程中，我们经常会使用到处理 URL 链接的库。Linkify-it 是一个用于识别和转换文本中 URL 链接的 JavaScript 库。在 TypeScript 项目中，我们可以使用 @...

    5 年前
  • npm 包 @ctsy/session 使用教程

    在现代的 Web 开发中，前端项目的复杂性不断提升，session 的使用也越来越重要。@ctsy/session 是一款可以让你简单易用地管理 session 的 npm 包。

    5 年前
  • npm 包 @ctsy/server_plugin 使用教程

    前言 在前端开发中，后端服务的搭建和维护是至关重要的一环。针对软件工程师的需求，npm 提供了一系列的包和工具，包括了 @ctsy/server_plugin，帮助开发者快速搭建后端服务。

    5 年前
  • npm 包 @ctsy/server 使用教程

    在前端开发中，我们经常需要使用一些前端框架和技术来完成网站和应用的开发。其中，服务端技术的选择和使用也非常重要，它决定了应用程序的性能、可扩展性和可维护性等方面。如果你正在寻找一款适合前端开发的服务端...

    5 年前
  • npm 包 @ctsy/cache 使用教程

    简介 npm 包 @ctsy/cache 是一个前端开发中常用的缓存工具库，可以方便地对数据进行缓存。它支持多种缓存方式，包括内存缓存、本地存储缓存和 session 缓存，并且可以通过配置自定义缓存...

    5 年前
  • 使用 npm 包 castle-function

    使用 npm 包 castle-function castle-function 是一个 Javascript 工具库，它包含了许多前端开发中常用的工具函数，如字符串格式化、日期格式化、数组去重、数据...

    5 年前
  • npm 包 @types/koa-send 使用教程

    前言 在前端开发中，我们通常使用一些第三方库来提高我们的开发效率。而这些第三方库中的类型定义则在 TypeScript 中使用起来显得格外方便。 本文将介绍一个常用的 npm 包 @types/koa...

    5 年前
  • npm 包 castle-utils 使用教程

    castle-utils 是一个实用的 npm 包，提供了前端开发中常用的一些工具函数，帮助开发者更高效地完成开发任务。本篇文章将为大家介绍这个 npm 包的使用方法和一些实际应用，希望能帮助大家提高...

    5 年前
  • npm包@ctsy/hook 使用教程

    介绍 @ctsy/hook是一个基于react hooks的轻量级状态管理器，能够让你快速有效的管理组件状态。它提供了一种新的编写React组件的方式，通过统一管理组件状态，可以减少重复的代码和常见的...

    5 年前
  • npm 包 @ctsy/crypto 使用教程

    前言 在前端开发中，常常需要进行加密和解密操作。为了方便开发者，npm 社区提供了许多优秀的加密算法包。@ctsy/crypto 包就是其中之一，它提供了多种常用的加密算法功能，并且使用简单、易于上手...

    5 年前

相关推荐

    暂无文章