Code Monkey home page Code Monkey logo

taro-docs's Introduction

Taro 文档

.
├── LICENSE
├── README.md
├── blog # 博客
├── docs # 最新版本文档
├── docusaurus.config.js
├── node_modules
├── package.json
├── sidebars.js # 最新版本文档导航
├── src # 文档主题
├── static # 静态文件
├── tsconfig.json
├── versioned_docs # 版本文档
├── versioned_sidebars # 版本文档导航
├── versions.json
└── pnpm-lock.yaml

开发流程

  1. 从最新版本的 master 分支新建一个分支:git checkout -b docs/fix-something
  2. 提交新建的分支发起 Pull Request
  3. 在 Pull Request 页面中如果编译成功,则会自动部署一个预览站点
  4. 预览站点确认修改无误后 Merge 到 master 分支,则会自动部署到 GitHub Pages 和 docs.taro.zone

修改文档

v1 或 v2

修改 versioned_docsversioned_sidebars 对应的文件。

v3

修改 docssidebars.js 对应的文件。

升级文档

v1 或 v2

v1 或 v2 不升级版本,直接修改 versioned_docsversioned_sidebars 对应的文件。

v3

运行命令:pnpm run docusaurus docs:version <semver>

taro-docs's People

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

taro-docs's Issues

taro主包超过2M

这个特性解决了什么问题?

1、分包里面的Component组件也会打到主包的common.js中,有没有办法规避这个问题,比如打到分包中
2、css的BEM规范会导致很多冗余字段,有没有自动压缩样式名字的解决方案呢
在项目里面使用splitChunks + addChunkPages抽离分包会报Please do not register multiple Pages这个错误,抽离node_modules模块是正常工作的,应该是我这个项目的问题,项目文件太多一时半会也不好拆出来,期待有更好的解决方案

这个 API 长什么样?

期待主包降下来的解决方案

跪求 Taro 项目单测范例(含工具函数、组件、hook)

这个特性解决了什么问题?

目前在给 Taro 项目加单测能力的时候遇到了许多问题,工具函数已完成,但组件/hook block住了,不知道是不是测试库啥的选型不对

比如 :(以下是基于 Taro 3.0.11 ,react 模板搭建的项目)
1、hook 测试和 react pc 项目不同:
Taro 项目中的 hook 测试不能用 '@testing-library/react-hooks',因为源码里:
useDidShow 定义是 var useDidShow = taroHooks('componentDidShow')
useDidShow 会执行 taroHooks 方法
taroHook 方法会使用 R.createContext,可这时候 Taro 中的 R 还是初始的空对象,还没经过 createReactApp 赋值为 React 的过程。
2、组件测试 发现 @tarojs/components 为空对象,WebView 为 undefined。
组件测试,import { WebView } from '@tarojs/components' 结果 WebView 打印出来是undefined
image

基本上是遇到了很多问题,但这两个没找到解,所以希望有范例,求“抄作业”,嘤嘤嘤。

这个 API 长什么样?

git clone,yarn && yarn test 能正常跑起来

debugReact 选项在 3.5.12 版本与 React 17 有冲突

相关平台

飞书小程序

复现仓库

[email protected]:Gino2333/FerishuTaroTest.git

使用框架: React

复现步骤

npm run dev:lark
使用飞书小程序开发者工具打开项目报错

