chore: update docs of visibleLine

chenquincy · Jun 7, 2024 · 2852fc1 · 2852fc1
1 parent 24d8f5d
commit 2852fc1
Show file tree

Hide file tree

Showing 2 changed files with 6 additions and 1 deletion.
diff --git a/docs/src/start.mdx b/docs/src/start.mdx
@@ -95,11 +95,14 @@ which will lead to compute maxLine error.
 
 ## show n lines when more than m lines
 
+show all content lines if the count of content line small than `maxLine`, or show `visibleLine` line of content.
+
 <Playground>
   <Ellipsis
     text="A high performance and customized ellipsis component for react. Support to custom ellipsis char, ellipsis html, end char filter, reflow callback, ...etc."
     maxLine="2"
     visibleLine="1"
+    reflowOnResize={true}
   />
 </Playground>
 

diff --git a/docs/src/zh/start.mdx b/docs/src/zh/start.mdx
@@ -94,12 +94,14 @@ import Ellipsis from 'react-ellipsis-component';
 
 ## 超过 n 行显示 m 行
 
+内容少于 `maxLine` 行时显示全部内容，超过时显示 ``visibleLine` 行内容
+
 <Playground>
   <Ellipsis
     text="高性能、可自定义的 react 文本缩略组件。支持自定义缩略符、html 自定义缩略符、尾文本过滤、缩略回调等功能。高性能、可自定义的 react 文本缩略组件。支持自定义缩略符、html 自定义缩略符、尾文本过滤、缩略回调等功能。"
     maxLine="2"
     visibleLine="1"
-    ellipsisNode=" ...查看更多"
+    reflowOnResize={true}
   />
 </Playground>