有渔工具库

介绍 YouYu 对象的用法及机制

介绍

有渔工具库提供了一些方便项目开发的 API 以及少量的 UI 组件。本文档的主要内容就是讲述每个 API 的使用方法,以及其他一些重要的事情。

目录

构成

YouYu 对象的方法大致可分为下面几种类别。

YouYu 对象相关操作

此类 API 有对 YouYu 进行修改的能力,修改名字和进行扩展什么的。

对了,YouYu 在项目中有个别名——CM也就是说,调用 YouYu 的那些方法只需要用两个字母就可以啦!

内建对象相关操作

包含了对变量的类型进行检测、转换等功能的方法。

项目开发

提供了有助于业务逻辑实现及开发所需资源配置等的方法。

自定义 UI 组件

通过 YouYu.addComponent() 创建的 UI 组件。

文件结构

YouYu 对象有关的文件分布如下所示:

.
├─┬─ youyu                   === YouYu 对象(底层库)
│ ├─┬─ templates             --- YouYu 对象内部构建用 HTML 模板
│ │ └─── ...
│ ├─── compatibility.coffee  --- 处理浏览器和第三方插件兼容性
│ ├─── component.coffee      --- 添加自定义组件
│ └─── core.coffee.erb       --- 一些工具方法
│
├─┬─ components              === 自定义组件的定义和事件绑定
│ ├─── notification.coffee   --- 系统通知组件
│ ├─── punctuation.coffee    --- 使标点符号兼容各个浏览器
│ └─── score.coffee          --- 评分组件
│
└─┬─ project                 === 项目通用文件
  └─┬─ extensions            --- 项目相关的对 YouYu 对象扩展
    ├─── session.coffee      --- 需要登录系统之后才能进行的操作
    └─── utilities.coffee    --- 一些辅助方法

youyu 文件夹中的文件所定义的是核心方法,需要全局引用;componentsproject 文件夹中的文件则按需引用。