npm 包 @beisen/platform-base 使用教程

介绍

npm 包 @beisen/platform-base 是贝岸集团开发的一款前端基础框架,旨在为前端开发人员提供便捷的开发体验,其中包含了多个常用的前端组件,如表格组件、表单组件、选择器组件等。本教程将详细介绍 @beisen/platform-base 的使用方法,包括安装、引入、使用等内容。

安装

使用 @beisen/platform-base,需要先将其安装到项目中。通过使用 npm 安装,可以轻松地将其添加到项目依赖中,并在项目中进行引用。

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

引入

在项目中引入 @beisen/platform-base 的方式有两种,一种是全量引入,即在项目入口文件中引入,可以将所有组件导入到项目中:

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

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

另一种是按需引入,即只引入需要使用的组件,可以减少代码量。

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

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

使用

下面以表单组件 BFormItem 为例,介绍一下如何使用 @beisen/platform-base。

基本用法

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

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

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

以上代码实现了一个包含 BFormItem 组件的简单表单,其中 v-model 绑定了组件的值,required 属性指定该表单项为必填项,v-valid 属性定义了该表单项的验证规则,errorMsg 属性定义了验证失败时的提示信息。

高级用法

除了基本用法,@beisen/platform-base 中还提供了许多高级用法,如使用插槽、自定义模板等。

使用插槽

BFormItem 组件提供了多个插槽,可以通过插槽来自定义表单项的样式和内容。

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

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

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

以上代码使用了表单项的 prefix-icon、label、default、suffix 四个插槽,分别用来设置表单项的前缀图标、标签、文本框和后缀图标。

自定义模板

除了使用插槽,@beisen/platform-base 还提供了自定义模板的功能,可以完全自定义一个表单项。

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

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

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

以上代码实现了一个自定义模板的表单项,使用了 BFormItem 的 custom 模板,将表单项的样式和内容完全自定义。

结语

以上就是 @beisen/platform-base 的使用教程,本文详细介绍了其安装、引入和使用方法,同时也介绍了其基本用法、高级用法以及自定义模板的实现方式。通过本教程的学习,相信读者已经可以熟练使用 @beisen/platform-base 进行前端开发了。

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


