程序框架自定义组件说明

网友投稿 283 2024-06-30

自定义组件

#1. 组件模板和样式

类似于页面,自定义组件拥有自己的 FXML 模板和 FTSS 样式。

#1.1 组件模板

小程序框架自定义组件说明

组件模板的写法与页面模板相同。组件模板与组件数据结合后生成的节点树,将被插入到组件的引用位置上。

在组件模板中可以提供一个 <slot> 节点,用于承载组件引用时提供的子节点。

代码示例

<!-- 组件模板 --><view class="wrapper">
  <view>这里是组件的内部节点</view>
  <slot></slot></view><!-- 引用组件的页面模板 --><view>
  <component-tag-name>
    <!-- 这部分内容将被放置在组件 <slot> 的位置上 -->
    <view>这里是插入到组件slot中的内容</view>
  </component-tag-name></view>
        已复制代码

注意

在模板中引用到的自定义组件及其对应的节点名需要在 json 文件中显式定义,否则会被当作一个无意义的节点。除此以外,节点名也可以被声明为抽象节点。

#1.2 模板数据绑定

与普通的 FXML 模板类似,可以使用数据绑定,这样就可以向子组件的属性传递动态数据。

代码示例

<!-- 引用组件的页面模板 --><view>
  <component-tag-name prop-a="{{dataFieldA}}" prop-b="{{dataFieldB}}">
    <!-- 这部分内容将被放置在组件 <slot> 的位置上 -->
    <view>这里是插入到组件slot中的内容</view>
  </component-tag-name></view>
        已复制代码

在以上例子中,组件的属性 propA 和 propB 将收到页面传递的数据。页面可以通过 setData 来改变绑定的数据字段。

注意

这样的数据绑定只能传递 JSON 兼容数据。自基础库版本 2.0.9 开始,还可以在数据中包含函数(但这些函数不能在 FXML 中直接调用,只能传递给子组件)。

#1.3 组件 FXML 的 slot

在组件的 FXML 中可以包含 slot 节点,用于承载组件使用者提供的 FXML 结构。

默认情况下,一个组件的 FXML 中只能有一个 slot 。需要使用多 slot 时,可以在组件 js 中声明启用。

Component({
  options: {
    multipleSlots: true // 在组件定义时的选项中启用多slot支持
  },
  properties: { /* ... */ },
  methods: { /* ... */ }})
        已复制代码

此时,可以在这个组件的 FXML 中使用多个 slot ,以不同的 name 来区分。

<!-- 组件模板 --><view class="wrapper">
  <slot name="before"></slot>
  <view>这里是组件的内部细节</view>
  <slot name="after"></slot></view>
        已复制代码

使用时,用 slot 属性来将节点插入到不同的 slot 上。

<!-- 引用组件的页面模板 --><view>
  <component-tag-name>
    <!-- 这部分内容将被放置在组件 <slot name="before"> 的位置上 -->
    <view slot="before">这里是插入到组件slot name="before"中的内容</view>
    <!-- 这部分内容将被放置在组件 <slot name="after"> 的位置上 -->
    <view slot="after">这里是插入到组件slot name="after"中的内容</view>
  </component-tag-name></view>
        已复制代码

#1.4 组件样式

