o- 私人创办
: 警告: 注:该包只应在Origami组件中使用。 如果您正在开发 Origami 组件, 请不要使用此软件包 .
Origami组件集,用于其他Origami组件.
关于该部分的说明。 我们按Markup,JavaScript,Sass等分解了这个. 您可以根据需要添加更多章节 .
使用量
检查出来 如何将 Origami 组件纳入您的项目 开始 o-private-foundation。 。 。 .
行为
o-private-foundation 行为描述.
标记
组件标记文档 。 包括cs类,数据属性,以及组件变异的标记. Demo 标记也显示在登记册中。 对于复杂的加分,可以描述加分和与登记演示的链接,作为完整的例子. 记住用3个后置键和"html"开始代码块,所以你的标记是语法上突出的正确.
<div data-o-component="o-private-foundation" class='o-private-foundation'>
</div>
萨斯
Sass文档. 并指示包含有主混音的样式,有哪些选项可供选择,在适用的情况下提供品牌支持. 对于复杂的组件来说,用 SassDoc 来记录活页,并与 Origami 登记簿中的 SassDoc 组件相连接,可能是有益的. 记得用三个后缀和"cs"开始代码块,所以你的标记是语法上突出的正确.
使用 @include oPrivateFoundation() 包含样式 o-private-foundation 特性.
@import "@financial-times/o-private-foundation";
@include oPrivateFoundation();
Java 脚本
JavaScript 文档. 包括如何将组件、可用选项和通用使用大小写载入备忘. 对于复杂的部分,也许应该用JSDoc记录Apis,并与Origami登记簿中的JSDocs链接. 记得用三个回击和"j"来启动代码块,所以你的j是语法上突出的正确.
JavaScript 已自动禁用 折纸建筑服务 用户。 如果你的项目是使用人工构建程序, 备忘 o-private-foundation 手动。 。 。 .
比如说叫 init 启用全部方法 o-private-foundation 文档中的实例 :
import oPrivateFoundation from 'o-private-foundation';
oPrivateFoundation.init();
或将元素传递到地址簿 o-private-foundation 实例:
import oPrivateFoundation from 'o-private-foundation';
const oPrivateFoundationElement = document.getElementById('#my-o-private-foundation-element');
oPrivateFoundation.init(oPrivateFoundationElement);
解决问题
回答反复出现的问题. 可能你暂时可以删除这个部分. 记得从目录中删除.
捐款
为非典型组件提供文件. 如果您的组件符合其他组件, 您可能可以删除此部分 . 记住要更新目录, 请删除此部分 .
移徙
从一个主要版本升级到另一个版本的指南.
本节包括一个主要版本的表格,链接到 MIGRATION.md。 。 。 .
MIGRATION.md 将提供升级指示,但由于这是一个新的组件,没有 MIGRATION.md。 。 。 .
删去本节,包括从目录中删除,直到本部分有第二个主要版本.
| 状态 | 主要版本 | 最后一个小版本 | 移徙指南 |
|---|---|---|---|
| 活动 | 3个 | 不详 | 迁移到 v3 |
| 维护 | 2个 | 2.0 数据 | 迁移到 v2 |
| 已贬值 | 1个 | 1.0 国家 | 不详 |
联系人
如果您对本部分有任何问题或评论,或需要帮助使用本部分,请 提出问题访问 #origami - 支持 或电子邮件 折纸. [email protected]。 。 。 .
许可证
本软件由金融时报根据以下规定出版: 麻省理工学院许可证。 。 。 . `; * ;