猜你喜欢

  • npm 包 @microsoft/fast-storybook-design-system-addon 使用教程

    前言 在前端开发中,我们经常需要在组件之间共享设计系统,以便在整个应用程序中保持一致的样式和设计。为了解决这个问题,微软推出了一个名为 @microsoft/fast-storybook-design...

    5 年前
  • npm 包 @jgertig/storybook-addon-info 使用教程

    简介 @jgertig/storybook-addon-info 是一个 Storybook 的插件,它可以帮助我们在 Storybook 中添加组件文档,并自动生成文档页面。

    5 年前
  • npm 包 @croquiscom/storybook-app-mithril-2 使用教程

    简介 @croquiscom/storybook-app-mithril-2 是一款基于 mithril 框架的 storybook 应用,它可以帮助前端开发者更好地展示和测试自己的组件库。

    5 年前
  • npm 包 @croquiscom/storybook-app-mithril 使用教程

    本文将介绍如何使用 @croquiscom/storybook-app-mithril 包来开发 Mithril 应用程序的 Storybook。该包提供了一套简单而强大的工具,可以帮助开发人员更好地...

    5 年前
  • npm 包 @beisen/storybook-react-dev 使用教程

    前言 在现代前端开发中,组件化开发成为了主流,而组件库的管理和展示也变得越来越重要,而 Storybook 就是解决这一问题的一个优秀的工具,为我们提供了一个普适的组件管理和展示解决方案。

    5 年前
  • npm 包 @beisen/storybook-core 使用教程

    简介 @beisen/storybook-core 是一个用于构建 React 组件库的开源工具,它基于 Storybook 实现了组件库的开发、文档编写、交互调试、测试等功能。

    5 年前
  • 前端技术——使用 npm 包 @storybook/addon-storyshots

    介绍 @storybook/addon-storyshots 是一个 Storybook 的插件,可以用来自动生成组件的快照测试。Storyshots 可以把组件渲染成图片(.png)或者 JSON ...

    5 年前
  • NPM 包 @storybook/addon-notes 使用教程

    @storybook/addon-notes 是一个 Storybook 的插件,可以用来在组件文档中加入笔记。本文将详细介绍该插件的使用方法和配置选项。 安装 使用 npm 进行安装: --- --...

    5 年前
  • npm 包 @storybook/addon-cssresources 使用教程

    介绍 @storybook/addon-cssresources 是 Storybook 框架中的一个插件,它可以帮助前端开发者轻松地添加自定义样式资源到 Storybook 展示组件的页面中。

    5 年前
  • npm 包 @storybook/addon-contexts 使用教程

    在前端开发中,常常需要测试不同的组件在不同场景下的表现。此时,@storybook/addon-contexts 可以帮助我们快速地创建许多不同的环境,从而轻松地测试组件在各种不同的场景下的表现。

    5 年前
  • npm 包 @rexlabs/plz-cli 使用教程

    什么是 @rexlabs/plz-cli @rexlabs/plz-cli 是一个命令行工具,可以帮助开发者快速创建一个基础的 React 项目。它提供了一些默认的配置,同时也支持自定义配置,可以让开...

    5 年前
  • npm 包 @oleg97/storybook-react-native 使用教程

    介绍 @oleg97/storybook-react-native 是一个优秀的 React Native 组件库开发工具,可以让我们更方便地开发和测试组件。本文将详细介绍如何使用该工具,包括配置、使...

    5 年前
  • npm 包 @dreipol/storybook-figma-addon 使用教程

    在前端开发中,一个好的 UI 设计稿可以帮助我们更加快速地开发页面,而 Figma 是一款非常流行的 UI 设计工具。在使用 Figma 设计好页面之后,我们需要将设计稿转换成实际的代码进行开发。

    5 年前
  • npm 包 @beisen/storybook-addons 使用教程

    简介 在前端开发中,组件化开发愈发流行。这时候一个好的组件库就相当重要了,而 Storybook 则是其中一个优秀的组件库。在 Storybook 中,我们可以将组件按照业务场景和组件功能分类,可以实...

    5 年前
  • npm 包 @beisen/channel-postmessage 使用教程

    介绍 @beisen/channel-postmessage 是一款轻量级的前端通讯工具,基于 postmessage 实现跨文档通讯,适用于多个窗口之间的消息传递。

    5 年前
  • npm 包 @types/reach__router 使用教程

    为了更好地开发 web 应用程序,我们需要使用一些框架和工具。其中,React 框架是目前最为流行的前端框架之一。而 @reach/router 是一个 React 路由库,它提供了一种简单的方式来管...

    5 年前
  • npm 包 @storybook/router 使用教程

    前言 在前端开发中,我们经常需要对组件进行测试、调试和排查问题等操作。而@storybook/router提供的路由服务可以帮助我们完成这些操作,本文将为大家详细介绍该npm包的使用方法。

    5 年前
  • npm 包 @kadira/storybook 使用教程

    在前端开发之中,我们常常需要对组件进行调试、测试和文档编写。而 @kadira/storybook 就是一款能够帮助我们完成这些任务的好工具。通过使用 @kadira/storybook,我们可以更加...

    5 年前
  • npm 包 @kadira/react-storybook-addon-info 使用教程

    什么是 @kadira/react-storybook-addon-info? @kadira/react-storybook-addon-info 是一个用于 React 组件开发、测试、文档编写的...

    5 年前
  • npm 包 react-easy-swipe 使用教程

    简介 react-easy-swipe 是一个 React 组件,用于帮助我们轻松地实现手机端的轻滑操作,如左右滑动、上下滑动等。使用 react-easy-swipe 可以大大减少开发人员的工作量,...

    5 年前

相关推荐

    暂无文章