npm - @nutui/nutui-react - Versions diffs - 2.0.0-beta.0 → 2.0.0-beta.1 - Mend

@nutui/nutui-react 2.0.0-beta.0 → 2.0.0-beta.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (1785) hide show

package/CHANGELOG.md CHANGED Viewed

@@ -1,127 +1,264 @@
-## v1.2.2
-`2022-08-10`
-* :zap: feat: range组件props补齐+国际化 (#201) @vickyYE
-* :zap: feat: signature组件增加单元测试、文档和demo国际化 (#205) @irisSong
-* :zap: test(navbar): navbar unit test (#203) @szg2008
-* :zap: test(tabbar): tabbar unit test (#204) @szg2008
-* :zap: feat: 新增 searchbar 组件 (#186) @Ymm0008
-* :zap: feat(numberkeyboard): new components (#192) @Drjingfubo
-* :zap: feat(tabbar): 组件能力补齐 (#178) @szg2008
-* :zap: feat: progress 组件 (#187) @ailululu
-* :zap: chore: tag 组件 eslint 修复 (#200) @libin0824
-* :zap: feat: datepicker 功能补齐 (#182) @yangxiaolu1993
-* :zap: feat: tag 组件新增 onClick 事件，closeable 支持非受控(#195) @libin0824
-* :zap: feat: divider组件增加单元测试 (#194) @vickyYE
-* :zap: feat: Dialog组件增加在线调试能力,文档多语言支持 (#193) @libin0824
-## v1.2.1
-`2022-08-03`
-* :sparkles: feat: video 视频组件 (#174)
-* :zap: feat: checkbox props 扩展
-* :zap: feat: tabs 能力补齐&单元测试 (#175)
-* :zap: feat(navbar): navbar组件能力补齐 (#177)
-* :zap: feat: input 组件新增 props (#173)
-* :bug: fix: elevator 组件props补全、新增单元测试、demo和文档多语言支持 (#180)
-* :bug: fix: 修改steps点击报错和eslint校验报错 (#179)
-* 📖docs: feat: timeselect 国际化支持
-* 📖docs: feat: vlist 国际化
-* 📖docs: feat: tag 增加在线调试能力
-* 📖docs: feat: badge 增加在线调试能力
-* 📖docs: fix: 修复 video 组件 demo 样式冲突
-* 📖docs: feat: noticebar、notify、range、textarea、toast组件增加在线编辑功能 (#190)
-* 📖docs: feat: price组件文档和demo国际化 (#191)
-* 📖docs: feat: vlist 国际化文档
-* 📖docs: feat: animatingnumbers 增加单元测试、文档和demo国际化支持、主题定制支持 (#189)
-* 📖docs: feat: divider组件增加国际化demo (#176)
-* 📖docs: feat: layout 增加在线调试，变量提取，依赖版本锁定 (#157)
-* 📖docs: chore: 在线调试增加scss支持
-## v1.2.0
-`2022-07-27`
-* :bug: fix: html title 文案修改 & button 组件 readme 格式修改 (#126)
-* :zap: feat: 国际化语言支持 (#124)
-* :zap: feat: add empty & review (#130)
-* :bug: fix: 修复 button 组件 demo 中的错误文案 (#134)
-* :zap: feat: cell 单元测试完成 (#132)
-* :bug: fix: 修复 input 组件添加多语言支持后 placeholder 属性设置不生效的问题
-* :bug: fix: fixednav 样式类名优化
-* :bug: fix: 修改Button在服务端不渲染class和style (#133)
-* :bug: fix: 修复自定义地址组件 (#143)
-* :bug: fix: swiper问题修复 (#140)
-* :bug: fix: 修复address组件三级地址切换回来二级地址不同步的问题 (#144)
-* :bug: fix: dialog 组件多语言后props设置出错
-* :zap: feat: 新增collapse组件的单元测试 (#145)
-* :zap: feat: tag + switch 组件测试用例 (#148)
-* :zap: feat: 新增虚拟列表virtuallist (#136)
-* :zap: feat: indicator 组件 (#158)
-* :bug: fix: textarea placeholder 设置不生效
-* :bug: fix: textarea 组件 change、focus、blur 事件改为 onChange、onFocus、onBlur (#163)
-* :zap: feat: popup在线文档接入和国际化支持 (#167)
-* :zap: feat: navbar在线文档接入和国际化支持 (#171)
-* :zap: feat: tabbar在线文档接入和国际化支持 (#169)
-* :bug: fix: empty空状态组件新增国际化文档新增单元测试 (#164)
-* :zap: feat: calendar在线文档接入和国际化支持 (#168)
-* :zap: feat: indicator指示器组件新增国际化文档 (#166)
-* :zap: feat: 弹框增加onClickSelf事件 (#172)
-* :zap: feat: timeselect (#149)
-* :zap: feat: divider组件新增props (#162)
-## v1.1.4
-`2022-05-23`
-* :zap: feat(upload): upload 组件上传失败时希望可以自定义是否显示图片(#114 ) @junjun666
-* :zap: feat(tabbar): tabbar 组件支持路由跳转,文档更新(#123 ) @allan2coder
-* :zap: feat(circleprogress): circleprogress 组件 strokeInnerWidth 属性重命名为 strokeWidth，移除 isAuto、progressOption 属性(#121 ) @junjun666
-* :zap: feat(avatar): avatar 组件 src 属性重命名为 url，增加 avatargroup 子组件(#121 ) @junjun666
-* :zap: feat(skeleton): skeleton 组件 width、height 属性的类型修改为 string(#121 ) @junjun666
-* :bug: fix(dialog): 修复 swiper 组件在 Next.js 环境下提示 window not defined 问题 @oasis-cloud
-* :bug: fix(backtop): 修复 backtop 组件在 Next.js 环境下提示 document not defined 的问题 @oasis-cloud
-* :zap: feat: NutUI-React 官网增加 issue 入口，以及组件文档更新。
-## v1.1.3
-`2022-04-18`
-* :zap: feat(countdown): 新增 countdown 组件(#107 ) @irisSong
-* :zap: feat(upload): 新增 defaultImg 属性支持(#108 ) @junjun666
-* :bug: fix(dialog): 修复Dialog自定义关闭事件不清除body样式类问题(#111 ) @yangjinjun3
-* :zap: feat: NutUI-React 官网增加 countdown 组件的文档。
-## v1.1.2
-`2022-03-29`
-* :zap: feat(tabs): 新增 card 组件(#105 ) @irisSong
-* :zap: feat: NutUI-React 官网增加 card 组件的文档。
-## v1.1.1
-`2022-03-21`
-* :zap: feat(tabs):  新增 tabs 组件(#99 ) @HaoGeShuoHuaNiHaoHaoTing
-* :zap: feat(datepicker): 新增 datepicker 组件(#102 ) @dushoujun
-* :zap: feat(skeleton): 新增 skeleton 组件(#96 ) @junjun666
-* :zap: feat: NutUI-React 官网增加 tabs、datepicker、skeleton 组件的文档。
-## v1.1.0
-`2022-02-25`
-* :bug: fix(input):  修复边框的处理(#98) @oasis-cloud
-* :bug: fix(overlay): 修复遮罩层在安卓机未显示的问题(#97) @oasis-cloud
-* :zap: feat(address):  支持动态设置city(#90) @yangxiaolu1993
-* :zap: feat(fixednav): 增加文档调试功能,回调函数名称修改 @Ymm0008
-* :zap: feat(popup): 支持className props @szg2008
-* :zap: feat: 发布 NutUI-React 官网。
-## v1.0.0
-`2022-01-10`
-> :tada: :tada: :tada: NutUI-React 1.0 来了！
-* :zap: feat: 第一个公开版本，发布 Layout、BackTop、Collapse、 ActionSheet、 Toast、 Notify、 Steps、 Drag、 Range、 InfiniteLoading、 Dialog、 Popup、 Swiper、 NoticeBar、 CircleProgress、 Button、 Cell、 Icon、 Price、 Avatar、 OverLay、 Divider、 Navbar、 Elevator、 Tabbar、 FixedNav、 InputNumber、 Checkbox、 Radio、 Picker、 Uploader、 Input、 Switch、 Rate、 Calendar、 ShortPassword、 Tag、 Badge、 Pagination、 Popover、 TextArea、 Signature、 Address、 Barrage
-等组件。
-* :zap: feat: 发布 NutUI-React 官网。
+# v2.0.0-beta.1
+`2023-06-21`
+* :bug: fix(collapse): 测试问题修复 (#1132) @Eiinu
+* :bug: fix: address taro 白屏 (#1140) @xiaoyatong
+* :bug: fix: popup title (#1143) @xiaoyatong
+* :bug: fix: remove bem (#1138) @oasis-cloud
+* :bug: fix: 修复toast组件屏幕锁定不能滚动的问题 (#1134) @junjun666
+* :bug: fix: 单元测试问题修复 (#1137) @Eiinu
+* 🛠 refactor: address (#1104) @xiaoyatong
+* 🛠 refactor: calendar (#1087) @xiaoyatong
+* 🔨 chore(ci): delete sync-gitcode.yml @Eiinu
+* 🔨 chore: popover review (#1127) @junjun666
+* 🔨 chore: 更新 taro 版本到 3.6.8 @oasis-cloud
+* 🔨 chore: 移除 @bem-react/classname (#1142) @oasis-cloud
+# v2.0.0-alpha.18
+`2023-06-16`
+* 🔨 chore(tabbar): 调整 Badge 相关 Props (#1126) @Eiinu
+* 📖 docs: update migrate-from-v1.md (#1131) @Eiinu
+* :sparkles: feat: 修改升级文档 (#1125) @oasis-cloud
+* :bug: fix: button 组件在 taro h5 中的类型优化 (#1133) @oasis-cloud
+* :bug: fix: uploader 英文文档修改 (#1124) @oasis-cloud
+* :bug: fix: 修复inputnumber在taro H5样式失效的问题 (#1130) @junjun666
+* :bug: fix: 完善migrate-from-v1文档 (#1129) @songsong
+# v2.0.0-alpha.17
+`2023-06-14`
+* :bug: fix: searchbar shape=round 效果差的问题 (#1109) @xiaoyatong
+* :bug: fix: swipe 类型和文档优化 (#1122) @oasis-cloud
+* 🛠 refactor: form (#1118) @oasis-cloud
+* 📖 docs: 修改布局文档相关 @hanyuxinting
+* 📖 docs: 文档走查及问题修复 (#1123) @xiaoyatong
+* 📖 docs: 文档走查及问题修复-基础&布局组件(#1117) @Eiinu
+* 📖 docs: 文档走查及问题修复-导航组件 (#1119) @xiaoyatong
+# v2.0.0-alpha.16
+`2023-06-09`
+* :bug: fix(toast): 修复连续调用 show 方法时无法销毁的问题 (#1102) @Eiinu
+* :bug: fix: dialog 需要增加 overlay 的样式，否则按需加载样式出现异常 (#1103) @oasis-cloud
+* :bug: fix: menu 组件被使用 transform 的组件嵌套后，遮罩层发生偏移 (#1093) @oasis-cloud
+* :bug: fix: noticebar 修复小程序多行展示问题 (#1107) @xiaoyatong
+* :bug: fix: pikcer 在关闭动画未结束时修改 visible，导致状态更新异常 (#1097) @oasis-cloud
+* 🛠 refactor: datepicker (#1091) @xiaoyatong
+* 🔨 chore: 修复 Taro Demo 的字号 (#1105) @oasis-cloud
+* 🔨 chore(script): 生成 Props 功能增强 (#1096) @Eiinu
+* 📖 docs: 文档修订 (#1106) @xiaoyatong
+# v2.0.0-alpha.15
+`2023-06-07`
+* :sparkles: feat(ci): add codecov (#1092) @Eiinu
+* :sparkles: feat(ci): add lint action (#1098) @Eiinu
+* :sparkles: feat: imagepreview 组件在小程序中支持长按图片保存 (#1090) @oasis-cloud
+* :bug: fix: 单元测试问题修复 (#1095) @Eiinu
+* 🛠 refactor: card (#1069) @拧巴的猫
+* 🛠 refactor: infiniteloading (#1085) @junjun666
+* 🛠 refactor: signature (#1080) @拧巴的猫
+* 🛠 refactor: tag (#1089) @xiaoyatong
+* 🛠 refactor: TimeSelect (#1088) @Eiinu
+# v2.0.0-alpha.14
+`2023-06-02`
+* 🛠 refactor: barrage (#1072) @junjun666
+* 🛠 refactor: popover (#1060) @junjun666
+* 🛠 refactor: sidenavbar (#1057) @oasis-cloud
+* :bug: fix(backtop): 修改 demo (#1083) @Eiinu
+* :bug: fix: ellipsis 在 taro 构建的 H5 中偶现无法暂时省略号的情况 (#1076) @oasis-cloud
+* :bug: fix: input 组件忽略 maxlength 和 password 属性 (#1079) @oasis-cloud
+* :bug: fix: menu 的 closeOnClickOverlay 改为 closeOnOverlayClick (#1084) @oasis-cloud
+* :bug: fix: picker 组件渲染的时候触发 onConfirm (#1082) @oasis-cloud
+* 📖 docs(textarea): 更新文档说明 (#1086) @Eiinu
+* 📖 docs: checkbox demo 增加头部 (#1075) @oasis-cloud
+* 📖 docs: 文档中 css 变量表格的文案优化 (#1077) @oasis-cloud
+# v2.0.0-alpha.13
+`2023-05-31`
+* 🛠 refactor: animatingNumbers (#1048) @拧巴的猫
+* 🛠 refactor: trendArrow (#1066) @拧巴的猫
+* 🛠 refactor: video (#1034) @junjun666
+* 🛠 refactor: watermark (#1071) @Eiinu
+* :sparkles: feat: 构建类型文件中的注释，方便在编辑器中查看属性的说明 (#1068) @oasis-cloud
+* :bug: fix: popup 在 taro 中的动效优化 (#1065) @oasis-cloud
+* :bug: fix: 修改 uploader 和 video 的 taro 文档 (#1070) @junjun666
+* 📖 docs: correct spelling errors (#1058) @konka
+# v2.0.0-alpha.12
+`2023-05-26`
+* 🛠 refactor: actionSheet (#1053) @xiaoyatong
+* 🛠 refactor: countdown (#1040) @拧巴的猫
+* 🛠 refactor: searchBar (#1047) @xiaoyatong
+* 🛠 refactor: shortPassword (#1046) @Eiinu
+* 🛠 refactor: toast (#1026) @justExplore
+* 🛠 refactor: virtualList (#1056) @Eiinu
+* :sparkles: feat: ellipsis add width attribute (#1038) @Zhu Da Shuai
+* :sparkles: feat: 导出主题中的 CSS 变量类型 (#1050) @oasis-cloud
+* 📖 docs: import touch-emulator (#1045) @oasis-cloud
+# v2.0.0-alpha.11
+`2023-05-24`
+* 🛠 refactor: collapse (#1027) @Eiinu
+* 🛠 refactor: Skeleton (#1036) @Eiinu
+* :sparkles: feat: 添加土耳其语 (#1028) @manin
+* :bug: fix(fixednav): 修改 onSelect 参数顺序 (#1035) @Eiinu
+* :bug: fix: 修复taro下拉刷新组件偶发未触发canRelease状态时松手，组件不会自动回弹的问题 (#1029) @Z-Bokle
+* 🔨 chore: 增加同步升级文档到 docs 仓库的脚本 (#1044) @oasis-cloud
+* 🔨 chore: 完善组件导出的类型 (#1039) @oasis-cloud
+* 🔨 chore: 构建每个组件的 css 文件 (#1037) @oasis-cloud
+* 📖 docs: 文档 props 标题统一修复 (#1041) @oasis-cloud
+# v2.0.0-alpha.10
+`2023-05-19`
+* :sparkles: feat(progress): 添加 lazy、delay 属性 (#1023) @Eiinu
+* :bug: fix: swiper loop 模式位置计算错误 (#1018) @oasis-cloud
+* 🛠 refactor: imagepreview (#1019) @xiaoyatong
+* 🛠 refactor: noticebar (#1024) @xiaoyatong
+* 🛠 refactor: steps (#1021) @oasis-cloud
+* 📖 docs: icon 文档修订 (#1022) @oasis-cloud
+# v2.0.0-alpha.9
+`2023-05-17`
+* :sparkles: feat: add create-properties.js (#1001) @Eiinu
+* :sparkles: feat: cascader支持受控 (#1000) @xiaoyatong
+* :sparkles: feat: elevator 支持右侧索引是否展示 (#1006) @拧巴的猫
+* :bug: fix(image): lazy 优化观察对象数量 (#1015) @Eiinu
+* :bug: fix: tabs children 变更后需要展示新的 title (#999) @oasis-cloud
+* :bug: fix: 格式化，删掉某些无用代码 (#1014) @xiaoyatong
+* 🛠 refactor: notify (#983) @拧巴的猫
+* 🛠 refactor: NumberKeyboard (#1012) @Eiinu
+* 🛠 refactor: price (#989) @拧巴的猫
+* 🛠 refactor: pulltorefresh (#1011) @oasis-cloud
+* 🛠 refactor: radio (#1009) @oasis-cloud
+* 🛠 refactor: Range (#991) @Eiinu
+* 🛠 refactor: swiper 重构；indcator 的索引计算改为从 0 开始 (#1008) @oasis-cloud
+* 🔨 chore: autoplay -> autoPlay (#1007) @Eiinu
+* 📖 docs(tabbar): update description (#1004) @Eiinu
+# v2.0.0-alpha.8
+`2023-05-12`
+* :sparkles:feat: cascader支持受控 (#1000) @xiaoyatong
+* :bug: fix: tabs children 变更后需要展示新的 title (#999) @oasis-cloud
+* 🛠 refactor: Range (#991) @Eiinu
+# v2.0.0-alpha.7
+`2023-05-12`
+* :bug: fix: tabs children 变化需要更新选中状态 @oasis-cloud
+# v2.0.0-alpha.6
+`2023-05-12`
+* 🛠 refactor: cascader (#993) @xiaoyatong
+* 🛠 refactor: picker (#975) @xiaoyatong
+* 🛠 refactor: table (#982) @xiaoyatong
+* 🛠 refactor: TextArea (#979) @Eiinu
+* :bug: fix: image src 初始状态未空，导致出发加载失败事件 (#988) @oasis-cloud
+* 📖 docs(progress): demo 代码更新 (#986) @Eiinu
+* 📖 docs(progress): update demo (#987) @Eiinu
+* 📖 docs: tabs 文档中的 titleNode 修改为 title (#995) @oasis-cloud
+* 🔨 chore: taro es 构建移入 vite 配置文件 (#990) @oasis-cloud
+# v2.0.0-alpha.5
+`2023-05-10`
+* 🛠 refactor: checkbox (#974) @oasis-cloud
+* 🛠 refactor: circleprogress-v2.0 (#949) @junjun666
+* 🛠 refactor: ellipsis-v2.0 (#963) @junjun666
+* 🛠 refactor: empty-v2.0 (#977) @junjun666
+* 🛠 refactor: swipe (#958) @justExplore
+* 🛠 refactor:avatar-v2.0 (#970) @junjun666
+* 📖 docs: 增加 icon 的复制功能 (#973) @oasis-cloud
+* :sparkles: feat: cellgroup组件增加单元格之间是否展示分割线props (#961) @拧巴的猫
+* :bug: fix: tabbar 通过 Tabbar.Item 方式使用未加载 item 的样式 (#972) @oasis-cloud
+* :bug: fix: 修复elevator小程序快速滑动后闪动问题 (#984) @拧巴的猫
+# v2.0.0-alpha.4
+`2023-05-05`
+* 🛠 refactor: circleprogress-v2.0 (#949) @junjun666
+* 🛠 refactor: input (#962) @oasis-cloud
+* 🛠 refactor: Tabbar (#935) @Eiinu
+* :bug: fix: badge 组件的默认样式中，去掉 margin-right (#967) @xiaoyatong
+* 🎨 style: fix endLine display error (#964) @HaiTao
+# v2.0.0-alpha.3
+`2023-04-28`
+* :bug: fix: overlay 属性 onClick 暴露、lockscroll 相关demo 修订 (#959) @xiaoyatong
+* :bug: fix: 修改taro增加主题编译 (#950) @junjun666
+* 🛠 refactor: dialog (#945) @xiaoyatong
+* 🛠 refactor: switch (#941) @拧巴的猫
+* 🛠 refactor: tabs (#939) @oasis-cloud
+* 🔨 chore: website 2.0 (#955) @oasis-cloud
+* 📖 docs: button 文档表格优化 (#956) @oasis-cloud
+# v2.0.0-alpha.2
+`2023-04-26`
+* 🛠 refactor: navbar (#890) @拧巴的猫
+* 🛠 refactor: animate (#940) @junjun666
+* 🛠 refactor: badge (#936) @xiaoyatong
+* 🛠 refactor: drag (#937) @拧巴的猫
+* 🛠 refactor: elevator (#927) @拧巴的猫
+* 🛠 refactor: menu (#923) @oasis-cloud
+* 🛠 refactor: progress (#943) @Eiinu
+* 🔨 chore: sync pnpm-lock @oasis-cloud
+* :bug: fix: 修改taro增加主题编译 (#950) @junjun666
+# v2.0.0-alpha.1
+`2023-04-21`
+* 🔨 chore: markdown 中 props、css variables 类型和默认值增加代码标识 @oasis-cloud
+* 🛠 refactor: Audio (#930) @eiinu
+* 🛠 refactor: layout (#934) @oasis-cloud
+* 🛠 refactor: popup 2.0 (#929) @xiaoyatong
+* 🛠 refactor: uploader (#902) @junjun666
+# v2.0.0-alpha.0
+`2023-04-20`
+* 🛠 refactor: backtop (#912) @eiinu
+* 🛠 refactor: button (#904) @oasis-cloud
+* 🛠 refactor: cell (#876) @拧巴的猫
+* 🛠 refactor: divider (#891) @junjun666
+* 🛠 refactor: fixednav (#865) @eiinu
+* 🛠 refactor: grid (#882) @eiinu
+* 🛠 refactor: image (#892) @oasis-cloud
+* 🛠 refactor: indicator (#893) @xiaoyatong
+* 🛠 refactor: inputnumber (#888) @junjun666
+* 🛠 refactor: overlay (#886) @junjun666
+* 🛠 refactor: pagination (#861) @eiinu
+* 🛠 refactor: Rate (#894) @eiinu
+* 🛠 refactor: sticky (#906) @oasis-cloud
+# v1.x
+去 [GitHub](https://github.com/jdf2e/nutui-react/blob/1.x-stable/CHANGELOG.md) 查看 `1.x` 的 Change Log。

package/README.md CHANGED Viewed

@@ -3,129 +3,188 @@
     <img alt="logo" src="https://img11.360buyimg.com/imagetools/jfs/t1/211965/25/7152/22022/61b16785E433119bb/aa41d7a9f7e823f3.png" width="150" style="margin-bottom: 10px;">
 </p>
-<p align="center">京东风格的轻量级移动端 React 组件库</p>
+<p align="center">JD-style mobile UI components based on React that support users to develop H5 and mini-programs.</p>
 <p align="center">
     <a href="http://makeapullrequest.com">
     <img src="https://img.shields.io/badge/PRs-welcome-brightgreen.svg?style=flat-square" alt="PRs Welcome" />
   </a>
+  <a href="https://github.com/jdf2e/nutui-react">
+    <img src="https://img.shields.io/npm/l/@nutui/nutui-react.svg" alt="license"/>
+  </a>
+  <a href="https://www.npmjs.com/package/@nutui/nutui-react">
+    <img src="https://img.shields.io/npm/v/@nutui/nutui-react.svg?style=flat-square">
+  </a>
+  <a href="https://www.npmjs.com/package/@nutui/nutui-react">
+    <img src="https://img.shields.io/npm/dt/@nutui/nutui-react.svg?style=flat-square">
+  </a>
+  <a href="https://github.com/jdf2e/nutui-react">
+    <img src="https://img.shields.io/github/contributors/jdf2e/nutui-react" alt="GitHub contributors">
+  </a>
+  <a href="https://github.com/jdf2e/nutui-react">
+    <img src="https://img.shields.io/github/release-date/jdf2e/nutui-react" alt="GitHub Release Date">
+  </a>
+  <a href="https://github.com/jdf2e/nutui-react">
+    <img src="https://img.shields.io/github/commit-activity/w/jdf2e/nutui-react" alt="GitHub commit activity">
+   </a>
+</p>
+<p align='center'>
+  <img src="https://img12.360buyimg.com/imagetools/jfs/t1/202336/18/18586/7437/61b832ccE0b13d53d/18605da7232a5a0e.png" height="180" alt="NutUI-React" />  &nbsp;
+  <img src="https://img13.360buyimg.com/imagetools/jfs/t1/102323/22/33163/27773/632a7855E75c9fa02/8c351778f47d24f5.jpg" width="200" alt="NutUI-React" />
+</p>
-<a href="https://github.com/jdf2e/nutui">
-<img src="https://img.shields.io/npm/l/@nutui/nutui-react.svg" alt="license"/>
-</a>
-<a href="https://www.npmjs.com/package/@nutui/nutui-react">
-<img src="https://img.shields.io/npm/v/@nutui/nutui-react.svg?style=flat-square">
-</a>
-<a href="https://www.npmjs.com/package/@nutui/nutui-react">
-<img src="https://img.shields.io/npm/dt/@nutui/nutui-react.svg?style=flat-square">
-</a>
+---
-<a href="https://github.com/jdf2e/nutui">
-  <img src="https://img.shields.io/github/contributors/jdf2e/nutui-react" alt="GitHub contributors">
-</a>
-</p>
+> Nut[nʌt]: the one Squirrel Scrat pursues resolutely for a lifetime and will never let go even if it causes a catastrophe from the animated film ***Ice Age***.
+[简体中文](./README_ZH.md) | English
-> Nut[nʌt]，源自电影《冰河世纪》里松鼠 Scrat "执迷不悟"，一生追求，即便引发大灾难也绝不松手的坚果。
----
+## Features
+* 🚀 70+ High Quality Components
+* 📖 Based on JD APP 11.0 Visual Specifications
+* 🍭 Support Tree Shaking
+* 📖 Extensive Documentation and Demos
+* 💪 Written in TypeScript
+* 💪 Support SSR (Experimental)
+* 🍭 Support Custom Themes
+* 🍭 90%+ Unit Test Coverage
+* 📖 Provide Sketch Design Resources
-##  特性
-* 🚀 70+ 高质量组件（React 1.0 持续开发中）,覆盖移动端主流场景
-* 📖 基于京东APP 10.0 视觉规范
-* 🍭 支持按需引用
-* 📖 详尽的文档和示例
-* 💪 支持 TypeScript
-* 💪 支持服务端渲染（测试阶段）
-* 🍭 支持定制主题
-* 🍭 单元测试覆盖（1.0 开发中）,保障稳定性
-* 📖 提供 Sketch 设计资源
-## 示例 H5 & 小程序
+## Running locally
-<p>
-   <img src="https://img12.360buyimg.com/imagetools/jfs/t1/202336/18/18586/7437/61b832ccE0b13d53d/18605da7232a5a0e.png" height="250" alt="NutUI" />
-</p>
+### running with H5
+```sh
+# Clone repository
+git clone https://github.com/jdf2e/nutui-react.git
+# Enter the project dictionary
+cd nutui-react
+# Install dependencies
+npm install
+# Start development
+npm run dev
-## 构建版本
+# visit in browser: http：http://localhost:3000 (you don't have to open it manually if you've run it in the browser again)
+```
+### running with mini-program
+```sh
+# Clone repository
+git clone https://github.com/jdf2e/nutui-react.git
-> AMD 环境、Webpack、Vite 等构建工具环境、服务端建议使用 es 版，非模块化环境（如通过 `<script>` 标签直接引用）建议使用 umd 压缩版。
+# Enter the project dictionary
+cd nutui-react
-* es **nutui.react.es.js**
+# Install dependencies
+npm install
+# Start development
+# dir：src/sites/mobile-taro/dist/weapp
+npm run dev:taro:weapp
+# OR run as jd mini-program
+# dir：src/sites/mobile-taro/dist/jd
+npm run dev:taro:jd
+```
+## Build Versions
+> If you are using AMD environment or build tools such as Webpack, Vite, etc., we recommend using the `es` version. If it is a non-module environment (such as direct reference through the `<script>` tag), it is recommended to use the `umd` compressed version.
+* es **nutui.es.js**
 * umd **nutui.umd.js**
-## 链接
+##  Links
 <ul>
     <li>
         <a href="https://github.com/jdf2e/nutui-react/discussions">
-            Discussions  (用👍投票)
+            Discussions  (vote with 👍)
         </a>
     </li>
     <li>
         <a href="https://github.com/jdf2e/nutui-react/issues?q=is%3Aissue+is%3Aopen+label%3A%22help+wanted%22">
-            Feature Requests (用👍投票)
+            Feature Requests (vote with 👍)
         </a>
     </li>
      <li>
         <a href="https://github.com/jdf2e/nutui-react/labels/bug%203.0">
-            Bugs (用👍投票)
+            Bugs (vote with 👍)
         </a>
     </li>
      <li>
         <a href="https://github.com/jdf2e/nutui-react/issues?q=is%3Aissue+is%3Aopen+label%3Aquestion">
-            Question  (用👍投票)
+            Question  (vote with 👍)
         </a>
     </li>
 </ul>
-[//]: # (## 开发交流)
-[//]: # ()
-[//]: # (| 版本 | 微信群 |内部咚咚群 |)
+## Communication
+| Version | WeChat Group | JD Dongdong Group |
+| --- | --- |--- |
+| [NutUI React](https://github.com/jdf2e/nutui-react/issues) | <img src="https://storage.360buyimg.com/imgtools/17c67beff6-4acf07c0-609c-11ed-a6ef-69df15b605e4.png" width="100" /> Reply 「NutUI-React」 after following | 1025679314 |
+| [NutUI x Taro](https://github.com/jdf2e/nutui/issues) | <img src="https://camo.githubusercontent.com/db4276b4ee4b443158195e943e9e678cb4d2afb7580f70d4d817ef0a90413aec/687474703a2f2f73746f726167652e333630627579696d672e636f6d2f7461726f2d6a642d636f6d2f7374617469632f636f6e746163745f7461726f5f6e757475695f71722e706e67" width="100" />Reply 「NutUI-React」 after following | 1022545110 |
+## Join Us
-[//]: # (| --- | --- |--- |)
+#### NutUI Community
-[//]: # (| [NutUI React]&#40;https://github.com/jdf2e/nutui-react/issues&#41; | 回复「NutUI」 | 1022619199)
+[*Welcome To NutUI-React  Community*](https://github.com/jdf2e/nutui-react/discussions/348)
-[//]: # (| [NutUI Vue]&#40;https://github.com/jdf2e/nutui/issues&#41; | <img src="https://nutui.jd.com/3x/3.1.12/vx-code1.png" width="100" /> 关注后回复「NutUI」 | 82957939)
+#### Contribute to NutUI
-[//]: # (| [NutUI x Taro]&#40;https://github.com/jdf2e/nutui/issues&#41; | <img src="https://camo.githubusercontent.com/db4276b4ee4b443158195e943e9e678cb4d2afb7580f70d4d817ef0a90413aec/687474703a2f2f73746f726167652e333630627579696d672e636f6d2f7461726f2d6a642d636f6d2f7374617469632f636f6e746163745f7461726f5f6e757475695f71722e706e67" width="100" /> 关注后回复「NutUI」 | 1022545110 |)
+There are some choices of contributing to NutUI as follows, solving issues, fixing bugs, adding new components, i18n, UI customization, platform and cross-end adaptation, etc.
-[//]: # ()
+You are very welcome to contribute code to NutUI. Before your pull requests, please read [*NutUI Developer Contributing Guide*](https://github.com/jdf2e/nutui-react/discussions/348)。
-[//]: # (## 贡献者们)
+## Issue & Discussion
-[//]: # ()
-[//]: # (感谢以下小伙伴们为 NutUI 发展做出的贡献：)
+[Report issues to NutUI](https://nutui.jd.com/nutui-issue-helper/?repo=jdf2e/nutui-react&lang=zh-cn)
-[//]: # ()
-[//]: # (<a href="https://github.com/jdf2e/nutui/graphs/contributors">)
+> It is highly recommended to read [*How To Ask Questions The Smart Way*](https://github.com/ryanhanwu/, [*How To Ask Questions Of GitHub Community*](https://github.com/seajs/seajs/issues/545) and [*How to Report Bugs Effectively*](https://www.chiark.greenend.org.uk/~sgtatham/bugs.html), then you can get understanding and help more easily.
-[//]: # (  <img src="https://opencollective.com/nutui/contributors.svg?width=890&button=false" alt="contributors">)
+[NutUI Discussion](https://github.com/jdf2e/nutui-react/discussions)
-[//]: # (</a>)
+If you have any ideas, questions or suggestions, you can share your opinions here.
-## 参与共建
+## Contributors
-非常欢迎社区开发者为 NutUI 贡献代码，在贡献之前请先阅读 [贡献指南](https://nutui.jd.com/#/contributing)，参与共建提 [PR](https://github.com/jdf2e/nutui/pulls)。
+Thanks to all the following [developers](https://github.com/jdf2e/nutui-react/graphs/contributors)。 who have contributed code to NutUI.
-感谢以下所有给 NutUI 贡献过代码的 [开发者](https://github.com/jdf2e/nutui/graphs/contributors)。
-## 开发计划
+<a href="https://github.com/jdf2e/nutui-react/graphs/contributors">
+  <img src="https://contrib.rocks/image?repo=jdf2e/nutui-react" alt="contributors"/>
+</a>
+## Stargazers
+[![Stargazers repo roster for @jdf2e/nutui-react](https://reporoster.com/stars/jdf2e/nutui-react)](https://github.com/jdf2e/nutui-react/stargazers)
+## Forkers
+[![Forkers repo roster for @jdf2e/nutui-react](https://reporoster.com/forks/jdf2e/nutui-react)](https://github.com/jdf2e/nutui-react/network/members)
+## Milestones
 [Milestones](https://github.com/jdf2e/nutui-react/projects)
-## 更新日志
+## Release Notes
+NutUI follows [Angular Style Commit Message Conventions](https://gist.github.com/stephenparish/9941e89d80e2bc58a153). The up-to-date release notes are available on [Release](https://github.com/jdf2e/nutui-react/releases)
-本项目遵从 [Angular Style Commit Message Conventions](https://gist.github.com/stephenparish/9941e89d80e2bc58a153)，更新日志请查阅 [Release](https://github.com/jdf2e/nutui-react/releases)。
-## 开源协议
+## Open Source License
-本项目基于 **MIT** 协议
+This project is based on **MIT** protocol