Custom Elements 实现可拖拽的标签页组件的最佳实践

AI 编程助手,豆包旗下的编程助手,提供智能补全、智能预测、智能问答等能力,节省开发时间,释放脑海中的创造力,支持 VSCode,点击体验 AI

前言

可拖拽的标签页组件已经在许多现代应用程序中被广泛使用,它们可以将多个内容单元组织成一个视觉上自然的方式,并允许用户轻松地对它们进行重新排序和组合。Custom Elements 提供了一种构建完全自定义的标签和组件的方式,而拖拽模块则允许添加拖放功能,从而提供了实现这些功能的优秀途径。

在这篇文章中,我们将讨论使用 Custom Elements 实现可拖拽的标签页组件的最佳实践,并带您了解如何使用示例代码来创建您自己的标签页组件。

Custom Elements 是什么?

Custom Elements是Web标准中的一部分,为Web开发人员提供了一种定义关键字元素的方法。这些元素可以是自定义样式以及行为(事件处理程序,方法等),并可以在DOM中像任何其他HTML元素一样使用。

如何定义自定义元素

要定义自定义元素,我们需要使用“customElements”这个全局销售点。使用customElements.define()方法来定义自定义元素:

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

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

上述代码定义了一个名为CustomTag的新HTMLElement类,并告诉浏览器将此元素映射到<custom-tag>标记。此外,我们还可以在定义中传递一个配置对象,其中包含有关自定义元素的其他设置,例如定义与继承元素,styles,观察者等。

在定义自定义元素后,我们可以将其作为任何其他标准元素添加到HTML中。例如,我们可以将 defined 元素添加到一个已存在的 DOM 节点中,如下:

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

现在,CustomTag的实例已经在文档中存在了,我们可以根据需要更新或操纵它。

添加拖放功能

拖放的工作原理与以下事件结合使用:

  • dragstart:当前拖动的对象开始时触发,我们需要在其中设置数据传输的数据类型
  • dragover:当鼠标移动到接收拖动对象的区域时,会定期触发,我们在其中检查拖动对象的类型
  • drop:当拖动对象在容器上释放时触发,我们在其中执行放置操作

让我们看一下如何应用这些事件来创建一个拖放标签页组件:

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

我们定义了一个自定义元素<custom-tabs>,该元素可以容纳多个<custom-tab>元素。我们将在后面的示例中定义<custom-tab>元素的行为。

首先,让我们关注<custom-tabs>元素。我们需要为其添加属性支持拖放,我们可以通过监听dragoverdrop事件来实现:

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

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

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

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

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

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

我们在上面创建了一个CustomTabs类,它在构造函数中需要遍历所有子元素。我们使用setAttribute()为每个子元素添加了draggable="true"的属性。我们还在每个元素上注册了三个拖放事件监听器:dragstart, dragover, and drop,这些事件每个都都将在上面被实现(下面提到)。在<custom-tabs>元素上声明event.preventDefault()和设置DataTransfer实例。

接下来,通过实现各自的事件监听器,我们可以实现相应的拖拽事件。

handleDragStart 在拖动开始时,由拖动源调用。在这个函数中,我们要设置传输的数据类型,以便在结束放置时可以访问相应的数据。

handleDragOver 在拖动源在目标元素上方移动时定期触发。我们需要将这里的event.preventDefault()调用放置在每个拖动事件处理程序中,以确保目标元素上的默认操作不会被触发。

handleDrop 在拖动源在目标元素上释放时触发。我们要从存储的数据类型中提取当前拖动对象的ID,并利用该ID获取对该元素的引用。我们还需要在响应中的拖动源和目标元素之间重新排列拖动对象。

getDragAfterElement 上述函数是原作者 Vojta Holik 所创建的函数示例,我们将这个函数添加到handleDrop()中,它用于遍历目标元素的子节点,并找到拖动之后应该放置的位置。

现在,让我们看一下如何在<custom-tab>元素上添加样式和交互性,以使其与我们的拖放容器交互。

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

我们使用了从<button>元素继承下来的常见标签标记,但也可以通过为<custom-tab>元素添加属性或在构造函数中定义自己的样式来自定义多个子节点的外观,交互特性或行为。

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

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

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

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

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

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

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

我们使用构造函数为CustomTabs元素注册了四个拖动事件处理程序,使其能够在拖放操作期间进行交互:

