Taro 规范

项目组织

文件组织形式

以下文件组织规范为最佳实践的建议

所有项目源代码请放在项目根目录 src 目录下,项目所需最基本的文件包括 入口文件 以及 页面文件

  • 入口文件为 app.js
  • 页面文件建议放置在 src/pages 目录下

一个可靠的 Taro 项目可以按照如下方式进行组织

  1. ├── config 配置目录
  2. |├── dev.js 开发时配置
  3. |├── index.js 默认配置
  4. |└── prod.js 打包时配置
  5. ├── src 源码目录
  6. |├── components 公共组件目录
  7. |├── pages 页面文件目录
  8. ||├── index index 页面目录
  9. |||├── banner 页面 index 私有组件
  10. |||├── index.js index 页面逻辑
  11. |||└── index.css index 页面样式
  12. |├── utils 公共方法库
  13. |├── app.css 项目总通用样式
  14. |└── app.js 项目入口文件
  15. └──package.json

文件命名

Taro 中普通 JS/TS 文件以小写字母命名,多个单词以下划线连接,例如 util.jsutil_helper.js

Taro 组件文件命名遵循 Pascal 命名法,例如 ReservationCard.jsx

文件后缀

Taro 中普通 JS/TS 文件以 .js 或者 .ts 作为文件后缀

Taro 组件则以 .jsx 或者 .tsx 作为文件后缀,当然这不是强制约束,只是作为一个实践的建议,组件文件依然可以以 .js 或者 .ts 作为文件后缀

JavaScript 书写规范

在 Taro 中书写 JavaScript 请遵循以下规则

基本书写

使用两个空格进行缩进

不要混合使用空格与制表符作为缩进

  1. function hello (name){
  2. console.log('hi', name)// ✓ 正确
  3. console.log('hello', name)// ✗ 错误
  4. }

除了缩进,不要使用多个空格

  1. const id =1234// ✗ 错误
  2. const id =1234// ✓ 正确

不要在句末使用分号

  1. const a ='a'// ✓ 正确
  2. const a ='a';// ✗ 错误

字符串统一使用单引号

  1. console.log('hello there')
  2. // 如果遇到需要转义的情况,请按如下三种写法书写
  3. const x ='hello "world"'
  4. const y ='hello \'world\''
  5. const z =`hello 'world'`

代码块中避免多余留白

  1. if(user){
  2. // ✗ 错误
  3. const name = getName()
  4. }
  5. if(user){
  6. const name = getName()// ✓ 正确
  7. }

关键字后面加空格

  1. if(condition){...}// ✓ 正确
  2. if(condition){...}// ✗ 错误

函数声明时括号与函数名间加空格

  1. function name (arg){...}// ✓ 正确
  2. function name(arg){...}// ✗ 错误
  3. run(function(){...})// ✓ 正确
  4. run(function(){...})// ✗ 错误

展开运算符与它的表达式间不要留空白

  1. fn(... args)// ✗ 错误
  2. fn(...args)// ✓ 正确

遇到分号时空格要后留前不留

  1. for(let i =0;i < items.length ;i++){...}// ✗ 错误
  2. for(let i =0; i < items.length; i++){...}// ✓ 正确

代码块首尾留空格

  1. if(admin){...}// ✗ 错误
  2. if(admin){...}// ✓ 正确

圆括号间不留空格

  1. getName( name )// ✗ 错误
  2. getName(name)// ✓ 正确

属性前面不要加空格

  1. user .name // ✗ 错误
  2. user.name // ✓ 正确

一元运算符前面跟一个空格

  1. typeof!admin // ✗ 错误
  2. typeof!admin // ✓ 正确

注释首尾留空格

  1. //comment // ✗ 错误
  2. // comment // ✓ 正确
  3. /*comment*/// ✗ 错误
  4. /* comment */// ✓ 正确

模板字符串中变量前后不加空格

  1. const message =`Hello, ${ name }`// ✗ 错误
  2. const message =`Hello, ${name}`// ✓ 正确

逗号后面加空格

  1. // ✓ 正确
  2. const list =[1,2,3,4]
  3. function greet (name, options){...}
  1. // ✗ 错误
  2. const list =[1,2,3,4]
  3. function greet (name,options){...}

