样式
ONLYOFFICE 提供了用于不同界面元素的样式表。若要使你的插件界面适配 ONLYOFFICE 的样式,可以在 index.html 文件中通过以下链接引入 plugin.css 文件:
<link rel="stylesheet" href="https://onlyoffice.github.io/sdkjs-plugins/v1/plugins.css">
为了保持用户插件界面的一致性,您可以使用一组专为生成插件 UI 设计的预构建基础组件。您可以在我们的 Storybook 中探索组件功能,并进行交互。
所有可用的控件也都在[控件示例]Controls example 插件中展示:
按钮
-
使用 btn-text-default 类可在您的插件中添加按钮 2:
<button class="btn-text-default" style="width:75px;">Button 1</button>
该类具有以下参数:
.btn-text-default {
background: #fff;
border: 1px solid #cfcfcf;
border-radius: 2px;
color: #444444;
font-size: 11px;
font-family: "Helvetica Neue", Helvetica, Arial, sans-serif;
height: 22px;
cursor: pointer;
} -
使用 btn-text-default.submit.primary 类可在您的插件中添加按钮 2:
<button class="btn-text-default submit primary" style="width:75px;">Button 2</button>
该类具有以下参数:
.btn-text-default.submit.primary {
color: #fff;
background-color: #7d858c;
} -
使用 btn-text-default.submit 类可在您的插件中添加按钮 3:
<button class="btn-text-default submit" style="width:75px;">Button 3</button>
该类具有以下参数:
.btn-text-default.submit {
font-weight: bold;
background-color: #d8dadc;
border: 1px solid transparent;
}按钮颜色由开发者自行选择。按钮颜色越深,表示其重要性越高。通常,btn-text-default.submit.primary 类的按钮用于确认操作并提交结果(例如,确认按钮)。
-
使用 btn-edit 类可为您的插件添加
编辑按钮:
<label class="for-combo">Edit button</label><div class="btn-edit" style="display: inline-block; margin-left: 10px;"></div>
该类具有以下参数:
.btn-edit {
width: 13px;
height: 13px;
cursor: pointer;
background-image: url('data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAA0AAAANCAYAAABy6+R8AAAACXBIWXMAAAsTAAALEwEAmpwYAAAAAXNSR0IArs4c6QAAAARnQU1BAACxjwv8YQUAAAGZSURBVHgBfZI/y4FRGMavx7+SRQaTTQab74CVlBKL/FukDGQhEgsDNh/Apiw+gcXm70DJoEikKMUk7vec8/Yi75O7Tj2d+/4913Wuc6Tz+UyQqev1itvtBr1e/6+nkgP2+z0qlYr4DgaDsNls36HtdotisYhoNAqLxYJyuSz230HFO7DZbISC0+lEp9OBRqNBLpdDq9XCeDx+DfIz8TWZTIhZodFoRMvlknw+H8XjcdrtdrRarYgpU6/XE7MC4oMc4OB8Pie/30/ZbJba7TYlk0k6HA4CDIVCxNyQYrFYoNFoIJ1OQ5Ik5PN5WK1WpFIprNdr8H61WhVn5X2VisXg8XhoNpvRYDAgt9tNbICOxyOVSiVyuVzU7/epXq9TIBAQtrkzxeVygclkQrfbhd1uRzgcRq1Ww3A4FKparRbspyJRo9H4G4TD4RD06XQS3pkt8nq9NJ1OiSVGsVjsqfC3nvekVCrxeDxgMBgQiUTEa2g2m8hkMi8FuXtSq9VIJBK43+8iHB7GJ8BL4vY+N3U6HQqFAsxmM+TqB5Je/SVNoN18AAAAAElFTkSuQmCC');
}
输入控件
-
使用 textarea 表单元素可在插件中添加一个文本区域:
<textarea style="height:45px;width: 100%;" class="form-control" placeholder="textarea control"></textarea>
该类具有以下参数:
textarea.form-control {
resize: none;
} -
使用带有文本类型的输入表单元素,可在插件中添加文本输入框:
<input type="text" class="form-control" placeholder="text field" style="width: 100%;margin-bottom: 2px;">
该类具有以下参数:
.form-control {
border: 1px solid #cfcfcf;
border-radius: 2px;
box-sizing: border-box;
color: #444444;
font-size: 11px;
height: 22px;
padding: 1px 3px;
-webkit-box-shadow: none;
box-shadow: none;
-webkit-user-select: text;
-moz-user-select: text;
-ms-user-select: text;
user-select: text;
} -
使用带有复选框类型的输入表单元素,可在插件中添加一个
复选框:
<input type="checkbox" class="form-control" style="vertical-align: middle;"><label style="margin-left: 5px;vertical-align: middle;">Checkbox</label>
该类具有以下参数:
input[type='checkbox '].form-control {
height: auto;
margin: 0;
}
标签控件
-
使用 label.header 类可在插件中添加一个加粗标题:
<label class="header">Header label</label>
该类具有以下参数:
label.header {
font-weight: bold;
} -
使用 label.link 类可在插件中添加一个链接:
<label class="link">Link label</label>
该类具有以下参数:
label.link {
border-bottom: 1px dotted #aaa;
cursor: pointer;
}
下拉组合框
使用 select2 功能可在插件中添加一个下拉组合框:
<select id="select_example" class="" ></select>
$('#select_example').select2({
data : [{id:0, text:'Item 1'}, {id:1, text:'Item 2'}, {id:2, text:'Item 3'}],
minimumResultsForSearch: Infinity,
width : '120px'
});
加载器
使用 asc-loader-container 类可在插件中添加一个加载器容器:
<div id="loader-container" class="asc-loader-container" style="margin: 10px; height: 40px; border: 1px solid #cfcfcf;"></div>
该类具有以下参数:
.asc-loader-container {
position: relative;
}
示例
以下是如何在 YouTube 插件中添加符合 ONLYOFFICE 风格的界面元素。
-
要添加简单的白色确认按钮,请使用 btn-text-default 类(按钮宽度为 30 像素):
<button class="btn-text-default" style="width:30px;">OK</button>
-
添加输入框时,使用表单控件类(表单宽度为 100%,即根据父元素宽度自适应):
<input type="text" class="form-control" style="width:100%;">
-
添加深灰色的确认按钮,使用 btn-text-default.submit.primary 类(按钮宽度为 90 像素):
<button class="btn-text-default submit primary" style="width:90px;">Ok</button>
-
添加浅灰色的取消按钮,使用 btn-text-default.submit 类(按钮宽度为 90 像素):
<button class="btn-text-default submit" style="margin-left:5px; width:90px;">Cancel</button>