一个 Flutter TextField 小部件,可自动调整大小以完美适应其边界内的内容。它会随着用户输入动态调整文本字段的大小,确保最佳空间使用,避免溢出或过多空白区域。非常适合表单和输入字段,其中布局一致性和响应式设计至关重要。该包支持 Android、iOS、Web、macOS、Windows 和 Linux 等多个平台,适用于跨平台应用。它轻量且可无缝集成到现有的 Flutter 项目中。
适合场景
动态表单输入
响应式文本输入字段
跨平台 UI 一致性
自动调整大小的输入框
减少手动布局调整
主要特点
基于内容的自动调整大小
跨平台兼容性
与 Flutter 的无缝集成
支持所有主要平台
所需配置最少
适合对象
开发响应式表单的开发者
需要自适应输入字段的应用程序
跨平台 Flutter 项目
UI 设计师专注于布局效率
需要最少样板代码的文本字段项目
使用建议
可能需要额外的样式来适应复杂布局
长文本带来的性能影响
超出基本尺寸以外的自定义功能有限
不适合固定大小的输入要求
依赖于父容器的约束
原始 README
以下为关联源码仓库的 README 原文快照,最新内容请访问源码仓库。
Auto Size TextField
✍️ Flutter TextField widget that automatically resizes text field to fit perfectly within its bounds.
📢 Announcement:
🚒 ️️IMPORTANTv2.0.0 and above is for Flutter v3. For Flutter v2 and below, please continue to use v1.0.1
🚒 BREAKINGv2.2.0 Flutter v3.3 support: deprecated ToolbarOptionstoolbarOptions and added support of its replacement ContextMenuBuilder.
Use 2.1.1 instead if your AutoSizeTextField is still dependent on toolbarOptions.
Note: Kudos to @leisim! This work is inspired by his awesome lib Auto Size Text. Please check it out if you want to auto size the Flutter Text widget content.
Show some ❤️ and star the repo to support the project
TODO
[x] Update README.md to show examples of more use cases
Note:AutoSizeTextField needs bounded constraints to resize the text. More info here.
fullwidth (default value: true)
The fullwidth parameter extends the width of TextField to its parent's BoxContraints to occupy full width.
Set to false to let the width TextField determined by the width of the text.
maxLines
The maxLines parameter works like you are used to with the Text widget. If there is no maxLines parameter specified, the AutoSizeTextField only fits the text according to the available width and height.
The AutoSizeTextField starts with TextStyle.fontSize. It measures the resulting text and rescales it to fit within its bonds. You can however set the allowed range of the resulting font size.
With minFontSize you can specify the smallest possible font size. If the text still doesn't fit, it will be handled according to overflow. The default minFontSize is 12.
maxFontSize sets the largest possible font size. This is useful if the TextStyle inherits the font size and you want to constrain it.
The AutoSizeTextField will try each font size, starting with TextStyle.fontSize until the text fits within its bounds. stepGranularity specifies how much the font size is decreased each step. Usually, this value should not be below 1 for best performance.
If you want to allow only specific font sizes, you can set them with presetFontSizes.
If presetFontSizes is set, minFontSize, maxFontSize and stepGranularity will be ignored.
Controls how one widget replaces another widget in the tree.
textKey
Sets the key for the resulting Text widget
style*
If non-null, the style to use for this text
fullwidth
Default: true, It extends the width of TextField to its parent's BoxContraints to occupy full width. Set to false to let the width TextField determined by the width of the text.
minFontSize
The minimum text size constraint to be used when auto-sizing text. Is being ignored if presetFontSizes is set.
maxFontSize
The maximum text size constraint to be used when auto-sizing text. Is being ignored if presetFontSizes is set.
stepGranularity
The step size in which the font size is being adapted to constraints.
presetFontSizes
Predefines all the possible font sizes. Important:presetFontSizes have to be in descending order.
locale*
Used to select a font when the same Unicode character can be rendered differently, depending on the locale.
wrapWords
Whether words which don't fit in one line should be wrapped. Defaults to true to behave like Text.
overflowReplacement
If the text is overflowing and does not fit its bounds, this widget is displayed instead.
maxLines
An optional maximum number of lines for the text to span.
minWidth
An optional min width for input field. Only set it when fullwidth = false
Parameters marked with * behave exactly the same as in TextField.
The unlisted parameters behave exactly the same as TextField.
Performance
AutoSizeTextField is really fast. In fact, you can replace all your TextField widgets with AutoSizeTextField.
Nevertheless you should not use an unreasonable high fontSize in your TextStyle. E.g. don't set the fontSize to 1000 if you know, that the text will never be larger than 30.
If your font size has a very large range, consider increasing stepGranularity.
Troubleshooting
Missing bounds
If AutoSizeTextField overflows or does not resize the text, you should check if it has constrained width and height.
Because Row and other widgets like Container, Column or ListView do not constrain their children, the text will overflow.
You can fix this by constraining the AutoSizeTextField. Wrap it with Expanded in case of Row and Column or use a SizedBox or another widget with fixed width (and height).
Correct code:
Row(
children: <Widget>[
Expanded( // Constrains AutoSizeTextField to the width of the Row
child: AutoSizeTextField(
controller: _textEditingController,
maxLines: 1,
)
),
],
)
}
MinFontSize too large
AutoSizeTextField does not resize text below the minFontSize which defaults to 12.:
MIT License
Copyright (c) 2020Zhuoran LI
Permissionis 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 Softwareis
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.