不允许有连续多行空行

  1. // ✓ 正确
  2. const value ='hello world'
  3. console.log(value)
  1. // ✗ 错误
  2. const value ='hello world'
  3. console.log(value)

单行代码块两边加空格

  1. function foo (){returntrue}// ✗ 错误
  2. function foo (){returntrue}// ✓ 正确
  3. if(condition){returntrue}// ✓ 正确

不要使用非法的空白符

  1. function myFunc ()/*<NBSP>*/{}// ✗ 错误

始终将逗号置于行末

  1. const obj ={
  2. foo:'foo'
  3. ,bar:'bar'// ✗ 错误
  4. }
  5. const obj ={
  6. foo:'foo',
  7. bar:'bar'// ✓ 正确
  8. }

点号操作符须与属性需在同一行

  1. console.log('hello')// ✓ 正确
  2. console.
  3. log('hello')// ✗ 错误
  4. console
  5. .log('hello')// ✓ 正确

文件末尾留一空行

函数调用时标识符与括号间不留间隔

  1. console.log ('hello')// ✗ 错误
  2. console.log('hello')// ✓ 正确

键值对当中冒号与值之间要留空白

  1. const obj ={'key':'value'}// ✗ 错误
  2. const obj ={'key':'value'}// ✗ 错误
  3. const obj ={'key':'value'}// ✗ 错误
  4. const obj ={'key':'value'}// ✓ 正确

变量定义

使用 const/let 定义变量

当前作用域不需要改变的变量使用 const,反之则使用 let

  1. const a ='a'
  2. a ='b'// ✗ 错误,请使用 let 定义
  3. let test ='test'
  4. var noVar ='hello, world'// ✗ 错误,请使用 const/let 定义变量

每个 const/let 关键字单独声明一个变量

  1. // ✓ 正确
  2. const silent =true
  3. let verbose =true
  4. // ✗ 错误
  5. const silent =true, verbose =true
  6. // ✗ 错误
  7. let silent =true,
  8. verbose =true

不要重复声明变量

  1. let name ='John'
  2. let name ='Jane'// ✗ 错误
  3. let name ='John'
  4. name ='Jane'// ✓ 正确

不要使用 undefined 来初始化变量

  1. let name =undefined// ✗ 错误
  2. let name
  3. name ='value'// ✓ 正确

对于变量和函数名统一使用驼峰命名法

  1. function my_function (){}// ✗ 错误
  2. function myFunction (){}// ✓ 正确
  3. const my_var ='hello'// ✗ 错误
  4. const myVar ='hello'// ✓ 正确

不要定义未使用的变量

  1. function myFunction (){
  2. const result = something()// ✗ 错误
  3. }

避免将变量赋值给自己

  1. name = name // ✗ 错误

基本类型

不要省去小数点前面的 0

  1. const discount =.5// ✗ 错误
  2. const discount =0.5// ✓ 正确

字符串拼接操作符 (Infix operators) 之间要留空格

  1. // ✓ 正确
  2. const x =2
  3. const message ='hello, '+ name +'!'
  1. // ✗ 错误
  2. const x=2
  3. const message ='hello, '+name+'!'

不要使用多行字符串

  1. const message ='Hello \
  2. world'// ✗ 错误

检查 NaN 的正确姿势是使用 isNaN()

  1. if(price ===NaN){}// ✗ 错误
  2. if(isNaN(price)){}// ✓ 正确

用合法的字符串跟 typeof 进行比较操作

  1. typeof name ===undefined// ✗ 错误
  2. typeof name ==='undefined'// ✓ 正确

对象与数组

对象中定义了存值器,一定要对应的定义取值器

  1. const person ={
  2. set name (value){// ✗ 错误
  3. this._name = value
  4. }
  5. }
  6. const person ={
  7. set name (value){
  8. this._name = value
  9. },
  10. get name (){// ✓ 正确
  11. returnthis._name
  12. }
  13. }

使用数组字面量而不是构造器

  1. const nums =newArray(1,2,3)// ✗ 错误
  2. const nums =[1,2,3]// ✓ 正确

不要解构空值

  1. const{ a:{}}= foo // ✗ 错误
  2. const{ a:{ b }}= foo // ✓ 正确

