textf 1.1.0

Markdown-like text styling for inline text — fully compatible with Flutter’s `Text` widget. Easily replace Text with Textf to add simple formatting.

Changelog

All notable changes to the textf package will be documented in this file.

1.1.0

Breaking Changes

• Style Inheritance Refactor: Refactored TextfOptions and DefaultStyles to correctly merge styles down the widget tree by passing the baseStyle through the resolution chain. This ensures that properties like fontSize or decoration are correctly inherited and merged, fixing issues where child styles might blindly override parent styles or miss context.

Added

• Named Widget Placeholders: You can now insert arbitrary Flutter widgets (via InlineSpan) into formatted text using {key} syntax and the placeholders map. (based on PR #5, thanks @admin-kinora)

Improved

• Smart Caching System: Implemented a robust internal caching layer within the renderer. Textf now retains previously parsed InlineSpan trees across widget rebuilds, preventing expensive re-parsing when the text content hasn't changed.
• Performance Optimization: The widget now intelligently detects changes in TextfOptions, ThemeData, and TextScaler. It re-uses cached results even when parent widgets rebuild, provided the actual formatting configuration remains logically equivalent. This drastically reduces CPU overhead during animations and list scrolling.
• Internal Optimization: Refactored TextfParser to use StringBuffer for text accumulation, improving performance for large text blocks.

1.0.0

BREAKING CHANGES

• API Renaming: Renamed all TextfOptions properties and callbacks related to links to use the term link instead of url for better consistency with Markdown terminology and improved API clarity. For example, urlStyle is now linkStyle and onUrlTap is now onLinkTap.

Added

• Superscript & Subscript: Added support for ^superscript^ and ~subscript~ formatting.
• Accessibility Enhancements: Improved link semantics in HoverableLinkSpan for better screen reader support.

Changed

• URL Normalization: Updated the default fallback for scheme-less URLs (e.g., google.com) to prepend https:// instead of http:// .
• Internal Refactoring: Major refactoring of the TextfTokenizer for improved maintainability and performance.
• RTL Support: Verified and enhanced Right-to-Left (RTL) support throughout the widget and its components.
• Performance: Refactored the internal parsing loop to improve performance and reduce memory allocation, especially with complex formatted text.
• Optimization: Minor optimizations to internal link rendering logic and widget instantiation for better efficiency.

Fixed

• Link Handling: Fixed an issue in the URL normalization logic that would incorrectly prepend http:// to non-HTTP schemes like mailto: or tel:.
• Styling: Corrected an issue where nested TextfOptions could improperly combine TextDecoration styles, potentially leading to visual duplication. The style merging logic is now more robust.

0.6.3

Fixed

• Dart format code: analysis_options

0.6.2

Added

• Multi-byte Character Tests
• Dart code: added trailing commas

0.6.1

Changed

• Formatted codebase for consistency and readability
• Updated documentation for clarity and completeness

0.6.0

BREAKING CHANGES

• Style Inheritance Logic: The logic for inheriting TextStyle properties from nested TextfOptions has been completely refactored to be more intuitive and powerful.
  • Previous Behavior: A TextStyle property (like boldStyle) in a child TextfOptions would completely overwrite the style from a parent. For example, a child's decoration would replace the parent's decoration.
  • New Behavior: TextStyle properties are now merged down the tree. Decorations from parent and child TextfOptions are intelligently combined, allowing for layering (e.g., adding a strikethrough to text that is already underlined by a parent).

Fixed

• TextfOptions does not combine decorations from nested widgets (#3)

0.5.1

Added

• Example for pub.dev

0.5.0

Breaking Changes

• Hover Callbacks: Changed hover callback parameters from positional to named parameters for improved API clarity. The onUrlHover callback now uses isHovering as a named parameter:

  // Before:
  onUrlHover: (url, displayText, true)
  
  // After:
  onUrlHover: (url, displayText, isHovering: true)
  

Added

• Enhanced Code Analysis: Integrated very_good_analysis and dart_code_metrics for improved code quality and consistency
• Unit Tests: Added comprehensive unit tests for NestingValidator class

0.4.1

Removed

• Removed unnecessary files

0.4.0

2025-05-18

Added

• Underline Formatting: Implemented support for underline formatting with ++text++ syntax.

• Highlight Formatting: Implemented support for highlight formatting with ==text== syntax.

• Improved Decoration Handling: Default styles for strikethrough and underline now attempt to combine with existing decorations on the base style, allowing for concurrent ++~~underline and strikethrough~~++. decorationColor and decorationThickness from the most recently applied default decoration or TextfOptions will take precedence for the combined decoration.

Changed

• TextfOptions: Extended with underlineStyle and highlightStyle properties.
• Link Formatting:
  • Nested text decorations within link display text (e.g., [~~strikethrough~~](url)) are now correctly combined with the link's own decoration (e.g., underline), ensuring both are visually applied.
  • Improved application of TextfOptions.urlHoverStyle, ensuring hover-specific styles correctly merge with the link's resolved normal appearance, preserving properties like color and font size unless explicitly overridden by the hover style.
• Internal Refactoring: Enhanced TokenType enum to directly indicate if a token is for links or formatting. This improves internal parsing logic in PairingResolver and TextfParser for minor performance gains and better code clarity. (Thanks @timmaffett!)

0.3.0

2025-04-18

Added

• Theme-Aware Default Styling: Implemented theme-aware default styling for inline code (`code`) and links ([text](url)). Their appearance now automatically adapts to the application's ThemeData (e.g., using colorScheme.primary for links, theme-appropriate background/text for code) unless overridden by TextfOptions.
• strikethroughThickness Option: Added the strikethroughThickness property to TextfOptions to allow customizing the line thickness for ~~strikethrough~~ text when not providing a full strikethroughStyle.
• TextScaler Support: Added support for the textScaler property, allowing Textf to respect system font scaling settings and custom TextScaler instances, similar to the standard Text widget.

Changed

• Documentation: Significantly enhanced README.md with detailed explanations of all TextfOptions properties, their inheritance behavior, and added styling recommendations.
• Code Font Defaults: Improved default font family fallbacks for inline code (code) for better cross-platform rendering when a specific codeStyle is not provided (uses RobotoMono, Menlo, Courier New, monospace).

Removed

• Internal Caching: Removed the internal caching mechanism for parsed results to simplify the parsing logic and resolve potential inconsistencies during hot reload. Performance remains optimized through efficient algorithms.

Fixed

• Internal: Updated internal tests to correctly account for the new theme-aware default styles.

0.2.1

2025-04-12

Fixed

• Hot Reload Reliability: Fixed an issue where changes made to TextfOptions (e.g., custom colors, styles) or internal formatting logic might not render correctly immediately after using hot reload during development. The internal parser cache is now properly invalidated only in debug mode during reassemble, ensuring UI consistency and improving the development workflow without affecting release build performance.

0.2.0

2025-04-12

Added

• Link Support: Implemented full support for Markdown-style links with [text](url) syntax

  • Added interactive link styling with customizable colors and decorations
  • Created hover effects for links with mouse cursor changes
  • Enabled nested formatting within link text (e.g., [**bold** link](url))
  • Added onUrlTap and onUrlHover callbacks for link interaction

• TextfOptions: Introduced a new widget to customize text formatting styles

  • Global styling options for all formatting types (bold, italic, code, etc.)
  • Configurable link appearance and behavior
  • Inheritance-based configuration through the widget tree

• Enhanced Styling: Added support for more detailed text styling

  • Font family customization for code blocks
  • Expanded default styles for each formatting type

Fixed

• Updated default font family for inline code text to RobotoMono for better readability
• Enabled trailing commas in analysis options for code consistency

0.1.1

2025-04-05

Changed

• Updated pubspec.yaml with simpler description to meet pub.dev guidelines
• Added publisher information to pubspec.yaml
• Removed example directory from .pubignore for better documentation

Fixed

• Formatted code for tests to meet Dart style guidelines

0.1.0

2025-04-04

Added

• Initial release of Textf lightweight text formatting widget
• Support for bold formatting with **text** or __text__
• Support for italic formatting with *text* or _text_
• Support for combined bold+italic with ***text*** or ___text___
• Support for strikethrough with ~~text~~
• Support for inline code with `code`
• Escape character support with backslash
• Performance optimization with caching
• Nested formatting support (up to 2 levels deep)

0.0.1

• Initial release of Textf widget.