首页
/ Terrific JavaScript Framework 技术文档

Terrific JavaScript Framework 技术文档

2024-12-24 09:42:16作者:温玫谨Lighthearted

1. 安装指南

使用 Bower 安装

TerrificJS 可以通过 Bower 进行安装。执行以下命令即可:

bower install terrific

依赖项

TerrificJS 依赖于以下两个库:

  • es5-shim:用于兼容旧版浏览器。
  • es6-promise:用于支持 ES6 Promise。

如果你通过 Bower 安装 TerrificJS,这些依赖项会自动包含在内。

2. 项目的使用说明

快速开始

让 Terrific 应用程序运行起来非常简单,只需三个步骤:

  1. 创建模块
  2. 注释标记
  3. 启动应用程序

1. 创建模块

使用 T.createModule({ … }) 创建模块:

T.Module.Foo = T.createModule({
    start: function(resolve) {
        // 你的逻辑代码
        resolve();
    }
});

2. 注释标记

terrific.js 引入页面,并通过 data-t-name 属性注释你的标记:

<!DOCTYPE html>
<html>
<head></head>
<body>
    <div data-t-name="Foo">
        ...
    </div>
    <script src="bower_components/terrific/dist/terrific.min.js"></script>
</body>
</html>

3. 启动应用程序

在页面末尾或文档准备好时启动应用程序:

var application = new T.Application();
application.registerModules();
application.start();

3. 项目API使用文档

模块

模块是 TerrificJS 应用程序的核心。所有的 JavaScript 代码都将放在模块中。模块 API 非常简单,包含两个生命周期方法:start()stop()

T.Module.Foo = T.createModule({
    start: function(resolve) {
        // 启动时的逻辑
        resolve();
    },
    stop: function() {
        // 可选,停止时的清理逻辑
    }
});

装饰器

装饰器允许你扩展模块的功能。

示例

创建模块:

T.Module.Foo = T.createModule({
    value: 'foo',
    start: function(resolve, reject) {
        resolve();
    },
    foo: function() {
        return 'foo';
    }
});

创建装饰器:

T.Module.Foo.Bar = T.createDecorator({
    value: 'bar',
    start: function(resolve, reject) {
        this._parent.start(resolve, reject);
    },
    bar: function() {
        return "bar";
    },
    foo: function() {
        var value = this._parent.foo();
        return 'bar-' + value;
    }
});

使用装饰器:

var module = application.registerModule(document.createElement('div'), 'Foo', ['Bar']);
module.bar(); // -> bar
module.foo(); // -> bar-foo
module.value; // -> bar
module.start(); // 执行装饰器和模块的 start 方法

EventEmitter

EventEmitter 允许模块与外部(如其他模块)进行通信。每个模块都有一个绑定的 EventEmitter 实例,可以通过 this._events 访问。

支持的方法

  • emit(event, ...):触发事件。
  • on(event, fn) / addListener(event, fn):注册事件处理函数。
  • once(event, fn):注册一次性事件处理函数。
  • off(event, fn) / removeListener(event, fn) / removeAllListeners(event, fn):移除事件处理函数。
  • listeners(event):返回事件处理函数的数组。
  • hasListeners(event):检查是否存在该事件的处理函数。

示例

T.Module.Foo = T.createModule({
    start: function(resolve) {
        this._events.on('foo', function() {
            // 处理事件
        });
        resolve();
    }
});

启动应用程序

启动应用程序的代码应放在页面末尾或文档准备好时:

var application = new T.Application();
application.registerModules();
application.start();

4. 项目安装方式

通过 Bower 安装

执行以下命令安装 TerrificJS:

bower install terrific

依赖项

TerrificJS 依赖于 es5-shimes6-promise,这些依赖项会自动包含在 Bower 安装中。

热门项目推荐
相关项目推荐

项目优选

收起
Python-100-DaysPython-100-Days
Python - 100天从新手到大师
Python
611
115
HarmonyOS-ExamplesHarmonyOS-Examples
本仓将收集和展示仓颉鸿蒙应用示例代码,欢迎大家投稿,在仓颉鸿蒙社区展现你的妙趣设计!
Cangjie
286
79
mdmd
✍ WeChat Markdown Editor | 一款高度简洁的微信 Markdown 编辑器:支持 Markdown 语法、色盘取色、多图上传、一键下载文档、自定义 CSS 样式、一键重置等特性
Vue
112
25
openHiTLSopenHiTLS
旨在打造算法先进、性能卓越、高效敏捷、安全可靠的密码套件,通过轻量级、可剪裁的软件技术架构满足各行业不同场景的多样化要求,让密码技术应用更简单,同时探索后量子等先进算法创新实践,构建密码前沿技术底座!
C
60
48
RuoYi-Cloud-Vue3RuoYi-Cloud-Vue3
🎉 基于Spring Boot、Spring Cloud & Alibaba、Vue3 & Vite、Element Plus的分布式前后端分离微服务架构权限管理系统
Vue
45
29
go-stockgo-stock
🦄🦄🦄AI赋能股票分析:自选股行情获取,成本盈亏展示,涨跌报警推送,市场整体/个股情绪分析,K线技术指标分析等。数据全部保留在本地。支持DeepSeek,OpenAI, Ollama,LMStudio,AnythingLLM,硅基流动,火山方舟,阿里云百炼等平台或模型。
Go
1
0
Cangjie-ExamplesCangjie-Examples
本仓将收集和展示高质量的仓颉示例代码,欢迎大家投稿,让全世界看到您的妙趣设计,也让更多人通过您的编码理解和喜爱仓颉语言。
Cangjie
205
58
MateChatMateChat
前端智能化场景解决方案UI库,轻松构建你的AI应用,我们将持续完善更新,欢迎你的使用与建议。 官网地址:https://matechat.gitcode.com
383
36
RuoYi-VueRuoYi-Vue
🎉 基于SpringBoot,Spring Security,JWT,Vue & Element 的前后端分离权限管理系统,同时提供了 Vue3 的版本
Java
182
44
frogfrog
这是一个人工生命试验项目,最终目标是创建“有自我意识表现”的模拟生命体。
Java
8
0