对象字面量中不要定义重复的属性

  1. const user ={
  2. name:'Jane Doe',
  3. name:'John Doe'// ✗ 错误
  4. }

不要扩展原生对象

  1. Object.prototype.age =21// ✗ 错误

外部变量不要与对象属性重名

  1. let score =100
  2. function game (){
  3. score:while(true){// ✗ 错误
  4. score -=10
  5. if(score >0)continue score
  6. break
  7. }
  8. }

对象属性换行时注意统一代码风格

  1. const user ={
  2. name:'Jane Doe', age:30,
  3. username:'jdoe86'// ✗ 错误
  4. }
  5. const user ={ name:'Jane Doe', age:30, username:'jdoe86'}// ✓ 正确
  6. const user ={
  7. name:'Jane Doe',
  8. age:30,
  9. username:'jdoe86'
  10. }

避免使用不必要的计算值作对象属性

  1. const user ={['name']:'John Doe'}// ✗ 错误
  2. const user ={ name:'John Doe'}// ✓ 正确

函数

避免使用 arguments.callee 和 arguments.caller

  1. function foo (n){
  2. if(n <=0)return
  3. arguments.callee(n -1)// ✗ 错误
  4. }
  5. function foo (n){
  6. if(n <=0)return
  7. foo(n -1)
  8. }

不要定义冗余的函数参数

  1. function sum (a, b, a){// ✗ 错误
  2. // ...
  3. }
  4. function sum (a, b, c){// ✓ 正确
  5. // ...
  6. }

避免多余的函数上下文绑定

  1. const name =function(){
  2. getName()
  3. }.bind(user)// ✗ 错误
  4. const name =function(){
  5. this.getName()
  6. }.bind(user)// ✓ 正确

不要使用 eval()

  1. eval("var result = user."+ propName )// ✗ 错误
  2. const result = user[propName]// ✓ 正确

不要使用多余的括号包裹函数

  1. const myFunc =(function(){})// ✗ 错误
  2. const myFunc =function(){}// ✓ 正确

避免对声明过的函数重新赋值

  1. function myFunc (){}
  2. myFunc = myOtherFunc // ✗ 错误

注意隐式的 eval()

  1. setTimeout("alert('Hello world')")// ✗ 错误
  2. setTimeout(function(){ alert('Hello world')})// ✓ 正确

嵌套的代码块中禁止再定义函数

  1. if(authenticated){
  2. function setAuthUser (){}// ✗ 错误
  3. }

禁止使用 Function 构造器

  1. const sum =newFunction('a','b','return a + b')// ✗ 错误

禁止使用 Object 构造器

  1. let config =newObject()// ✗ 错误

自调用匿名函数 (IIFEs) 使用括号包裹

  1. const getName =function(){}()// ✗ 错误
  2. const getName =(function(){}())// ✓ 正确
  3. const getName =(function(){})()// ✓ 正确

不使用 Generator 函数语法

使用 Promise 或者 async functions 来实现异步编程

  1. function* helloWorldGenerator(){// ✗ 错误
  2. yield'hello';
  3. yield'world';
  4. return'ending';
  5. }

正则

正则中不要使用控制符

  1. const pattern =/\x1f/// ✗ 错误
  2. const pattern =/\x20/// ✓ 正确

正则中避免使用多个空格

  1. const regexp =/test value/// ✗ 错误
  2. const regexp =/test {3}value/// ✓ 正确
  3. const regexp =/test value/// ✓ 正确

类定义

类名要以大写字母开头

  1. class animal {}
  2. const dog =new animal()// ✗ 错误
  3. classAnimal{}
  4. const dog =newAnimal()// ✓ 正确

避免对类名重新赋值

  1. classDog{}
  2. Dog='Fido'// ✗ 错误

子类的构造器中一定要调用 super

  1. classDog{
  2. constructor (){
  3. super()// ✗ 错误
  4. }
  5. }
  6. classDogextendsMammal{
  7. constructor (){
  8. super()// ✓ 正确
  9. }
  10. }

使用 this 前请确保 super() 已调用

  1. classDogextendsAnimal{
  2. constructor (){
  3. this.legs =4// ✗ 错误
  4. super()
  5. }
  6. }