在定义元素时,我们将设置所有新创建对象的id,为每个tab添加CSS class样式表帮助排列填充。我们也让每个拖动源具有draggable属性。还注册四个事件处理程序函数:

handleDragStart 在拖动源按下移动时,由源调用事件。我们需要在事件处理程序中添加正在拖动的CSS类名(以使对象更加突出)并设置传输的数据类型,以便在结束放置时可以访问相关数据。

handleDragOver 定期在拖动源经过当前放置目标元素时由浏览器调用。我们在这里添加了preventDefault()的调用以防止意外的元素操作。

handleDrop 在拖动源放下时以目标元素为参数调用。我们从存储的数据类型中提取当前拖动对象的ID,并利用该ID获取对该元素的引用。我们使用getDragAfterElement函数,并且需要在响应中的拖动源和目标元素之间重新排列拖动对象。

handleClick 标记页在单击时将被激活,我们将这个处理程序用于在激活后重绘之前必须标记所有其他标记页 inactive。

getDragAfterElement 与前面提到的相同,这里不再咕噜。

最佳实践

当使用Custom Elements创建自定义标签或组件时,请记住以下最佳实践:

  • 每个元素应该具有一个名称,该名称是唯一的。
  • 明晰的命名是非常重要的,使元素容易被识别
  • 组件的作用应该容易理解
  • 避免与其他库和框架的命名冲突,代码的复用性和可维护性是非常重要的
  • 使用小写和中横线作为元素名称——例如 custom-tabs 以及 custom-tab
  • 使用JavaScript模板文字和ES6模块以确保代码易于扩展和维护
  • 小心使用全局CSS,避免影响其他部分的代码
  • 在组件生命周期的不同阶段添加事件监听器,这样就可以确保在这些阶段具有相应的逻辑

结论

在这篇文章中,我们已经了解了如何使用Custom Elements和拖拽模块来创建可拖动标签页组件。

虽然上述代码只是一个工作示例,但它可以帮助您了解如何定义自定义元素,以及如何添加自定义行为和交互特性。随着您对Custom Elements的了解越来越深入,您将能够创建支持更多复杂行为和功能的包装组件。

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