[TMA][ERROR][RUNTIME] initApp fail, EngineError: -4026 Error: app service js execute fail: app-service.js load error: TypeError: Cannot read properties of undefined (reading 'isBatchingLegacy'), stack: TypeError: Cannot read properties of undefined (reading 'isBatchingLegacy') at ensureRootIsScheduled (file:///Users/zhanghao/.mpdev-ide/builds/f49d9074c9b0a3868aa302f47680cefd/__dist__/vendors.js:45137:35) at scheduleUpdateOnFiber (file:///Users/zhanghao/.mpdev-ide/builds/f49d9074c9b0a3868aa302f47680cefd/__dist__/vendors.js:44988:5) at Object.updateContainer (file:///Users/zhanghao/.mpdev-ide/builds/f49d9074c9b0a3868aa302f47680cefd/__dist__/vendors.js:48366:14) at Root.render (file:///Users/zhanghao/.mpdev-ide/builds/f49d9074c9b0a3868aa302f47680cefd/__dist__/taro.js:2117:38) at Object.render (file:///Users/zhanghao/.mpdev-ide/builds/f49d9074c9b0a3868aa302f47680cefd/__dist__/taro.js:1859:29) at renderReactRoot (file:///Users/zhanghao/.mpdev-ide/builds/f49d9074c9b0a3868aa302f47680cefd/__dist__/taro.js:490:90) at createReactApp (file:///Users/zhanghao/.mpdev-ide/builds/f49d9074c9b0a3868aa302f47680cefd/__dist__/taro.js:555:21) at ./src/app.jsx (file:///Users/zhanghao/.mpdev-ide/builds/f49d9074c9b0a3868aa302f47680cefd/__dist__/app.js:12073:134) at __webpack_require__ (file:///Users/zhanghao/.mpdev-ide/builds/f49d9074c9b0a3868aa302f47680cefd/__dist__/runtime.js:71:36) at checkDeferredModules (file:///Users/zhanghao/.mpdev-ide/builds/f49d9074c9b0a3868aa302f47680cefd/__dist__/runtime.js:43:35)

期望结果

小程序正常运行

实际结果

小程序无法启动

环境信息

👽 Taro v3.5.12


  Taro CLI 3.5.12 environment info:
    System:
      OS: macOS 10.15.7
      Shell: 5.7.1 - /bin/zsh
    Binaries:
      Node: 14.19.2 - ~/.nvm/versions/node/v14.19.2/bin/node
      Yarn: 1.22.19 - ~/.nvm/versions/node/v14.19.2/bin/yarn
      npm: 9.1.3 - ~/.nvm/versions/node/v14.19.2/bin/npm
    npmPackages:
      @tarojs/cli: 3.5.12 => 3.5.12 
      @tarojs/components: 3.5.12 => 3.5.12 
      @tarojs/helper: 3.5.12 => 3.5.12 
      @tarojs/plugin-framework-react: 3.5.12 => 3.5.12 
      @tarojs/plugin-platform-alipay: 3.5.12 => 3.5.12 
      @tarojs/plugin-platform-jd: 3.5.12 => 3.5.12 
      @tarojs/plugin-platform-qq: 3.5.12 => 3.5.12 
      @tarojs/plugin-platform-swan: 3.5.12 => 3.5.12 
      @tarojs/plugin-platform-tt: 3.5.12 => 3.5.12 
      @tarojs/plugin-platform-weapp: 3.5.12 => 3.5.12 
      @tarojs/react: 3.5.12 => 3.5.12 
      @tarojs/router: 3.5.12 => 3.5.12 
      @tarojs/runtime: 3.5.12 => 3.5.12 
      @tarojs/shared: 3.5.12 => 3.5.12 
      @tarojs/taro: 3.5.12 => 3.5.12 
      @tarojs/taro-h5: 3.5.12 => 3.5.12 
      @tarojs/webpack5-runner: 3.5.12 => 3.5.12 
      babel-preset-taro: 3.5.12 => 3.5.12 
      eslint-config-taro: 3.5.12 => 3.5.12 
      react: ^17.0.0 => 17.0.2 

Button文档中ButtonProps表格太高太宽,左右滚动条在底部不方便查看

问题描述

https://taro-docs.jd.com/taro/docs/components/forms/button
Button文档中ButtonProps表格太高太宽,左右滚动条在底部不方便查看
Button文档只是举例,同样样式的话,遇到其他宽高超出的都会有这个问题

复现步骤

  1. 打开:https://taro-docs.jd.com/taro/docs/components/forms/button
  2. ButtonProps部分的表格太宽,右边看不到
  3. 左右滚动条在底部,又由于表格太高基本超出一屏范围,拉到底部向右滚动后再拉到顶部才能看右侧内容,这时候左侧又对应不上了
/**
 * 这段注释后可以贴代码
 * 提供完整可复现的代码和整理好代码格式,有助于我们快速定位问题,节省你我时间
 * 代码提供不全或代码格式混乱的 issues 【有可能会被忽略】
 * 
 * 查看如何插入代码:https://coding.net/help/doc/project/markdown.html#i-5
 */

期望行为

可以方便的查看表格左右两边的内容,比如将最左边一列固定,或者左右滚动条可以固定在浏览器底部,而不是表格底部

报错信息

系统信息

补充信息

如果您有功能上的建议,可以提到 FeatHub

使用上的问题,欢迎在「Taro 社区」一起交流

官网 物料市场 链接异常

相关平台

H5

浏览器版本: Chrome
使用框架: React

复现步骤

none

期望结果

打开 物料市场

实际结果

进入京东网站

环境信息

👽 Taro v3.6.11


  Taro CLI 3.6.11 environment info:
    System:
      OS: macOS 13.3.1
      Shell: 5.9 - /bin/zsh
    Binaries:
      Node: 18.9.0 - /usr/local/bin/node
      Yarn: 1.22.19 - /usr/local/bin/yarn
      npm: 8.19.1 - /usr/local/bin/npm
    npmPackages:
      @tarojs/components: 3.4.13 => 3.4.13
      @tarojs/mini-runner: 3.4.13 => 3.4.13
      @tarojs/plugin-framework-react: 3.4.13 => 3.4.13
      @tarojs/plugin-html: ^3.4.13 => 3.4.13
      @tarojs/react: 3.4.13 => 3.4.13
      @tarojs/runtime: 3.4.13 => 3.4.13
      @tarojs/taro: 3.4.13 => 3.4.13
      @tarojs/webpack-runner: 3.4.13 => 3.4.13
      babel-preset-taro: 3.4.13 => 3.4.13
      eslint-config-taro: 3.4.13 => 3.4.13
      react: ^17.0.0 => 17.0.2

文档链接404 bug

image

从taro官网进去的文档链接是
https://taro-docs.jd.com
自动跳转到
https://taro-docs.jd.com/docs

手动输入这个链接,也可以跳到文档
https://docs.taro.zone
自动跳转到
https://docs.taro.zone/docs

此时的①②③④的基础教程的链接均指向根目录
https://taro-docs.jd.com/react-overall
https://docs.taro.zone/react-overall

手动输入②,基础教程的链接仍然指向根目录
https://taro-docs.jd.com/react-overall

手动输入④,基础教程的链接指向正确的子目录
image
https://docs.taro.zone/docs/react-overall
但是左键点击的时候,还是跳转到根目录
image
https://docs.taro.zone/react-overall
中键点击,打开新tab的时候,跳转到正确的子目录
https://docs.taro.zone/docs/react-overall

Taro 3.6.* 无法启动storybook

相关平台

微信小程序

小程序基础库: 与该问题无关
使用框架: React

复现步骤

Taro自己官方文档:https://taro-docs.jd.com/docs/external-libraries#storybook
压根起不来,看了下node_modules里'@tarojs/taro-h5/dist/taroApis'这个文件已经没有了。。。

期望结果

可以启动storybook

实际结果

error

环境信息

👽 Taro v3.6.18


  Taro CLI 3.6.18 environment info:
    System:
      OS: macOS 14.1.1
      Shell: 5.9 - /bin/zsh
    Binaries:
      Node: 18.18.1 - ~/.nvm/versions/node/v18.18.1/bin/node
      Yarn: 1.22.19 - ~/.nvm/versions/node/v16.13.2/bin/yarn
      npm: 9.8.1 - ~/.nvm/versions/node/v18.18.1/bin/npm
    npmPackages:
      @tarojs/cli: 3.6.20 => 3.6.20
      @tarojs/components: 3.6.20 => 3.6.20
      @tarojs/mini-runner: 3.6.20 => 3.6.20
      @tarojs/plugin-framework-react: 3.6.20 => 3.6.20
      @tarojs/plugin-platform-h5: 3.6.20 => 3.6.20
      @tarojs/plugin-platform-weapp: 3.6.20 => 3.6.20
      @tarojs/react: 3.6.20 => 3.6.20
      @tarojs/runtime: 3.6.20 => 3.6.20
      @tarojs/taro: 3.6.20 => 3.6.20
      @tarojs/webpack-runner: 3.6.20 => 3.6.20
      @tarojs/webpack5-runner: ^3.6.19 => 3.6.19
      babel-plugin-transform-taroapi: ^3.6.20 => 3.6.20
      babel-preset-taro: 3.6.20 => 3.6.20
      eslint-config-taro: 3.6.20 => 3.6.20
      react: ^17.0.0 => 17.0.2

API表格布局真的是太糟心了

image

使用键盘和鼠标的噩梦,想看后面的说明还得滑到表格最后一行,鼠标左右拖动好再回来,再回来的时候又忘了左边对应的是啥!
左边留的空隙太大,右边留的大还不能调节。
希望官方能优化下。nutui的组件文档就非常不错

缺少支付宝小程序自定义tabbar的相关文档

这个特性解决了什么问题?

3.6.6以上虽然说描述支持了支付宝自定义小程序,
1、但是代码描述类似相关的实现没有文档,不知道如何去配置或者修改。
2、使用支付宝小程序编译时报错
error[Resolve]: cannot resolve module '****/dist/customize-tab-bar/index.axml?'
打包出来的产物并没有customize-tab-bar这个目录只有一个custom-tab-bar目录

这个 API 长什么样?

类似微信小程序自定义tabbar的文档

能否出一个文档的 changelog?

如题,有时重新翻文档时突然发现某些地方更新了。

相比版本更新的很多内部优化,但凡文档更新大都是需要开发者关注的。
当某天重看文档时,面对一篇几千内容的文档,一段重要内容的一行文案变更,或者某个大类的角落摸摸增加了一小段子类目,实在难以查别

渐进式入门教程能否用hook重写

这个特性解决了什么问题?

目前taro最新版本已经迭代至3.6 但是文档版本还是3.0 能否对上手文档重写

这个 API 长什么样?

希望上手示例有hook版本

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.