禁止多余的构造器

  1. classCar{
  2. constructor (){// ✗ 错误
  3. }
  4. }
  5. classCar{
  6. constructor (){// ✗ 错误
  7. super()
  8. }
  9. }

类中不要定义冗余的属性

  1. classDog{
  2. bark (){}
  3. bark (){}// ✗ 错误
  4. }

无参的构造函数调用时要带上括号

  1. functionAnimal(){}
  2. const dog =newAnimal// ✗ 错误
  3. const dog =newAnimal()// ✓ 正确

new 创建对象实例后需要赋值给变量

  1. newCharacter()// ✗ 错误
  2. const character =newCharacter()// ✓ 正确

模块

同一模块有多个导入时一次性写完

  1. import{ myFunc1 }from'module'
  2. import{ myFunc2 }from'module'// ✗ 错误
  3. import{ myFunc1, myFunc2 }from'module'// ✓ 正确

import, export 和解构操作中,禁止赋值到同名变量

  1. import{ config as config }from'./config'// ✗ 错误
  2. import{ config }from'./config'// ✓ 正确

语句

避免在 return 语句中出现赋值语句

  1. function sum (a, b){
  2. return result = a + b // ✗ 错误
  3. }

禁止使用 with

  1. with(val){...}// ✗ 错误

不要使用标签语句

  1. label:
  2. while(true){
  3. break label // ✗ 错误
  4. }

不要随意更改关键字的值

  1. letundefined='value'// ✗ 错误

return,throw,continue 和 break 后不要再跟代码

  1. function doSomething (){
  2. returntrue
  3. console.log('never called')// ✗ 错误
  4. }

逻辑与循环

始终使用 === 替代 ==

例外: obj == null 可以用来检查 null || undefined

  1. if(name ==='John')// ✓ 正确
  2. if(name =='John')// ✗ 错误
  1. if(name !=='John')// ✓ 正确
  2. if(name !='John')// ✗ 错误

避免将变量与自己进行比较操作

  1. if(score === score){}// ✗ 错误

if/else 关键字要与花括号保持在同一行

  1. // ✓ 正确
  2. if(condition){
  3. // ...
  4. }else{
  5. // ...
  6. }
  1. // ✗ 错误
  2. if(condition)
  3. {
  4. // ...
  5. }
  6. else
  7. {
  8. // ...
  9. }

多行 if 语句的的括号不能省略

  1. // ✓ 正确
  2. if(options.quiet !==true) console.log('done')
  1. // ✓ 正确
  2. if(options.quiet !==true){
  3. console.log('done')
  4. }
  1. // ✗ 错误
  2. if(options.quiet !==true)
  3. console.log('done')

对于三元运算符 ? 和 : 与他们所负责的代码处于同一行

  1. // ✓ 正确
  2. const location = env.development ?'localhost':'www.api.com'
  3. // ✓ 正确
  4. const location = env.development
  5. ?'localhost'
  6. :'www.api.com'
  7. // ✗ 错误
  8. const location = env.development ?
  9. 'localhost':
  10. 'www.api.com'

请书写优雅的条件语句(avoid Yoda conditions)

  1. if(42=== age){}// ✗ 错误
  2. if(age ===42){}// ✓ 正确

避免使用常量作为条件表达式的条件(循环语句除外)

  1. if(false){// ✗ 错误
  2. // ...
  3. }
  4. if(x ===0){// ✓ 正确
  5. // ...
  6. }
  7. while(true){// ✓ 正确
  8. // ...
  9. }

循环语句中注意更新循环变量

  1. for(let i =0; i < items.length; j++){...}// ✗ 错误
  2. for(let i =0; i < items.length; i++){...}// ✓ 正确

如果有更好的实现,尽量不要使用三元表达式

  1. let score = val ? val :0// ✗ 错误
  2. let score = val ||0// ✓ 正确

switch 语句中不要定义重复的 case 分支

  1. switch(id){
  2. case1:
  3. // ...
  4. case1:// ✗ 错误
  5. }

