sidebar: custom-component_comp

title: Component构造器 header: develop nav: framework

sidebar: custom-component_comp

定义段与示例方法

生成的组件实例可以在组件的方法、生命周期函数和属性 observer 中通过 this 访问。组件包含一些通用属性和方法。

代码示例 在开发者工具中预览效果

// 自定义组件js
Component({
    properties: {
        propName: { // 属性名
            type: String, // 类型（必填），目前接受的类型包括：String, Number, Boolean, Object, Array, null（表示任意类型）
            value: 'val', // 属性初始值（必填）
            observer: function(newVal, oldVal) {
                // 属性被改变时执行的函数（可选）
            }
        }
    },
    data: {}, // 私有数据，可用于模板渲染
    // 生命周期函数，可以为函数，或一个在methods段中定义的方法名
    attached: function () {},
    detached: function () {},
    methods: {
        onTap: function () {
            this.setData({
               // 更新属性和数据的方法与更新页面数据的方法类似
            });
        }
    }
});

注意： 在 properties 定义段中，属性名应该采用驼峰写法（propsName）；在 swan 模板中，指定属性值时则对应使用连字符写法（ component-tag-name props-name="props value" ）。

使用 Component 构造器构造页面

解释: 事实上，一个自定义组件也可以视为一个页面，故页面也可以使用 Component 构造器构造，拥有与普通组件一样的定义段与实例方法，其必要配置项（json）与正常自定义组件一致，即需要有component: true字段。

关于页面传参: 从其它页面跳转到由自定义组件构造的页面时，如跳转到页面 /components/custom/custom?paramA=123&paramB=xyz ，你可以在由custom组件构造的页面onLoad生命周期中获取传递的query字段。

注意: 页面的生命周期方法（即 on 开头的方法），应写在 methods 定义段中。

代码示例

{
    "component": true,
    "usingComponents": {}
}

/* /components/custom/custom.js */
Component({
    methods: {
        onLoad: function(options) {
            console.log(options.paramA); // 123
            console.log(options.paramB); // xyz
        }
    }
});

使用 Component 构造器来构造页面的一个好处是可以使用 behaviors 来提取所有页面中公用的代码段。例如，在所有页面被创建和销毁时都要执行同一段代码，就可以把这段代码提取到 behaviors 中。

代码示例 在开发者工具中预览效果

// behavior.js
module.exports = Behavior({
    attached: function() {
        // 页面创建时执行
        console.info('Page loaded!')
    },
    detached: function() {
        // 页面销毁时执行
        console.info('Page unloaded!')
    }
})

// 自定义组件 A
var pageCommonBehavior = require('../behavior.js')
Component({
    behaviors: [pageCommonBehavior],
    data: { /* ... */ },
    methods: { /* ... */ },
})

// 自定义组件 B
var pageCommonBehavior = require('../behavior.js')
Component({
    behaviors: [pageCommonBehavior],
    data: { /* ... */ },
    methods: { /* ... */ },
})

说明：

• 使用 this.data 可以获取内部数据和属性值，但不要直接修改它们，应使用 setData 修改；
• 属性名应避免以 data- 开头，因为在 SWAN 中，data-name='swan' 会被作为节点 dataset 来处理；
• 属性名应避免以 prop- 开头 在处理过程中会将该前缀删除；
• 属性名应避免包含 “ ” 字符, 因为在渲染过程中将会以 “ ” 字符进行拆分。