API Referrer

Props

Prop Name	Type	Default	Description
text	String	Required	Pure text that you want to ellipsis. Support \n to wrap with useJsEllipsis={true}.
maxLine	Number	1	Content will be truncated if the line count of content is bigger than `maxLine`.
maxHeight	Number		Content will be truncated if the height of content is bigger than `maxHeight`. Priority higher than maxLine.
className	String		Add className to component.
ellipsis	Boolean	true	Whether to ellipsis the text content.
ellipsisNode	ReactNode	…	Custom the ellipsis node.
endExcludes	String[]	[]	The characters that want to remove at the end(Before ellipsis char).
dangerouslyUseInnerHTML	Boolean	false	Parse text as html(Make sure the text that you pass is safe, or you may been attacked by XSS).
reflowOnResize	Boolean		Whether update when container resize. Default true if native ellipsis support, otherwise false.
visibleLine	Number	maxLine	Line count of visible content(Can't bigger than maxLine).
visibleHeight	Number		Visible height of content. Priority higher than `visibleLine`.

Event Name	Type	Description
onReflow	(ellipsis: Boolean, text: String) => void	Reflow callback, `ellipsis` is whether the text have been truncated. `text` is the visible content after truncating(Not include ellipsis char).
onEllipsisClick	() => void	Ellipsis click callback.