switch 一定要使用 break 来将条件分支正常中断

  1. switch(filter){
  2. case1:
  3. doSomething()// ✗ 错误
  4. case2:
  5. doSomethingElse()
  6. }
  7. switch(filter){
  8. case1:
  9. doSomething()
  10. break// ✓ 正确
  11. case2:
  12. doSomethingElse()
  13. }
  14. switch(filter){
  15. case1:
  16. doSomething()
  17. // fallthrough // ✓ 正确
  18. case2:
  19. doSomethingElse()
  20. }

避免不必要的布尔转换

  1. const result =true
  2. if(!!result){// ✗ 错误
  3. // ...
  4. }
  5. const result =true
  6. if(result){// ✓ 正确
  7. // ...
  8. }

避免使用逗号操作符

  1. if(doSomething(),!!test){}// ✗ 错误

错误处理

不要丢掉异常处理中 err 参数

  1. // ✓ 正确
  2. run(function(err){
  3. if(err)throw err
  4. window.alert('done')
  5. })
  1. // ✗ 错误
  2. run(function(err){
  3. window.alert('done')
  4. })

catch 中不要对错误重新赋值

  1. try{
  2. // ...
  3. }catch(e){
  4. e ='new value'// ✗ 错误
  5. }
  6. try{
  7. // ...
  8. }catch(e){
  9. const newVal ='new value'// ✓ 正确
  10. }

用 throw 抛错时,抛出 Error 对象而不是字符串

  1. throw'error'// ✗ 错误
  2. thrownewError('error')// ✓ 正确

finally 代码块中不要再改变程序执行流程

  1. try{
  2. // ...
  3. }catch(e){
  4. // ...
  5. }finally{
  6. return42// ✗ 错误
  7. }

使用 Promise 一定要捕捉错误

  1. asyncTask('google.com').catch(err => console.log(err))// ✓ 正确

组件及 JSX 书写规范

基本书写

组件创建

Taro 中组件以类的形式进行创建,并且单个文件中只能存在单个组件

代码缩进

使用两个空格进行缩进,不要混合使用空格与制表符作为缩进

  1. importTaro,{Component}from'@tarojs/taro'
  2. import{View,Text}from'@tarojs/components'
  3. classMyComponentextendsComponent{
  4. render (){
  5. return(
  6. <View className='test'>// ✓ 正确
  7. <Text>12</Text> //错误
  8. </View>
  9. )
  10. }
  11. }

单引号

JSX 属性均使用单引号

  1. importTaro,{Component}from'@tarojs/taro'
  2. import{View,Input}from'@tarojs/components'
  3. classMyComponentextendsComponent{
  4. render (){
  5. return(
  6. <View className='test'>// ✓ 正确
  7. <Text className="test_text">12</Text> //错误
  8. </View>
  9. )
  10. }
  11. }

对齐方式

多个属性,多行书写,每个属性占用一行,标签结束另起一行

  1. // bad
  2. <Foo superLongParam='bar'
  3. anotherSuperLongParam='baz'/>
  4. // good
  5. <Foo
  6. superLongParam='bar'
  7. anotherSuperLongParam='baz'
  8. />
  9. // 如果组件的属性可以放在一行就保持在当前一行中
  10. <Foo bar='bar'/>
  11. // 多行属性采用缩进
  12. <Foo
  13. superLongParam='bar'
  14. anotherSuperLongParam='baz'
  15. >
  16. <Quux/>
  17. </Foo>

空格使用

终始在自闭合标签前面添加一个空格

  1. // bad
  2. <Foo/>
  3. // very bad
  4. <Foo/>
  5. // bad
  6. <Foo
  7. />
  8. // good
  9. <Foo/>

属性书写

属性名称始终使用驼峰命名法

  1. // bad
  2. <Foo
  3. UserName='hello'
  4. phone_number={12345678}
  5. />
  6. // good
  7. <Foo
  8. userName='hello'
  9. phoneNumber={12345678}
  10. />

JSX 与括号

用括号包裹多行 JSX 标签

  1. // bad
  2. render (){
  3. return<MyComponent className='long body' foo='bar'>
  4. <MyChild/>
  5. </MyComponent>
  6. }
  7. // good
  8. render (){
  9. return(
  10. <MyComponent className='long body' foo='bar'>
  11. <MyChild/>
  12. </MyComponent>
  13. )
  14. }
  15. // good
  16. render (){
  17. const body =<div>hello</div>
  18. return<MyComponent>{body}</MyComponent>
  19. }

