npm 包 containers.js 使用教程

前言

在前端开发过程中,UI 组件和交互部分的处理和实现是必不可少的。而在处理这些东西时,往往会使用一些外部的工具库,以方便快速地实现功能。其中,containers.js 就是一款相对实用且适用范围广泛的一个库。

containers.js 是一个 JS 实用程序库,根据各种数据结构构建 DOM 元素以及创建动画效果。它提供了一些通用的基础容器结构,包括卡片、面板、窗口和更多。containers.js 是一个用于 Web 应用程序的完整前端 UI 库,帮助开发人员更快地构建自定义和精美的用户界面。

安装

你可以使用 npm 包管理器来安装 containers.js。在你的项目中,运行以下指令:

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

示例

下面是一个添加了 cards 和 panels 的基本示例。

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

你可以在你的 CSS 中添加以下代码:

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

这个例子中,我们创建了两个容器,一个 card 容器,一个 panel 容器,每个容器下又各自加入了一个添加按钮。而页内样式表处添加了样式,给容器和按钮等添加了美观的样式。

指南

基本容器

containers.js 提供了四个基本容器,它们分别是:

  1. .card-container
  2. .panel-container
  3. .window-container
  4. .modal-container

可以通过添加对应的 className 来为容器添加样式列表:

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

添加容器 Item

对于容器中的 Item,可以使用下面的代码来添加:

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

创建一个新的 Card 实例后,若想将它添加至容器中,则可按照以下方式进行操作:

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

该代码会将 Card 实例添加至 class 名为 .card-container 的节点中。其他容器也有类似的操作方式。

除了可以通过 description 方式创建实例内容外,你也可以通过直接将 HTML 结构插入类似以下的代码内来创建新实例:

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

其中,你需要使用 data-type 属性为容器指定类别。

配置

在创建新的容器实例时,它可以接收一个包含属性的对象。不同的容器类型可能有不同的属性。通用的属性包括:

  1. type:(必填)容器的类型
  2. header:(可选)头部的配置
    • title:标题
    • action:操作项的配置
      • text:文字
      • icon:图标
      • callback:回调函数
  3. content:(可选)内容

例如,对于 Card 容器实例,你可以按照如下方式进行实例化:

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

其中,我们设置了 Card 的标题、按钮以及容器内容。

自定义容器

如果你想要在容器中添加自定义元素、事件处理程序、样式等,则可以在创建容器时为其添加新的 CSS 类、事件监听器等。

自定义 CSS 类

你可以向容器中添加自定义 CSS 类名。例如,如果你想要将一些特定的元素添加到 /css/containers.css 中提供的基本样式之上,则可以按照如下方式进行操作:

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

在实例化新的 Card 对象时,我们可以定义新的 type 值以进行新容器的扩展和自定义:

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

容器实例化后,可以将 my-card 添加到 .card-container 中。

自定义事件监听器

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

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

可以看到,在创建新容器时,我们可以使用 onClick 方法为容器添加自定义事件监听器。

动画效果

containers.js 还提供了一些默认的动画效果,可以实现一些简单的旋转、翻转和移动效果。

动画效果 Type

目前支持的动画 Type 如下:

  • spin: 按钮呈现顺时针菊花状旋转
  • rotate: 按钮在垂直方向上执行翻转效果
  • slide: 按钮执行带缓冲的水平平移效果

按钮动画

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

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

卡片动画

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

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

可以看到,这个容器在添加到页面时执行了平移效果,而当我们点击容器中的按钮时,它又执行了翻转效果。

更多关于 containers.js 的特性和使用方法,请参考官网相关文档。

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


