dashronym #

dashronym creates inline glossary cards for acronyms that appear inside your Flutter text widgets. Authors can mark acronyms like (SDK) or rely on bare ALL-CAPS matches, and the extension transforms them into tappable overlays that surface full descriptions without breaking reading flow.

Features #

• Text.dashronyms() extension that swaps matching tokens for interactive WidgetSpans.
• DashronymText widget for composing standalone rich text blocks.
• Configurable matching (DashronymConfig) with optional bare acronym detection.
• Theme controls (DashronymTheme) for underline styles, hover behaviour, and card layout.
• Lightweight LRU caching to avoid reparsing unchanged strings.

Installation #

Add the package to your pubspec.yaml:

dependencies:
  dashronym: ^0.0.1

Run flutter pub get to pull in the dependency.

Quick start #

final registry = AcronymRegistry({
  'SDK': 'Software Development Kit',
  'API': 'Application Programming Interface',
  'CLI': 'Command Line Interface',
});

class OverviewText extends StatelessWidget {
  const OverviewText({super.key});

  @override
  Widget build(BuildContext context) {
    return const Text(
      'Our (SDK) exposes a lightweight (API) for CLI tooling.',
    ).dashronyms(
      registry: registry,
      config: const DashronymConfig(enableBareAcronyms: true),
    );
  }
}

Take a look at the /example app for a longer, article-style demonstration that highlights theming and advanced usage.

Configuration #

Contributing #

Contributions, issues, and feature requests are welcome! Please open an issue on the GitHub tracker.