标签

当标签没有子元素时,始终使用自闭合标签

  1. // bad
  2. <Foo className='stuff'></Foo>
  3. // good
  4. <Foo className='stuff'/>

如果控件有多行属性,关闭标签要另起一行

  1. // bad
  2. <Foo
  3. bar='bar'
  4. baz='baz'/>
  5. // good
  6. <Foo
  7. bar='bar'
  8. baz='baz'
  9. />

书写顺序

在 Taro 组件中会包含类静态属性、类属性、生命周期等的类成员,其书写顺序最好遵循以下约定(顺序从上至下)

  • static 静态方法
  • constructor
  • componentWillMount
  • componentDidMount
  • componentWillReceiveProps
  • shouldComponentUpdate
  • componentWillUpdate
  • componentDidUpdate
  • componentWillUnmount
  • 点击回调或者事件回调 比如 onClickSubmit() 或者 onChangeDescription()
  • render

通用约束与建议

所有内置组件均需要引入后再使用

  1. importTaro,{Component}from'@tarojs/taro'
  2. import{View}from'@tarojs/components'
  3. classMyComponentextendsComponent{
  4. render (){
  5. return(
  6. <View className='test'>// ✓ 正确
  7. <Text>12</Text> //错误
  8. </View>
  9. )
  10. }
  11. }

推荐使用对象解构的方式来使用 state、props

  1. importTaro,{Component}from'@tarojs/taro'
  2. import{View,Input}from'@tarojs/components'
  3. classMyComponentextendsComponent{
  4. state ={
  5. myTime:12
  6. }
  7. render (){
  8. const{ isEnable }=this.props // ✓ 正确
  9. const{ myTime }=this.state // ✓ 正确
  10. return(
  11. <View className='test'>
  12. {isEnable &&<Text className='test_text'>{myTime}</Text>}
  13. </View>
  14. )
  15. }
  16. }

不要以 class/id/style 作为自定义组件的属性名

  1. <Helloclass='foo'/> // ✗ 错误
  2. <Helloid='foo'/> // ✗ 错误
  3. <Hellostyle='foo'/> // ✗ 错误

不要使用 HTML 标签

<div className='foo'></div>     // ✗ 错误
<span id='foo' /></span>    // ✗ 错误

不要在调用 this.setState 时使用 this.state

由于 this.setState 异步的缘故,这样的做法会导致一些错误,可以通过给 this.setState 传入函数来避免

this.setState({
  value: this.state.value + 1
})   // ✗ 错误


this.setState(prevState => ({ value: prevState.value + 1 }))    // ✓ 正确

map 循环时请给元素加上 key 属性

list.map(item => {
  return (
    <View className='list_item' key={item.id}>{item.name}</View>
  )
})

尽量避免在 componentDidMount 中调用 this.setState

因为在 componentDidMount 中调用 this.setState 会导致触发更新

import Taro, { Component } from '@tarojs/taro'
import { View, Input } from '@tarojs/components'

class MyComponent extends Component {
  state = {
    myTime: 12
  }

  componentDidMount () {
    this.setState({     // ✗ 尽量避免,可以在 componentWillMount 中处理
      name: 1
    })
  }

  render () {
    const { isEnable } = this.props
    const { myTime } = this.state
    return (
      <View className='test'>
        {isEnable && <Text className='test_text'>{myTime}</Text>}
      </View>
    )
  }
}

不要在 componentWillUpdate/componentDidUpdate/render 中调用 this.setState

import Taro, { Component } from '@tarojs/taro'
import { View, Input } from '@tarojs/components'

class MyComponent extends Component {
  state = {
    myTime: 12
  }

  componentWillUpdate () {
    this.setState({     // ✗ 错误
      name: 1
    })
  }

  componentDidUpdate () {
    this.setState({     // ✗ 错误
      name: 1
    })
  }

  render () {
    const { isEnable } = this.props
    const { myTime } = this.state
    this.setState({     // ✗ 错误
      name: 11
    })
    return (
      <View className='test'>
        {isEnable && <Text className='test_text'>{myTime}</Text>}
      </View>
    )
  }
}