猜你喜欢

  • npm 包 @justgage/reason-cookie 使用教程

    什么是 @justgage/reason-cookie? @justgage/reason-cookie 是一个可以在 ReasonML 中使用的 Cookie 库。

    3 年前
  • npm 包 react-alt-context 使用教程

    React Alt Context 是一个用于 React.js 应用程序的 npm 包,它提供了一个上下文(context)对象,让您可以在整个 React 应用程序中更轻松地管理共享状态。

    3 年前
  • npm 包 @lvchengbin/backview 使用教程

    前言 在前端开发中,会经常需要通过代码来操作 DOM 元素,而常常需要获取一个元素的父元素或者指定层数的祖先元素。如果一开始没有考虑好代码的字符串优化,可能会写出深层嵌套的代码,在代码可读性和可维护性...

    3 年前
  • npm 包 fastify-cas-authentication 使用教程

    前言 在前端开发中,为了实现用户身份认证和授权功能,我们通常会使用第三方授权登录服务,如 CAS(Central Authentication Service),OAuth 等。

    3 年前
  • npm 包 request-numerizer 使用教程

    前言 在前端开发过程中,接口请求是非常常见的操作。而对于不同的接口,可能需要不同的参数格式。这时候,我们就需要一个工具快速地进行参数格式转换。npm 包 request-numerizer 就是一个非...

    3 年前
  • npm 包 rubiks-cube-scramble-cli 使用教程

    魔方是一种经典的智力拼图游戏,而算法是解魔方的关键。为方便学习算法,有许多工具用于生成算法练习,其中 npm 包 rubiks-cube-scramble-cli 就是一款不错的选择。

    3 年前
  • webpack-loader-css-styled-jsx-component 使用教程

    前言 在前端开发中,我们通常用 webpack 这种打包工具来打包、优化代码,其中涉及的 loader 是一个非常重要的概念。我们可以使用不同的 loader 来处理不同类型的文件,而 webpack...

    3 年前
  • npm包 guitarics-chordify使用教程

    前言 在音乐学习或创作过程中,经常需要对吉他或其他乐器的和弦进行识别和转换,以方便进行流畅的编曲或演奏。现今,有许多和弦识别和转换工具,其中npm上的guitarics-chordify是一款功能丰富...

    3 年前
  • npm 包 whatsapp-api 使用教程

    在前端开发中,有很多情况下需要使用短信或社交媒体平台的 API,以便实现一些特定的功能。其中,WhatsApp API 是一个非常受欢迎的选项之一。npm 包 WhatsApp-api,就提供了对 W...

    3 年前
  • npm 包 d3-boxes 使用教程

    在前端开发中,数据可视化是一个非常重要的领域,d3.js 是一个非常优秀的数据可视化开源库,而其对于盒图的绘制提供了非常出色的解决方案,通过 npm 包 d3-boxes 的包装,我们可以更加方便快捷...

    3 年前
  • npm 包 fuse-checkmark 使用教程

    介绍 fuse-checkmark 是一个基于 Fuse.js 的中英文字符模糊匹配工具,适用于前端和 Node.js 环境。使用 Fuse.js 的模糊匹配算法,快速找到最相似的字符串,且中英文字符...

    3 年前
  • npm 包 openapi-schema 使用教程

    openapi-schema 是一个为开发者提供 OpenAPI 3.0 规范的 npm 包,它可以帮助你更快地生成和验证 OpenAPI 规范,这篇文章将会为大家详细介绍如何使用 openapi-s...

    3 年前
  • NPM包 Polly-SSML-Split 使用教程

    Polly-SSML-Split 是一个可以将大段的 SSML(Speech Synthesis Markup Language)语音合成标记语言文件分割成多个独立的段落的 Node.js 包。

    3 年前
  • npm 包 abv-fetch 使用教程

    在现代的前端开发中,我们经常需要使用 HTTP 请求来获取或发送数据。而为了方便开发者,已经出现了许多优秀的 JavaScript 库和框架。其中,abv-fetch 就是一个非常优秀的库,它用于发送...

    3 年前
  • npm 包 moleculer-config-rethinkdb 使用教程

    前言 在现代的 Web 开发中,前端项目的复杂性越来越高,需要涉及诸如数据库管理、服务部署等功能。而在处理这些功能时,使用一些成熟的工具可以极大地减轻我们的负担。其中,moleculer-config...

    3 年前
  • npm 包 moleculer-elastic-apm 使用教程

    前言 随着前端应用不断增多,错误追踪和性能监控也成为了前端开发人员必须掌握的技能。为了更好地追踪前端应用的错误,并对应用进行性能监控,前端开发人员需要使用一些工具和库来进行监控和统计,这就是本文介绍的...

    3 年前
  • npm 包 moleculer-stack 使用教程

    简介 moleculer-stack 是一个基于 Moleculer 微服务框架的前端开发工具,它提供了代码生成器、服务管理、服 务监控等多个功能。 安装 首先需要安装 Moleculer: --- ...

    3 年前
  • npm 包 react-virtualized-sectionlist 使用教程

    在前端开发中,开发者经常需要处理大量数据。在移动端开发中,列表是最常见的数据展示方式。然而,列表中的数量越大,性能就越容易受到影响。react-virtualized-sectionlist 库便是为...

    3 年前
  • npm 包 baseboard.css 使用教程

    作者:AI助手 简介 baseboard.css 是一个快速构建前端界面的工具包。它包含了许多常用的 CSS 样式,帮助我们实现常见的页面布局、标题样式、按钮样式等。

    3 年前
  • npm 包 base-component-react 使用教程

    简介 base-component-react 是一个基于 React 的前端组件库,提供了多种常用组件以及支持自定义组件的扩展能力。该库非常适合用于快速构建中小型项目,也可以作为构建更大型项目的基础...

    3 年前

相关推荐

    暂无文章