组件模板和样式

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

组件模板

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

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

代码示例:

  1. <!-- 组件模板 -->
  2. <view class="wrapper">
  3. <view>这里是组件的内部节点</view>
  4. <slot></slot>
  5. </view>
  1. <!-- 引用组件的页面模板 -->
  2. <view>
  3. <component-tag-name>
  4. <!-- 这部分内容将被放置在组件 <slot> 的位置上 -->
  5. <view>这里是插入到组件slot中的内容</view>
  6. </component-tag-name>
  7. </view>

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

模板数据绑定

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

代码示例:

  1. <!-- 引用组件的页面模板 -->
  2. <view>
  3. <component-tag-name prop-a="{{dataFieldA}}" prop-b="{{dataFieldB}}">
  4. <!-- 这部分内容将被放置在组件 <slot> 的位置上 -->
  5. <view>这里是插入到组件slot中的内容</view>
  6. </component-tag-name>
  7. </view>

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

注意:这样的数据绑定只能传递 JSON 兼容数据。

组件qml的slot

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

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

  1. Component({
  2. options: {
  3. multipleSlots: true // 在组件定义时的选项中启用多slot支持
  4. },
  5. properties: { /* ... */ },
  6. methods: { /* ... */ }
  7. })

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

  1. <!-- 组件模板 -->
  2. <view class="wrapper">
  3. <slot name="before"></slot>
  4. <view>这里是组件的内部细节</view>
  5. <slot name="after"></slot>
  6. </view>

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

  1. <!-- 引用组件的页面模板 -->
  2. <view>
  3. <component-tag-name>
  4. <!-- 这部分内容将被放置在组件 <slot name="before"> 的位置上 -->
  5. <view slot="before">这里是插入到组件slot name="before"中的内容</view>
  6. <!-- 这部分内容将被放置在组件 <slot name="after"> 的位置上 -->
  7. <view slot="after">这里是插入到组件slot name="after"中的内容</view>
  8. </component-tag-name>
  9. </view>

组件样式

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

  • 组件和引用组件的页面不能使用id选择器(#a)、属性选择器([a])和标签名选择器,请改用class选择器。
  • 组件和引用组件的页面中使用后代选择器(.a .b)在一些极端情况下会有非预期的表现,如遇,请避免使用。
  • 子元素选择器(.a>.b)只能用于 view 组件与其子节点之间,用于其他组件可能导致非预期的情况。
  • 继承样式,如 fontcolor ,会从组件外继承到组件内。
  • 除继承样式外, app.qss 中的样式、组件所在页面的的样式对自定义组件无效。
  1. #a {
  2. } /* 在组件中不能使用 */
  3. [a] {
  4. } /* 在组件中不能使用 */
  5. button {
  6. } /* 在组件中不能使用 */
  7. .a > .b {
  8. } /* 除非 .a 是 view 组件节点,否则不一定会生效 */

除此以外,组件可以指定它所在节点的默认样式,使用 :host 选择器。

代码示例:

  1. /* 组件 custom-component.qss */
  2. :host {
  3. color: yellow;
  4. }
  1. <!-- 页面的 QML -->
  2. <custom-component>这段文本是黄色的</custom-component>

外部样式类

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

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

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

代码示例:

  1. /* 组件 custom-component.js */
  2. Component({
  3. externalClasses: ['my-class']
  4. })
  1. <!-- 组件 custom-component.qml -->
  2. <custom-component class="my-class">
  3. 这段文本的颜色由组件外的 class 决定
  4. </custom-component>

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

代码示例:

  1. <!-- 页面的 QML -->
  2. <custom-component my-class="red-text" />
  1. .red-text {
  2. color: red;
  3. }

使组件接受全局样式

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

  • app.qss 或页面的 qss 中使用了标签名选择器(或一些其他特殊选择器)来直接指定样式,这些选择器会影响到页面和全部组件。通常情况下这是不推荐的做法。
  • 在特定的自定义组件激活了 addGlobalClass 选项,这使得这个自定义组件能被 app.qss 或页面的 qss 中的所有的样式定义影响。要激活 addGlobalClass 选项,只需要在 Component 构造器中将 options.addGlobalClass 字段置为 true

注意:当激活了 addGlobalClass 选项后,存在外部样式污染组件样式的风险,请谨慎选择。

代码示例:

  1. /* 组件 custom-component.js */
  2. Component({
  3. options: {
  4. addGlobalClass: true,
  5. }
  6. })
  1. <!-- 组件 custom-component.qml -->
  2. <text class="red-text">
  3. 这段文本的颜色由 `app.qss` 和页面 `qss` 中的样式定义来决定
  4. </text>
  1. /* app.qss */
  2. .red-text {
  3. color: red;
  4. }