Object-oriented Web Templating 使用指南

1. 安装指南

1.1 使用 npm 安装

在您的项目中，通过 npm 安装 OJ：

npm install ojjs

1.2 使用 yarn 安装

如果您的项目使用 yarn 作为包管理工具，可以使用以下命令安装 OJ：

yarn add ojjs

1.3 手动安装

从 ojjs.org/download 下载最新版本的 OJ，将其包含在您的项目中。

2. 项目的使用说明

OJ 是一个面向对象的网页模板库，旨在简化网页开发。以下是基本的使用方法：

2.1 创建对象

OJ 允许您通过创建对象的方式来生成 HTML 结构。例如，创建一个按钮：

var button = new oj.Button({
  text: '点击我',
  onclick: function() {
    alert('按钮被点击了！');
  }
});

2.2 绑定模型

OJ 支持双向模型绑定，如果使用 Backbone 模型，可以轻松实现：

var model = new Backbone.Model({
  text: '初始文本'
});

var textInput = new oj.Text({
  model: model,
  attribute: 'text'
});

当模型属性改变时，文本框的值也会自动更新。

2.3 使用插件

OJ 提供了多种插件，例如 YouTubeVideo、VimeoVideo 等，可以通过以下方式引入和使用：

require('oj-YouTubeVideo');
var video = new oj.YouTubeVideo({
  videoId: 'exampleVideoId'
});

3. 项目API使用文档

OJ 的 API 包括多种类型的对象和函数，以下是一些核心类型的简要说明：

3.1 基础类型

• oj.Button：创建一个按钮。
• oj.CheckBox：创建一个复选框。
• oj.ListBox：创建一个下拉列表。
• oj.Text：创建一个文本框。
• oj.TextArea：创建一个文本区域。

3.2 集合类型

• oj.List：创建一个列表。
• oj.Table：创建一个表格。

3.3 创建类型

• oj.createType：允许用户创建自定义类型。

4. 项目安装方式

OJ 支持多种安装方式，您可以根据项目需求选择以下任意一种：

4.1 命令行工具

OJ 提供了一个命令行工具，可以通过以下命令安装：

npm install -g oj

然后，在项目目录中使用以下命令编译：

oj compile

4.2 直接引入

在 HTML 文件中直接引入下载的 OJ 文件：

<script src="path/to/oj.js"></script>

然后，在 JavaScript 代码中使用 OJ。

以上是 OJ 的基本安装和使用指南，希望对您的开发有所帮助。