Skip to content

Fixes: Replace hardcoded maxlines to parameter #26

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
manandharsudhir wants to merge 4 commits into
base: main
Choose a base branch
from
Open

Fixes: Replace hardcoded maxlines to parameter #26

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
e12c627
maxlines in parameter
manandharsudhir Jan 22, 2025
223512d
maxlines in parameter
manandharsudhir Jan 22, 2025
9719211
maxlines in parameter
manandharsudhir Jan 22, 2025
b982e2a
adds: functionality to pass padding
manandharsudhir Feb 5, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,3 +1,7 @@
## 0.5.1
* fix: Added maxlines on parameters replacing hardcoded maxline


Comment on lines +1 to +4
Copy link
Copy Markdown
Owner

@bdlukaa bdlukaa Feb 11, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
## 0.5.1
* fix: Added maxlines on parameters replacing hardcoded maxline
## 0.5.1
* fix: Added maxlines on parameters replacing hardcoded maxline

## 0.5.0

* fix: Update vertical alignment ([#19](https://github.com/bdlukaa/rounded_background_text/issues/19))
Expand Down
72 changes: 48 additions & 24 deletions example/pubspec.lock
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -37,10 +37,10 @@ packages:
dependency: transitive
description:
name: collection
sha256: ee67cb0715911d28db6bf4af1026078bd6f0128b07a5f66fb2ed94ec6783c09a
sha256: a1ace0a119f20aabc852d165077c036cd864315bd99b7eaa10a60100341941bf
url: "https://pub.dev"
source: hosted
version: "1.18.0"
version: "1.19.0"
fake_async:
dependency: transitive
description:
Expand All @@ -67,6 +67,30 @@ packages:
description: flutter
source: sdk
version: "0.0.0"
leak_tracker:
dependency: transitive
description:
name: leak_tracker
sha256: "7bb2830ebd849694d1ec25bf1f44582d6ac531a57a365a803a6034ff751d2d06"
url: "https://pub.dev"
source: hosted
version: "10.0.7"
leak_tracker_flutter_testing:
dependency: transitive
description:
name: leak_tracker_flutter_testing
sha256: "9491a714cca3667b60b5c420da8217e6de0d1ba7a5ec322fab01758f6998f379"
url: "https://pub.dev"
source: hosted
version: "3.0.8"
leak_tracker_testing:
dependency: transitive
description:
name: leak_tracker_testing
sha256: "6ba465d5d76e67ddf503e1161d1f4a6bc42306f9d66ca1e8f079a47290fb06d3"
url: "https://pub.dev"
source: hosted
version: "3.0.1"
lints:
dependency: transitive
description:
Expand All @@ -79,46 +103,46 @@ packages:
dependency: transitive
description:
name: matcher
sha256: "1803e76e6653768d64ed8ff2e1e67bea3ad4b923eb5c56a295c3e634bad5960e"
sha256: d2323aa2060500f906aa31a895b4030b6da3ebdcc5619d14ce1aada65cd161cb
url: "https://pub.dev"
source: hosted
version: "0.12.16"
version: "0.12.16+1"
material_color_utilities:
dependency: transitive
description:
name: material_color_utilities
sha256: "9528f2f296073ff54cb9fee677df673ace1218163c3bc7628093e7eed5203d41"
sha256: f7142bb1154231d7ea5f96bc7bde4bda2a0945d2806bb11670e30b850d56bdec
url: "https://pub.dev"
source: hosted
version: "0.5.0"
version: "0.11.1"
meta:
dependency: transitive
description:
name: meta
sha256: a6e590c838b18133bb482a2745ad77c5bb7715fb0451209e1a7567d416678b8e
sha256: bdb68674043280c3428e9ec998512fb681678676b3c54e773629ffe74419f8c7
url: "https://pub.dev"
source: hosted
version: "1.10.0"
version: "1.15.0"
path:
dependency: transitive
description:
name: path
sha256: "8829d8a55c13fc0e37127c29fedf290c102f4e40ae94ada574091fe0ff96c917"
sha256: "087ce49c3f0dc39180befefc60fdb4acd8f8620e5682fe2476afd0b3688bb4af"
url: "https://pub.dev"
source: hosted
version: "1.8.3"
version: "1.9.0"
rounded_background_text:
dependency: "direct main"
description:
path: ".."
relative: true
source: path
version: "0.4.3"
version: "0.5.1"
sky_engine:
dependency: transitive
description: flutter
source: sdk
version: "0.0.99"
version: "0.0.0"
source_span:
dependency: transitive
description:
Expand All @@ -131,10 +155,10 @@ packages:
dependency: transitive
description:
name: stack_trace
sha256: "73713990125a6d93122541237550ee3352a2d84baad52d375a4cad2eb9b7ce0b"
sha256: "9f47fd3630d76be3ab26f0ee06d213679aa425996925ff3feffdec504931c377"
url: "https://pub.dev"
source: hosted
version: "1.11.1"
version: "1.12.0"
stream_channel:
dependency: transitive
description:
Expand All @@ -147,10 +171,10 @@ packages:
dependency: transitive
description:
name: string_scanner
sha256: "556692adab6cfa87322a115640c11f13cb77b3f076ddcc5d6ae3c20242bedcde"
sha256: "688af5ed3402a4bde5b3a6c15fd768dbf2621a614950b17f04626c431ab3c4c3"
url: "https://pub.dev"
source: hosted
version: "1.2.0"
version: "1.3.0"
term_glyph:
dependency: transitive
description:
Expand All @@ -163,10 +187,10 @@ packages:
dependency: transitive
description:
name: test_api
sha256: "5c2f730018264d276c20e4f1503fd1308dfbbae39ec8ee63c5236311ac06954b"
sha256: "664d3a9a64782fcdeb83ce9c6b39e78fd2971d4e37827b9b06c3aa1edc5e760c"
url: "https://pub.dev"
source: hosted
version: "0.6.1"
version: "0.7.3"
vector_math:
dependency: transitive
description:
Expand All @@ -175,14 +199,14 @@ packages:
url: "https://pub.dev"
source: hosted
version: "2.1.4"
web:
vm_service:
dependency: transitive
description:
name: web
sha256: afe077240a270dcfd2aafe77602b4113645af95d0ad31128cc02bce5ac5d5152
name: vm_service
sha256: f6be3ed8bd01289b34d679c2b62226f63c0e69f9fd2e50a6b3c1c729a961041b
url: "https://pub.dev"
source: hosted
version: "0.3.0"
version: "14.3.0"
sdks:
dart: ">=3.2.0-194.0.dev <4.0.0"
flutter: ">=1.17.0"
dart: ">=3.4.0 <4.0.0"
flutter: ">=3.18.0-18.0.pre.54"
99 changes: 72 additions & 27 deletions lib/src/rounded_background_text.dart
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -42,6 +42,9 @@ class RoundedBackgroundText extends StatelessWidget {
this.textHeightBehavior,
this.innerRadius = kDefaultInnerRadius,
this.outerRadius = kDefaultOuterRadius,
this.firstLinePadding,
this.innerLinePadding,
this.lastLinePadding,
}) : text = TextSpan(text: text, style: style);

/// Creates a rounded background text based on an [InlineSpan], that can have
Expand All @@ -61,9 +64,16 @@ class RoundedBackgroundText extends StatelessWidget {
this.textHeightBehavior,
this.innerRadius = kDefaultInnerRadius,
this.outerRadius = kDefaultOuterRadius,
this.firstLinePadding,
this.innerLinePadding,
this.lastLinePadding,
}) : assert(innerRadius >= 0.0 && innerRadius <= 20.0),
assert(outerRadius >= 0.0 && outerRadius <= 20.0);

