npm 包 okc 使用教程

什么是 okc?

okc 是一款轻型的前端组件库,提供了一系列的 UI 组件、工具类和 mixin 插件,方便开发者在项目中使用。

其特点包括:

  • 简洁、易用、易扩展
  • 完全基于 CSS3 实现,无任何 JavaScript 依赖

okc 的安装和使用

安装 okc

okc 通过 npm 进行包管理,安装非常方便。使用以下命令进行安装:

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

使用 okc

okc 支持在项目中使用 ES6、CommonJS 或者 AMD 的方式引入组件、工具类和 mixin 插件。

在 HTML 文件头部添加以下代码,引入 okc 样式文件:

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

在 JavaScript 文件中,通过以下方式引入 okc:

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

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

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

okc 提供的组件

下面是 okc 提供的常用 UI 组件列表:

Button 按钮

  • 支持多个样式风格
  • 支持禁用状态
  • 支持 loading 状态
------ - ------ - ---- ------
------- -------------- ------------ -------------------------

Input 输入框

  • 支持单行和多行输入
  • 支持前后缀
------ - ----- - ---- ------
------ ---------------- ------------ ------------------- --

Radio 单选框

  • 支持水平和垂直布局
  • 支持禁用状态
------ - ----- - ---- ------
------------ ----------------------------- ----------------------------------
  ------------- --------------------------
  ------------- --------------------------
  ------------- --------- -------------------------
  ------------- --------------------------
--------------

Checkbox 多选框

  • 支持水平和垂直布局
  • 支持全选、全不选和反选操作
  • 支持禁用状态
------ - -------- - ---- ------
--------------- --------------------------------- -------------------------------------
  ---------------- -----------------------------
  ---------------- -----------------------------
  ---------------- --------- ----------------------------
  ---------------- -----------------------------
-----------------

Switch 开关

  • 支持禁用状态
  • 支持自定义颜色
------ - ------ - ---- ------
------- --------------- --

Modal 对话框

  • 支持多种弹出方式
  • 内置了 Alert 和 Confirm 两种常用对话框
------ - ----- - ---- ------
------ --------------------------------- --------------------------------
  -------------------------------
  ---------------------------
  --------------
    ------- -------------------------------------------
    ------- -------------- -------------------------------------------
  ---------------
--------

okc 提供的工具类

okc 还提供了一些常用的工具类,方便开发者进行样式定义。

以下是 okc 提供的一部分工具类:

  • .clearfix 清除浮动
  • .ellipsis 文本省略号
  • .disable-select 禁止文字选中
  • .display-none 隐藏元素
  • .text-center 文本居中
  • .text-left 文本左对齐
  • .text-right 文本右对齐
  • .font-size-xxl 字体大小为 28px
  • .font-size-xl 字体大小为 24px
  • .font-size-l 字体大小为 18px
  • .font-size-m 字体大小为 16px
  • .font-size-s 字体大小为 14px
  • .font-weight-bold 字体加粗
  • .font-weight-normal 字体正常
  • .transition-all 所有属性支持 transition
  • .transition-property-${name} 指定属性支持 transition

以下是使用示例:

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

okc 提供的 mixin 插件

okc 还提供了一些常用的 mixin 插件,方便开发者进行布局定义。

以下是 okc 提供的一部分 mixin 插件:

  • flex($direction) 布局为 flex
  • flex-center($direction, $children) 水平或垂直居中
  • flex-item($flex, $order, $grow, $shrink, $basis) flex 元素属性

以下是使用示例:

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

okc 的贡献和维护

okc 是一个开源项目,欢迎开发者贡献自己的代码和想法。如果您发现了 bug 或者有任何想法和建议,请在 Github 上提交 issue 或者 Pull Request。

项目地址:https://github.com/xxxx/okc

总结

okc 是一款轻量级的前端组件库,提供了丰富的 UI 组件、工具类和 mixin 插件。本文介绍了 okc 的安装和使用方法,以及提供的部分组件、工具类和 mixin 插件的使用示例。希望本文对您的学习和开发工作有所帮助。

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


