Flutter文本溢出处理插件ellipsis_overflow_text的使用

ellipsis_overflow_text

Flutter小部件，自动设置在具有省略号溢出类型的文本上要显示的行数。

请给项目点个星星以支持！

受AutoSizeText包启发并基于该包。

资源：

• 文档
• Pub包
• GitHub仓库

目录

• 用法
• 参数
• 性能
• 故障排除
• 许可证

用法

常规用法

EllipsisOverflowText的行为与Text完全相同。唯一的不同在于它会自动设置文本上要显示的行数，并采用省略号溢出类型。

EllipsisOverflowText(
  'Some text here',
  style: TextStyle(fontSize: 22),
)

在换行溢出时显示省略号

若要在最后一行文本结束时显示省略号溢出，可以将showEllipsisOnBreakLineOverflow属性设置为true。

默认行为：

EllipsisOverflowText(
  'First String here\n'
  'This String will fit the given bounds.',
  style: TextStyle(fontSize: 22),
)

设置showEllipsisOnBreakLineOverflow为true时：

EllipsisOverflowText(
  'First String here\n'
  'This String will fit the given bounds.',
  showEllipsisOnBreakLineOverflow: true,
),

参数

带*标记的参数与Text中的行为完全相同。

性能

EllipsisOverflowText非常快。实际上，你可以将所有的Text小部件替换为EllipsisOverflowText。

故障排除

缺少约束

如果EllipsisOverflowText溢出或没有用省略号替换文本，你应该检查它是否有宽度和高度的约束。

错误代码：

Row(
  children: [
    EllipsisOverflowText(
      'Here is a very long text, which will use ellipsis in case the text overflows',
    ),
  ],
)

由于Row和其他像Container、Column或ListView这样的小部件不会约束它们的子组件，因此文本将会溢出。你可以通过约束EllipsisOverflowText来解决这个问题。如果是Row和Column，可以用Expanded包裹；也可以使用SizedBox或其他具有固定宽度（和高度）的小部件。

正确代码：

Row(
  children: [
    Expanded( // 约束EllipsisOverflowText到Row的宽度（你也可以使用Flexible）
      child: EllipsisOverflowText(
        'Here is a very long text, which will use ellipsis in case the text overflows',
      )
    ),
  ],
)

进一步的解释可以在这里找到，问题关于AutoSizeText包，但答案同样适用于本包。如果你仍然有问题，请在这里打开一个问题。

MIT 许可证

Copyright (c) 2022 Vitor Lucas (Reiko-Dev)

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the 'Software'), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.

示例代码

以下是一个完整的示例代码，展示了如何使用EllipsisOverflowText。

import 'package:ellipsis_overflow_text/ellipsis_overflow_text.dart';
import 'package:flutter/material.dart';

void main() {
  runApp(const App());
}

class App extends StatelessWidget {
  const App({Key? key}) : super(key: key);

  [@override](/user/override)
  Widget build(BuildContext context) {
    return const MaterialApp(
      home: HomePage(),
    );
  }
}

class HomePage extends StatelessWidget {
  const HomePage({Key? key}) : super(key: key);

  [@override](/user/override)
  Widget build(BuildContext context) {
    final size = MediaQuery.of(context).size;
    return Scaffold(
      backgroundColor: Colors.black,
      body: Center(
        child: Container(
          width: size.width * .3,
          height: size.height * .25,
          color: Colors.white,
          child: const EllipsisOverflowText(
            'This string will automatically fit within the bounds of the container.',
            style: TextStyle(color: Colors.white),
          ),
        ),
      ),
    );
  }
}