final EdgeInsets? firstLinePadding;
final EdgeInsets? innerLinePadding;
final EdgeInsets? lastLinePadding;

/// Creates a selectable [RoundedBackgroundText]
///
/// See also:
Expand Down Expand Up @@ -286,11 +296,13 @@ class RoundedBackgroundText extends StatelessWidget {
painter.height.clamp(0, constraints.maxHeight),
),
painter: RoundedBackgroundTextPainter(
backgroundColor: backgroundColor ?? Colors.transparent,
text: painter,
innerRadius: innerRadius,
outerRadius: outerRadius,
),
backgroundColor: backgroundColor ?? Colors.transparent,
text: painter,
innerRadius: innerRadius,
outerRadius: outerRadius,
firstLinePadding: firstLinePadding,
innerLinePadding: innerLinePadding,
lastLinePadding: lastLinePadding),
Comment on lines +299 to +305
Copy link
Copy Markdown
Owner

@bdlukaa bdlukaa Feb 11, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
backgroundColor: backgroundColor ?? Colors.transparent,
text: painter,
innerRadius: innerRadius,
outerRadius: outerRadius,
firstLinePadding: firstLinePadding,
innerLinePadding: innerLinePadding,
lastLinePadding: lastLinePadding),
backgroundColor: backgroundColor ?? Colors.transparent,
text: painter,
innerRadius: innerRadius,
outerRadius: outerRadius,
firstLinePadding: firstLinePadding,
innerLinePadding: innerLinePadding,
lastLinePadding: lastLinePadding
),

);
});
}
Expand All @@ -302,12 +314,18 @@ class RoundedBackgroundTextPainter extends CustomPainter {

final double innerRadius;
final double outerRadius;
final EdgeInsets? firstLinePadding;
final EdgeInsets? innerLinePadding;
final EdgeInsets? lastLinePadding;

const RoundedBackgroundTextPainter({
required this.backgroundColor,
required this.text,
required this.innerRadius,
required this.outerRadius,
this.firstLinePadding,
this.innerLinePadding,
this.lastLinePadding,
});

@visibleForTesting
Expand All @@ -322,11 +340,22 @@ class RoundedBackgroundTextPainter extends CustomPainter {
/// painter.layout();
/// final lines = RoundedBackgroundTextPainter.computeLines(painter);
/// ```
static List<List<LineMetricsHelper>> computeLines(TextPainter painter) {
static List<List<LineMetricsHelper>> computeLines(
TextPainter painter, {
EdgeInsets? firstLinePadding,
EdgeInsets? innerLinePadding,
EdgeInsets? lastLinePadding,
}) {
final metrics = painter.computeLineMetrics();

final helpers = metrics.map((lineMetric) {
return LineMetricsHelper(lineMetric, metrics.length);
return LineMetricsHelper(
lineMetric,
metrics.length,
firstLinePadding: firstLinePadding,
innerLinePadding: innerLinePadding,
lastLinePadding: lastLinePadding,
);
});

final List<List<LineMetricsHelper>> lineInfos = [[]];
Expand All @@ -344,7 +373,10 @@ class RoundedBackgroundTextPainter extends CustomPainter {

@override
void paint(Canvas canvas, Size size) {
final lineInfos = computeLines(text);
final lineInfos = computeLines(text,
firstLinePadding: firstLinePadding,
innerLinePadding: innerLinePadding,
lastLinePadding: lastLinePadding);
Comment on lines +376 to +379
Copy link
Copy Markdown
Owner

@bdlukaa bdlukaa Feb 11, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Improve formatting:

Suggested change
final lineInfos = computeLines(text,
firstLinePadding: firstLinePadding,
innerLinePadding: innerLinePadding,
lastLinePadding: lastLinePadding);
final lineInfos = computeLines(text,
firstLinePadding: firstLinePadding,
innerLinePadding: innerLinePadding,
lastLinePadding: lastLinePadding,
);


for (final lineInfo in lineInfos) {
paintBackground(canvas, lineInfo);
Expand Down Expand Up @@ -642,7 +674,13 @@ class LineMetricsHelper {
double? _overridenX;

/// Creates a new line metrics helper
LineMetricsHelper(this.metrics, this.length);
LineMetricsHelper(
this.metrics,
this.length, {
this.firstLinePadding,
this.innerLinePadding,
this.lastLinePadding,
});

/// Whether this line has no content
bool get isEmpty => rawWidth == 0.0;
Expand All @@ -653,25 +691,32 @@ class LineMetricsHelper {
/// Whether this line is the last line in the paragraph
bool get isLast => metrics.lineNumber == length - 1;

final EdgeInsets? firstLinePadding;
final EdgeInsets? innerLinePadding;
final EdgeInsets? lastLinePadding;

static const _horizontalPaddingFactor = 0.3;
late final EdgeInsets _firstLinePadding = EdgeInsets.only(
left: height * _horizontalPaddingFactor,
right: height * _horizontalPaddingFactor,
top: height * 0.3,
bottom: height * 0.175 / 2,
);
late final EdgeInsets _innerLinePadding = EdgeInsets.only(
left: height * _horizontalPaddingFactor,
right: height * _horizontalPaddingFactor,
top: 0.0,
bottom: height * 0.175 / 2,
);
late final EdgeInsets _lastLinePadding = EdgeInsets.only(
left: height * _horizontalPaddingFactor,
right: height * _horizontalPaddingFactor,
top: 0.0,
bottom: height * 0.175 / 2,
);
late final EdgeInsets _firstLinePadding = firstLinePadding ??
EdgeInsets.only(
left: height * _horizontalPaddingFactor,
right: height * _horizontalPaddingFactor,
top: height * 0.3,
bottom: height * 0.175 / 2,
);
late final EdgeInsets _innerLinePadding = innerLinePadding ??
EdgeInsets.only(
left: height * _horizontalPaddingFactor,
right: height * _horizontalPaddingFactor,
top: 0.0,
bottom: height * 0.175 / 2,
);
late final EdgeInsets _lastLinePadding = lastLinePadding ??
EdgeInsets.only(
left: height * _horizontalPaddingFactor,
right: height * _horizontalPaddingFactor,
top: 0.0,
bottom: height * 0.175 / 2,
);

/// Dynamically calculate the outer factor based on the provided [outerRadius]
double outerRadius(double outerRadius) {
Expand Down
13 changes: 11 additions & 2 deletions lib/src/rounded_background_text_span.dart
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,9 +23,15 @@ class RoundedBackgroundTextSpan extends WidgetSpan {
double? innerRadius,
double? outerRadius,
TextAlign? textAlign,
int? maxLines,
EdgeInsets? firstLinePadding,
EdgeInsets? innerLinePadding,
EdgeInsets? lastLinePadding,
EdgeInsets? outerPadding,
}) : super(
child: Padding(
padding: const EdgeInsets.symmetric(horizontal: 8.0),
padding:
outerPadding ?? const EdgeInsets.symmetric(horizontal: 8.0),
child: RoundedBackgroundText(
text,
style: style,
Expand All @@ -35,7 +41,10 @@ class RoundedBackgroundTextSpan extends WidgetSpan {
innerRadius: innerRadius ?? kDefaultInnerRadius,
outerRadius: outerRadius ?? kDefaultOuterRadius,
textAlign: textAlign,
maxLines: 1,
maxLines: maxLines,
Copy link
Copy Markdown
Owner

@bdlukaa bdlukaa Feb 11, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
maxLines: maxLines,
maxLines: maxLines ?? 1,

firstLinePadding: firstLinePadding,
lastLinePadding: lastLinePadding,
innerLinePadding: innerLinePadding,
),
),
baseline: baseline,
Expand Down
Loading