猜你喜欢

  • 在 Angular 中解决 “TS2339:属性 'find' 不存在于类型的值上”

    当你在使用 Angular 开发网页应用时,你可能会遇到一些 TypeScript 报错,其中比较常见的一种就是“TS2339:属性 'find' 不存在于类型的值上”。

    8 天前
  • Cypress 测试:如何提高定位器的稳定性?

    前言 在编写前端自动化测试时,正确的元素定位非常重要,而 Cypress 是一个强大的前端自动化测试工具,我们需要掌握一些技巧来确保它的定位函数(如 cy.get())稳定可靠,接下来我们将为大家分享...

    8 天前
  • Hapi 框架的日志记录配置详解

    在前端开发中,日志记录是一个十分重要的环节。Hapi 是 Node.js 的一个开源框架,提供了丰富的插件和工具来简化 web 应用程序的构建和测试。Hapi 框架自带了日志记录功能,并提供了许多配置...

    8 天前
  • Deno 中的缓存管理技术浅析

    前言 Deno 是一个现代化的 JavaScript 和 TypeScript 运行时,具有安全性和高效性,可以用于写后端服务和前端应用。Deno 内置了很多有用的功能,其中缓存管理是其中之一。

    8 天前
  • Vue.js 3.0 + Tailwind 快速搭建网页的方法和技巧

    作为一名前端开发者,我们需要不断寻找和掌握新的技术和工具,以便能够快速高效地开发网页和应用。在本文中,我将向大家介绍如何利用 Vue.js 3.0 和 Tailwind CSS 快速搭建网页的方法和技...

    8 天前
  • 利用 SASS 编写可伸缩的 SVG 图形

    利用 SASS 编写可伸缩的 SVG 图形 SVG 是一种矢量图像格式,它具有良好的可伸缩性和动画性能。在前端开发中,经常会使用 SVG 来展示图标和图形。而在编写 SVG 图形时,使用 SASS 可...

    8 天前
  • Redis 高可用方案选型分析

    前言 Redis 是当前最流行的内存数据库之一,在 Web 开发中有着广泛的应用。但是,随着数据量和访问量的逐渐增大,如何选择合适的高可用方案便显得至关重要。 本文将对 Redis 的高可用方案进行分...

    8 天前
  • Serverless的无服务架构与容器架构的优劣分析

    Serverless架构和容器架构是当今最流行的两种云计算架构。它们都有各自的优点和局限性,但它们都是用于处理前端开发的最佳实践。在本文中,我们将深入研究Serverless框架和容器框架,探讨它们的...

    8 天前
  • 初学者必备的 Docker 术语介绍及常见问题解析

    Docker 是一个开源的容器化平台,以其高度的可移植性和灵活性而在前端开发中广受欢迎。对于初学者来说,了解 Docker 的术语和常见问题非常重要。在本文章中,我将介绍一些 Docker 的术语以及...

    8 天前
  • AngularJS:SPA 应用中的多语言处理方案

    作为一种现代的 web 应用程序设计模式,SPA(Single Page Application,单页面应用程序)越来越受到开发者的欢迎。作为一个 SPA 应用程序,多语言支持是一个重要的功能。

    8 天前
  • 在 Express.js 应用程序中使用 Nodemailer 发送电子邮件的方法

    随着 web 应用程序的普及,有些时候我们需要在我们的应用中集成邮件服务。Nodemailer 是一个流行的 Node.js 库,用于发送电子邮件。在这篇文章中,我将介绍如何在 Express.js ...

    8 天前
  • Vue.js2.0 中 watch 和 computed 的区别及使用

    引言 Vue.js 是一个流行的前端框架,它提供了很多工具让我们轻松地构建交互式的 Web 应用程序。Vue.js 中经常使用 watch 和 computed 来实现数据的双向绑定。

    8 天前
  • ES10 中新增的 Function.toString 方法的应用实践

    ES10 中新增的 Function.toString 方法允许我们获取函数的原始代码字符串表示,包括函数内部的所有内容。这个特性在前端中有很多实用的应用场景,本文将详细探讨这个新特性的使用方法和指导...

    8 天前
  • 解决 Jasmine 无法解析所提供的测试文件 错误

    在 Angular 中,我们使用 Jasmine 来进行单元测试。但是有时候,在运行 Jasmine 进行测试时,你可能会遇到 Jasmine 无法解析所提供的测试文件的错误。

    8 天前
  • 初步掌握 Mark Otto 版的 CSS Reset

    在前端开发过程中,常常遭遇浏览器之间样式差异的问题。这是因为不同浏览器的默认样式表不同,而这些默认样式表会影响我们的页面布局和样式。 为了解决这个问题,CSS Reset 是一种很好的解决方案。

    8 天前
  • ECMAScript 2021 (ES12) 中使用 BigInt 时遇到的常见错误及解决方法

    背景 ECMAScript 2021(ES12)是 JavaScript 语言的最新标准,其中引入了一种新的原始数据类型 BigInt,用于表示更大范围的整数,解决了在之前版本中 Int 型整数的精度...

    8 天前
  • TypeScript 高级类型总结及应用

    在前端开发中,JavaScript 可能是最常用的编程语言之一。虽然它允许我们执行简单的任务,但在处理大型项目时,存在很多困难。TypeScript 作为 TypeScript 的扩展,为开发其提供新...

    8 天前
  • Hapi 框架的资源压缩技巧

    在前端开发中,Web 应用的性能是至关重要的,其中资源压缩是优化性能的一个重要方面。在 Hapi 框架中,我们可以使用多种方式来实现资源压缩,本篇文章将详细介绍其中的方法,并为读者提供深入学习和指导意...

    8 天前
  • 响应式设计中如何优化页面的 SEO 排名?

    在当今的互联网时代,SEO(搜索引擎优化)在网络营销中扮演着至关重要的角色。响应式设计(RWD)是一种越来越流行的设计理念,它可以根据用户的设备大小和分辨率,在不同屏幕上正确地呈现网页内容。

    8 天前
  • PWA 开发秘籍:从设计到上线的步骤和技巧

    PWA(Progressive Web App)是一种快速成长的 Web 技术,可以将网站的体验提升到与原生应用类似的水平。本文将介绍如何在设计到上线的整个流程中开发 PWA,并探讨一些有效的技巧。

    8 天前

相关推荐

    暂无文章