猜你喜欢

  • npm 包 redux-simple-auth 使用教程

    介绍 redux-simple-auth 是一个基于 Redux 的认证库,用于管理身份验证和授权状态。它使用 JSON Web Token(JWT)作为身份验证令牌,支持多种方式的身份验证方案,如用...

    4 年前
  • npm 包 reducer-redux 使用教程

    在前端开发中,我们经常会使用 Redux 来管理应用的状态。而 reducer-redux 这个 npm 包为我们提供了更好的处理 reducer 的方式。本文将为大家介绍 reducer-redux...

    4 年前
  • npm 包 reducer-chain 使用教程

    简介 reducer-chain 是一个用于创建 reducer 处理函数链的 npm 包。它可以让你更加灵活地组织 reducer 处理函数,让代码更加清晰、简洁。

    4 年前
  • npm 包 redux-simple-localstorage 使用教程

    随着前端技术的不断发展,现在的前端开发已经不是像以前那样简单的页面渲染,而是更注重数据的管理与状态的维护。为了更好的管理和维护状态,Redux 应运而生。Redux 是一个在 JavaScript...

    4 年前
  • npm 包 redux-mixpanel-middleware 使用教程

    前言 随着 Redux 的日渐流行,越来越多的开发者开始关注中间件,Redux 中间件的使用不仅可以简单地记录日志,还能增强 Redux 的功能,简化代码并提高性能。

    4 年前
  • npm 包 redux-simple-localstorage1 使用教程

    随着前端项目越来越庞大,状态管理变得越来越重要。Redux 是一个非常优秀的状态管理工具,但是默认情况下,Redux 只支持内存中的状态管理,一旦浏览器刷新或者页面关闭,状态就会丢失。

    4 年前
  • npm 包 redux-mixpanel 使用教程

    概述 redux-mixpanel 是一个用于在 Redux 中与 Mixpanel 协作的 npm 包。该包提供了一个可以直接在 Redux 数据流中发送事件和属性的方法,方便开发者快速集成 Mix...

    4 年前
  • npm 包 redux-devtools-dock-monitor-ie8-zck 使用教程

    简介 redux-devtools-dock-monitor-ie8-zck 是一个针对 IE8 浏览器的 redux 开发工具包。它可以让前端开发人员在 IE8 浏览器上进行 redux 的开发,提...

    4 年前
  • npm 包 redux-devtools-dock-monitor-window 使用教程

    redux-devtools-dock-monitor-window 是一个能够增加 Redux DevTools 在线上可视化的 npm 包,可以用于在 Redux 开发过程中更加高效的 debug...

    4 年前
  • npm 包 redux-devtools-filter-actions 使用教程

    Redux 是一种流行的 JavaScript 应用程序状态管理库,它提供了一种可预测性的数据容器来管理前端应用程序的状态。redux-devtools-filter-actions 这个 npm 包...

    4 年前
  • npm 包 redux-devtools-filterable-log-monitor 使用教程

    redux-devtools-filterable-log-monitor 是一个 npm 包,可以帮助前端开发者实现 Redux 应用的状态管理。它可以将 Redux 应用中的 action、sta...

    4 年前
  • Angular: 在指令 link 函数中使用 & 调用控制器函数

    在Angular应用程序的开发中,我们经常需要在指令内部调用控制器中的函数。这可以通过使用&绑定实现。 & 介绍 &绑定提供了一种将父级作用域中的表达式传递给指令的方法。

    4 年前
  • npm 包 redux-devtools-gentest-plugin 使用教程

    前言 在前端开发中,状态管理是非常关键的一部分。Redux 是一个常用的状态管理库,也有一系列的工具辅助进行开发和调试。 其中之一就是 Redux DevTools,这是一个浏览器扩展,可以用来调试和...

    4 年前
  • npm 包 redux-devtools-ie8 使用教程

    在 Web 开发中,Redux 是一个非常流行且强大的状态管理库。它提供了一个统一的状态管理方案,使得我们的应用程序结构更加清晰、可维护性更高。 然而,当我们面对更加复杂的应用程序时,调试 Redux...

    4 年前
  • npm 包 redux-simple-models 使用教程

    介绍 redux-simple-models 是一个用来管理 React 和 React Native 应用程序状态的 npm 包。它使用 Redux 的 store 和 reducer 来存储和处理...

    4 年前
  • NPM包redux-mocha-test-generators使用教程

    简介 redux-mocha-test-generators是一个方便、快捷的npm包,用于生成redux模块和mocha测试的模板。 安装 在安装前,确认已经安装了node.js和npm。

    4 年前
  • npm 包 redux-mock-provider 使用教程

    在前端开发中,设计一个可靠的服务端与客户端之间的交互绝对是很重要的一件事情。Redux 是一个非常著名的 JavaScript 应用程序状态容器,并且 Redux 模式中遵循的单向数据流理念也让前端开...

    4 年前
  • npm 包 redux-devtools-dock-monitor-ie8 使用教程

    1. 简述 redux-devtools-dock-monitor-ie8 是一款支持 IE8 浏览器的 Redux DevTools 拓展插件,可以帮助开发者更加高效地调试 Redux 应用程序。

    4 年前
  • npm 包 redux-modal-container 使用教程

    在前端开发中,弹出窗口的需求很常见。但是若每次都手写实现弹窗界面,无疑是一项很费时费力的工作。因此,开发者们将注意力投入到了寻找优秀的弹窗组件上。 redux-modal-container 是一款非...

    4 年前
  • npm 包 redux-simple-promise 使用教程

    简介 redux-simple-promise 是一个用于在 Redux 中简化对异步操作进行处理的库。它基于 Redux 提供的 middleware 来添加异步处理能力,同时使用了 Promise...

    4 年前

相关推荐

    暂无文章