Skip to content

Commit 3187a67

Browse files
committed
update readme
1 parent 5a354a8 commit 3187a67

File tree

2 files changed

+16
-4
lines changed

2 files changed

+16
-4
lines changed

README.ZH-CN.md

Lines changed: 8 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -22,6 +22,7 @@
2222
- [x-model](#toc-directives-x-model)
2323
- [x-model-hook](#toc-directives-x-model-hook)
2424
- [相关资源](#toc-related-packages)
25+
- [已知问题](#toc-known-issues)
2526
- [更新日志](#toc-changeloog)
2627
- [许可证](#toc-license)
2728

@@ -405,10 +406,15 @@ function Foo() {
405406
## <span id="toc-related-packages">相关资源</span>
406407
- [eslint-plugin-react-directives](https://github.com/peakchen90/eslint-plugin-react-directives)
407408

408-
## <span id="toc-changeloog">更新日志</span>
409409

410+
## <span id="toc-known-issues">已知问题</span>
411+
- 在 Typescript 中使用 `x-for` 时,绑定的值 `item` 会报一个错误。临时的解决方案是,在使用前先声明变量 `item`
412+
例如: `declare let item: any`. **不推荐在 Typescript 中使用 `x-for`**.
413+
414+
415+
## <span id="toc-changeloog">更新日志</span>
410416
查看更多信息: [CHANGELOG](./CHANGELOG.md)
411417

412-
## <span id="toc-license">许可证</span>
413418

419+
## <span id="toc-license">许可证</span>
414420
[MIT](./LICENSE)

README.md

Lines changed: 8 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -23,6 +23,7 @@ A babel plugin that provides some directives for react(any JSX), similar to dire
2323
- [x-model](#toc-directives-x-model)
2424
- [x-model-hook](#toc-directives-x-model-hook)
2525
- [Related Packages](#toc-related-packages)
26+
- [Known Issues](#toc-known-issues)
2627
- [CHANGELOG](#toc-changeloog)
2728
- [LICENSE](#toc-license)
2829

@@ -409,10 +410,15 @@ Please install [**eslint-plugin-react-directives**](https://github.com/peakchen9
409410
## <span id="toc-related-packages">Related Packages</span>
410411
- [eslint-plugin-react-directives](https://github.com/peakchen90/eslint-plugin-react-directives)
411412

412-
## <span id="toc-changeloog">CHANGELOG</span>
413413

414+
## <span id="toc-known-issues">Known Issues</span>
415+
- When using `x-for` in Typescript, the binding value `item` will report an error. The temporary solution is to declare the `item` variable before use.
416+
Such as `declare let item: any`. **And it is not recommended to use `x-for` in Typescript**.
417+
418+
419+
## <span id="toc-changeloog">CHANGELOG</span>
414420
See more information at: [CHANGELOG](./CHANGELOG.md)
415421

416-
## <span id="toc-license">LICENSE</span>
417422

423+
## <span id="toc-license">LICENSE</span>
418424
[MIT](./LICENSE)

0 commit comments

Comments
 (0)