这部分是一个进展中的工作。
本节旨在为XWiki应用程序开发者和XWiki产品开发者记录所有前端资源。前端资源主要有两种类型:
- 外部库
- 内部组件
前端资源主要由JavaScript库,CSS样式表和相应的可重复使用的HTML代码片段(或velocity宏来输出代码片段) 和velocity宏。
在默认情况下,这里介绍的一些资源没有被所有HTML渲染的wiki页面(太多要发送到客户端!)包含。你需要使用jsfx插件从一个皮肤模板或wiki页面请求他们。例如,请求scriptaculous slide库,在XWiki语法1.0可以这样写:
$xwiki.jsfx.use("js/scriptaculous/slider.js")
在
{{velocity}}
$xwiki.jsfx.use("js/scriptaculous/slider.js")
{{/velocity}}
你指定的jsfx插件的路径是library库在XWiki webapp的resources目录下的相对路径。类似于jsfx插件,ssfx插件可以请求CSS样式表文件。
外部资源
XWiki Enterprise包含了一些默认捆绑的第三方库。
下面是一个表,列出XWiki Enterprise自带的一些外部库:
库名称 | 描述 |
---|---|
| Prototype 是一个 "JavaScript框架,旨在简化Web应用程序的开发"。它扩展了原生的JavaScript对象,而且很好的支持Ajax。Prototype是XWiki页面上唯一系统附带的JavaScript库。 |
| Smartclient 是一个AJAX RIA系统,可以轻松开发丰富的界面组件。在XWiki使用Smartclient,可以构建出充分利用XWiki's RESTful API的强大的前端部件。 |
Scriptaculous | |
YUI | |
LiveValidation | |
JQuery | jQuery 是 "一个快速,体积小,功能丰富的JavaScript库。它可以在众多的浏览器中通过一个易于使用的API使得HTML文档遍历和操作,事件处理,动画,和Ajax的事情变得非常简单。随着通用性和可扩展性的组合,jQuery的改变了数以百万计的人编写JavaScript的方式。" |
JQuery UI | jQuery UI 是"建立在 jQuery JavaScript 库上的一组用户界面交互、特效、小部件及主题。无论你是创建高度交互的 Web 应用程序还是仅仅向窗体控件添加一个日期选择器,jQuery UI 都是一个完美的选择。" |
Bootstrap | Bootstrap 是"最流行的HTML, CSS, 和JS框架。用于开发响应式布局、移动设备优先的WEB项目" XWiki绑定Bootstrap,因为XWiki皮肤是基于Bootstrap。 |
查看在XWiki页面使用jQuery和jQuery UI的例子。
内部资源
前端组件
- Modal Popup
- Confirmation Box
- LiveTable
- Auto Suggest Widget
- Notification Widget
- HTML5 Upload
- Autosave
- XWiki Select
JavaScript资源
- JavaScriptAPI
- XWiki RESTFul API
样式表资源
- Pagination
- Result List
- Search Box
- Suggest Box
- Special CSS Classes
- CSS classes used for icons
- 表格布局类型:
- Vertical Layout
- Inline Layout