@fawazahmed/react-native-read-more

中文文档
3.0.4发布于 2024/06/12MITTypeScriptCommonJS近 30 天下载 4万

A simple react native library to show large blocks of text in a condensed manner with the ability to collapse and expand.

原始使用文档
文档目录7 节
  1. Installation
  2. Usage
  3. Props
  4. Testing with Jest
  5. Seeing issues or any feedback or feature suggest ?
  6. Troubleshooting
  7. Known issues

NPM Downloads NPM License NPM Version

If it helps, do :star: it, appreciate all the support!

Sponsor my work on lfx crowdfunding or Tidelift.

For any react-native support, reach out on email (allow 24hrs to respond)

[email protected]

react-native-read-more

React native library to show text in a condensed way and expand when needed. Can be used with native or expo on all platforms. Supports TS/JS both. It's a pure JS solution and does not requires any native dependencies.

Example

Installation

npm i @fawazahmed/react-native-read-more --save

or with yarn

yarn add @fawazahmed/react-native-read-more

Usage


import React from 'react';
import {SafeAreaView, StyleSheet, View} from 'react-native';
import ReadMore from '@fawazahmed/react-native-read-more';

const Home = () => {
  return (
    <SafeAreaView style={styles.safe}>
      <View style={styles.root}>
        <ReadMore numberOfLines={3} style={styles.textStyle}>
          {
            "Lorem Ipsum is simply dummy text of the printing and typesetting industry. Lorem Ipsum has been the industry's standard dummy text ever since the 1500s, when an unknown printer took a galley of type and scrambled it to make a type specimen book. It has survived not only five centuries, but also the leap into electronic typesetting, remaining essentially unchanged. It was popularised in the 1960s with the release of Letraset sheets containing Lorem Ipsum passages, and more recently with desktop publishing software like Aldus PageMaker including versions of Lorem Ipsum."
          }
        </ReadMore>
      </View>
    </SafeAreaView>
  );
};

const styles = StyleSheet.create({
  safe: {
    flex: 1,
  },
  root: {
    flex: 1,
    padding: 16,
  },
  textStyle: {
    fontSize: 14,
  },
});

export default Home;

Props

PropTypeRequiredNote
styleobject or arraynotext style
seeMoreTextstringnodefaults to See more
seeMoreStyleobject or arraynotext style for See more text
seeLessTextstringnodefaults to See less
seeLessStyleobject or arraynotext style for See less text
ellipsisstringnodefaults to ...
wrapperStyleobject or arraynostyle for wrapper View
numberOfLinesnumbernodefaults to 3
animateboolnodefaults to true => applies a subtle animation to see more and see less text, not the complete text itself
customTextComponentReact componentnodefaults to Text
expandOnlyboolnodefaults to false => hide see less option similar to a linkedIn post
onExpandfuncnooptional callback executed when expanded
onCollapsefuncnooptional callback executed when collapsed
onReadyfuncnooptional callback executed when see more placement measurements are completed, this function will pass 2 arguments ({ canExpand, expandedLinesCount }), where canExpand is a boolean specifying if text can be expanded and expandedLinesCount is a number indicating the number of lines when text is in expanded state.
collapsedboolnoControl collapsed state programatically see issue
debugboolnoprint debug logs to examine
seeMoreContainerStyleSecondaryobjectnoIncase of text overlap, pass { position: 'relative' } see issue (not recommended)
onSeeMorefuncnowhen a function is passed, will disable the default See More toggling and use the custom callback instead. Useful to do things like open a modal instead of expanding text when See More is pressed.
onSeeLessfuncnowhen a function is passed, will disable the default See Less toggling and use the custom callback instead. Useful to do things like open a modal instead of collapsing text when See Less is pressed.

Any additional props are passed down to underlying Text component.

Usage with HTML

HTML rendering is not part of this package, but can be done easily with the help of any custom html to text library. For sample code, refer to this issue

Run example

git clone https://github.com/fawaz-ahmed/react-native-read-more.git
cd react-native-read-more/example
yarn install # or npm install

# to run on iOS
yarn ios

#to run on android
yarn android

Why another library ?

This module will calculate where to position See more and See less within the same paragraph instead of occupying another line. It is a drop-in replacement for Text component and you can control when to apply the see more functionality by configuring the numberOfLines prop. Moreover, you can also pass your own custom implementation of Text component like ParsedText (sample code) etc.

Testing with Jest

Make sure to add jest.useFakeTimers(); to your test file. See Stackoverflow post and jest timer mocks

Seeing issues or any feedback or feature suggest ?

Create an issue with github.

Troubleshooting

  • If you observe See more shown always in android, pass prop allowFontScaling={false}, refer to this issue
  • If you have any nested components other than Text, refer to this issue

Known issues

Android only if numberOfLines with a value of 1 is passed down as a prop, text in android devices will overlap at the end of line. This is an issue in react-native where text from other lines concatenates into the first one even if we add \n to the first line, where the lines returned from onTextLayout indicates a different response. To overcome this issue, use numberOfLines greater than 1.

版本与发布记录

@fawazahmed/react-native-read-more 共发布 38 个版本,首次发布于 2020/06/19;过去 12 个月发布了 0 个版本。

版本发布日期距今
3.0.4latest2024/06/122 年前
3.0.32023/04/053 年前
3.0.22023/01/133 年前
3.0.12023/01/133 年前
3.0.02022/12/233 年前
2.3.72022/07/044 年前

关于 @fawazahmed/react-native-read-more 的常见问题

@fawazahmed/react-native-read-more 是什么?

A simple react native library to show large blocks of text in a condensed manner with the ability to collapse and expand.

如何安装 @fawazahmed/react-native-read-more?

在项目目录运行 npm install @fawazahmed/react-native-read-more,或使用 pnpm add / yarn add / bun add。它还需要宿主项目提供 peer 依赖:react(*)、react-native(*)。npm 7 及以上与 pnpm 8 及以上默认会自动安装必需的 peer 依赖,Yarn 需要手动安装。

@fawazahmed/react-native-read-more 支持 TypeScript 吗?

支持。包内自带 TypeScript 类型声明(package.json 声明了 types 入口),安装后即可获得类型提示,无需再安装 @types 包。

@fawazahmed/react-native-read-more 支持 ESM 还是 CommonJS?

以 CommonJS 形式发布,可以直接 require();在 ES Module 项目中也可以用 import 引入(Node.js 会把 module.exports 作为默认导出)。

@fawazahmed/react-native-read-more 可以商用吗?

@fawazahmed/react-native-read-more 使用 MIT 许可。宽松许可:允许商业使用、修改和再分发,通常只需在分发时保留原版权与许可声明。以上为概括,不构成法律意见,请以许可原文为准。

@fawazahmed/react-native-read-more 的下载量有多少?

根据 npm 官方下载统计,@fawazahmed/react-native-read-more 在 2026/10/15 – 2026/11/13 这 30 天内被下载 39,647 次,日均约 1,322 次。下载量会把 CI 构建、镜像同步和作为其他包依赖的安装一并计入,适合横向比较热度,不能直接等同于使用人数。

@fawazahmed/react-native-read-more 还在维护吗?

最新版本 3.0.4 发布于 2024/06/12(2 年前);至今共发布 38 个版本,其中过去 12 个月发布了 0 个;首次发布于 2020/06/19。发布频率只是参考信号:功能稳定的工具可能很少需要更新,建议结合源码仓库的 issue 和提交记录判断。