组件对应 FTSS 文件的样式,只对组件FXML内的节点生效。编写组件样式时,需要注意以下几点:

  • 组件和引用组件的页面不能使用id选择器(#a)、属性选择器([a])和标签名选择器,请改用class选择器。

  • 组件和引用组件的页面中使用后代选择器(.a .b)在一些极端情况下会有非预期的表现,如遇,请避免使用。

  • 子元素选择器(.a>.b)只能用于 view 组件与其子节点之间,用于其他组件可能导致非预期的情况。

  • 继承样式,如 font 、 color ,会从组件外继承到组件内。

  • 除继承样式外, app.ftss 中的样式、组件所在页面的的样式对自定义组件无效(除非更改组件样式隔离选项)。

  • #a { } /* 在组件中不能使用 */

  • [a] { } /* 在组件中不能使用 */

  • button { } /* 在组件中不能使用 */

  • .a > .b { } /* 除非 .a 是 view 组件节点,否则不一定会生效 */ 除此以外,组件可以指定它所在节点的默认样式,使用 :host 选择器。

代码示例

/* 组件 custom-component.ftss */:host {
  color: yellow;}
        已复制代码
<!-- 页面的 fxml --><custom-component>这段文本是黄色的</custom-component>
        已复制代码

#1.5 组件样式隔离

默认情况下,自定义组件的样式只受到自定义组件 FTSS 的影响。除非以下两种情况:

  1. app.ftss 或页面的 FTSS 中使用了标签名选择器(或一些其他特殊选择器)来直接指定样式,这些选择器会影响到页面和全部组件。通常情况下这是不推荐的做法。

  2. 指定特殊的样式隔离选项 styleIsolation 。

Component({
  options: {
    styleIsolation: 'isolated'
  }})
        已复制代码

styleIsolation 选项从基础库版本 1.1.7 开始支持。它支持以下取值:

  • isolated 表示启用样式隔离,在自定义组件内外,使用 class 指定的样式将不会相互影响(一般情况下的默认值);

  • apply-shared 表示页面 FTSS 样式将影响到自定义组件,但自定义组件 FTSS 中指定的样式不会影响页面;

  • shared 表示页面 FTSS 样式将影响到自定义组件,自定义组件 FTSS 中指定的样式也会影响页面和其他设置了 apply-shared 或 shared 的自定义组件。 使用后两者时,请务必注意组件间样式的相互影响。

如果这个 Component 构造器用于构造页面 ,则默认值为 shared。此外,小程序基础库版本 1.1.7 以上支持 addGlobalClass 选项,即在 Component 的 options 中设置 addGlobalClass: true 。

这个选项等价于设置 styleIsolation: apply-shared ,但设置了 styleIsolation 选项后这个选项会失效。

代码示例

/* 组件 custom-component.js */Component({
  options: {
    addGlobalClass: true,
  }})
        已复制代码
<!-- 组件 custom-component.fxml --><text class="red-text">这段文本的颜色由 `app.ftss` 和页面 `ftss` 中的样式定义来决定</text>
        已复制代码
/* app.ftss */.red-text {
  color: red;}
        已复制代码

#1.6 外部样式类

基础库 1.1.7 开始支持,低版本需做兼容处理。

有时,组件希望接受外部传入的样式类。此时可以在 Component 中用 externalClasses 定义段定义若干个外部样式类。

这个特性可以用于实现类似于 view 组件的 hover-class 属性:页面可以提供一个样式类,赋予 view 的 hover-class ,这个样式类本身写在页面中而非 view 组件的实现中。

注意

在同一个节点上使用普通样式类和外部样式类时,两个类的优先级是未定义的,因此最好避免这种情况。

代码示例

/* 组件 custom-component.js */Component({
  externalClasses: ['my-class']})
        已复制代码
<!-- 组件 custom-component.fxml --><custom-component class="my-class">这段文本的颜色由组件外的 class 决定</custom-component>
        已复制代码

这样,组件的使用者可以指定这个样式类对应的 class ,就像使用普通属性一样,可以指定多个对应的 class 。

代码示例

<!-- 页面的 fxml --><custom-component my-class="red-text large-text" />
        已复制代码
.red-text {
  color: red;}.large-text {
  font-size: 1.5em;}


版权声明:本文内容由网络用户投稿,版权归原作者所有,本站不拥有其著作权,亦不承担相应法律责任。如果您发现本站中有涉嫌抄袭或描述失实的内容,请联系我们jiasou666@gmail.com 处理,核实后本网站将在24小时内删除侵权内容。

上一篇:小程序框架之初始渲染缓存
下一篇:小程序Component 构造器可用于定义组件
相关文章

 发表评论

暂时没有评论,来抢沙发吧~