不要定义没有用到的 state

import Taro, { Component } from '@tarojs/taro'
import { View, Input } from '@tarojs/components'

class MyComponent extends Component {
  state = {
    myTime: 12,
    noUsed: true   // ✗ 没有用到
  }

  render () {
    const { myTime } = this.state
    return (
      <View className='test'>
        <Text className='test_text'>{myTime}</Text>
      </View>
    )
  }
}

组件最好定义 defaultProps

import Taro, { Component } from '@tarojs/taro'
import { View, Input } from '@tarojs/components'

class MyComponent extends Component {

  static defaultProps = {
    isEnable: true
  }

  state = {
    myTime: 12
  }

  render () {
    const { isEnable } = this.props
    const { myTime } = this.state

    return (
      <View className='test'>
        {isEnable && <Text className='test_text'>{myTime}</Text>}
      </View>
    )
  }
}

render 方法必须有返回值

import Taro, { Component } from '@tarojs/taro'
import { View, Input } from '@tarojs/components'

class MyComponent extends Component {
  state = {
    myTime: 12
  }

  render () {   // ✗ 没有返回值
    const { isEnable } = this.props
    const { myTime } = this.state

    <View className='test'>
      {isEnable && <Text className="test_text">{myTime}</Text>}
    </View>
  }
}

值为 true 的属性可以省略书写值

<Hello personal />
<Hello personal={false} />

JSX 属性或者表达式书写时需要注意空格

属性书写不带空格,如果属性是一个对象,则对象括号旁边需要带上空格

<Hello name={ firstname } />   // ✗ 错误
<Hello name={ firstname} />   // ✗ 错误
<Hello name={firstname } />   // ✗ 错误
<Hello name={{ firstname: 'John', lastname: 'Doe' }} />      // ✓ 正确

事件绑定均以 on 开头

在 Taro 中所有默认事件如 onClickonTouchStart 等等,均以 on 开头

import Taro, { Component } from '@tarojs/taro'
import { View, Input } from '@tarojs/components'

class MyComponent extends Component {
  state = {
    myTime: 12
  }

  clickHandler (e) {
    console.log(e)
  }

  render () {
    const { myTime } = this.state

    return (
      <View className='test' onClick={this.clickHandler}>    // ✓ 正确
        <Text className='test_text'>{myTime}</Text>
      </View>
    )
  }
}

子组件传入函数时属性名需要以 on 开头

import Taro, { Component } from '@tarojs/taro'
import { View, Input } from '@tarojs/components'

import Tab from '../../components/Tab/Tab'

class MyComponent extends Component {
  state = {
    myTime: 12
  }

  clickHandler (e) {
    console.log(e)
  }

  render () {
    const { myTime } = this.state

    return (
      <View className='test'>
        <Tab onChange={this.clickHandler} />    // ✓ 正确
        <Text className='test_text'>{myTime}</Text>
      </View>
    )
  }
}

Taro 自身限制规范

不能使用 Array#map 之外的方法操作 JSX 数组

Taro 在小程序端实际上把 JSX 转换成了字符串模板,而一个原生 JSX 表达式实际上是一个 React/Nerv 元素(react-element)的构造器,因此在原生 JSX 中你可以随意地对一组 React 元素进行操作。但在 Taro 中你只能使用 map 方法,Taro 转换成小程序中 wx:for

以下代码会被 ESLint 提示警告,同时在 Taro(小程序端)也不会有效:

test.push(<View />)

numbers.forEach(number => {
  if (someCase) {
    a = <View />
  }
})

test.shift(<View />)

components.find(component => {
  return component === <View />
})

components.some(component => component.constructor.__proto__ === <View />.constructor)

以下代码不会被警告,也应当在 Taro 任意端中能够运行:

numbers.filter(Boolean).map((number) => {
  const element = <View />
  return <View />
})

解决方案

先处理好需要遍历的数组,然后再用处理好的数组调用 map 方法。

numbers.filter(isOdd).map((number) => <View />)

for (let index = 0; index < array.length; index++) {
  // do you thing with array
}

const element = array.map(item => {
  return <View />
})