{"id":23125472,"url":"https://github.com/nialixus/typewritertext","last_synced_at":"2025-07-24T11:15:16.280Z","repository":{"id":57210143,"uuid":"479615943","full_name":"Nialixus/typewritertext","owner":"Nialixus","description":"A simple typewriter text animation wrapper for flutter.","archived":false,"fork":false,"pushed_at":"2024-05-22T12:30:43.000Z","size":1102,"stargazers_count":5,"open_issues_count":1,"forks_count":2,"subscribers_count":1,"default_branch":"master","last_synced_at":"2024-05-22T13:44:42.407Z","etag":null,"topics":["dart","flutter","flutter-package","pub-dev"],"latest_commit_sha":null,"homepage":"","language":"Dart","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/Nialixus.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":".github/FUNDING.yml","license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null},"funding":{"github":null,"patreon":null,"open_collective":null,"ko_fi":"nialixus","tidelift":null,"community_bridge":null,"liberapay":null,"issuehunt":null,"otechie":null,"lfx_crowdfunding":null,"custom":null}},"created_at":"2022-04-09T04:20:15.000Z","updated_at":"2024-05-22T16:40:16.841Z","dependencies_parsed_at":"2023-12-08T03:24:50.464Z","dependency_job_id":"403a5ce4-6342-44de-8304-196638ef2c19","html_url":"https://github.com/Nialixus/typewritertext","commit_stats":{"total_commits":43,"total_committers":2,"mean_commits":21.5,"dds":0.4883720930232558,"last_synced_commit":"baa1f57bc0549f82277243851be9292da20ded2f"},"previous_names":[],"tags_count":12,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Nialixus%2Ftypewritertext","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Nialixus%2Ftypewritertext/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Nialixus%2Ftypewritertext/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Nialixus%2Ftypewritertext/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/Nialixus","download_url":"https://codeload.github.com/Nialixus/typewritertext/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":230085319,"owners_count":18170425,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["dart","flutter","flutter-package","pub-dev"],"created_at":"2024-12-17T08:13:42.245Z","updated_at":"2024-12-17T08:13:42.735Z","avatar_url":"https://github.com/Nialixus.png","language":"Dart","funding_links":["https://ko-fi.com/nialixus"],"categories":[],"sub_categories":[],"readme":"\u003cp align=\"center\"\u003e\n  \u003cimg src=\"https://user-images.githubusercontent.com/45191605/272785686-7a626063-6047-463a-b931-db256c708335.png\" alt=\"TypeWeriter Text Dall-E Logo\" width=\"150\"\u003e\n\u003c/p\u003e\n\n# Type Writer Text\n\n\u003ca href='https://pub.dev/packages/typewritertext'\u003e\u003cimg src='https://img.shields.io/pub/v/typewritertext.svg?logo=flutter\u0026color=blue\u0026style=flat-square'/\u003e\u003c/a\u003e\n\u003ca href=\"https://codecov.io/gh/Nialixus/typewritertext\"\u003e\u003cimg src=\"https://codecov.io/gh/Nialixus/typewritertext/graph/badge.svg?token=T66X1R33QE\"/\u003e\u003c/a\u003e\n\u003ca href=\"https://github.com/Nialixus/typewritertext/actions\"\u003e\u003cimg src=\"https://github.com/Nialixus/typewritertext/actions/workflows/test_coverage.yaml/badge.svg\" alt=\"test\"/\u003e\u003c/a\u003e\n\\\n\\\nA simple typewriter text animation wrapper for flutter, supports iOS, Android, web, Windows, macOS, and Linux.\n\n## Preview\n\n\u003cimg src=\"https://github.com/user-attachments/assets/451d0265-dd2d-4134-807d-a02e1f17b8bb\" alt=\"TypeWriterText Preview\" width=\"300\"\u003e\n\n\n## Install\n\nAdd this line to your pubspec.yaml.\n\n```yaml\ndependencies:\n  typewritertext: ^3.0.9\n```\n\n## Usage\n\nFirst, import the typewriter package.\n\n```dart\nimport 'package:typewritertext/typewritertext.dart';\n```\n\nAnd use it like this\n\n```dart\nTypeWriter.text(\n  'lorem ipsum dolot sit amet ...',\n  duration: const Duration(milliseconds: 50),\n);\n```\n\nAnd for the builder, you need to initiate a controller like this one.\n\n```dart\nfinal controller = TypeWriterController(text: 'Hello World',\n  duration: const Duration(milliseconds: 50),\n);\n\n// also if you want the typewriter to not only changing\n// the character but also words, you can use this controller.\n\nfinal valueController = TypeWriterController.fromValue(\n  TypeWriterValue([\n    'First Paragraph',\n    'Next Paragraph',\n    'Last Paragraph',\n  ]),\n  duration: const Duration(milliseconds: 50),\n);\n\n// you can also integrate the controller with Stream\u003cString\u003e like this one.\n\nfinal streamController = TypeWriterController.fromStream(\n  StreamController\u003cString\u003e().stream\n);\n\nTypeWriter(\n  controller: controller, // valueController // streamController\n  builder: (context, value) {\n    return Text(\n      value.text,\n      maxLines: 2,\n      minFontSize: 2.0,\n    );\n  }\n);\n```\n\n## Documentation\n\n### TypeWriter.text\n\n| Property           | Purpose                                                                                                           |\n| ------------------ | ----------------------------------------------------------------------------------------------------------------- |\n| repeat             | Specifies whether the animation should repeat once completed (default is `false`).                                |\n| enabled            | Is the flag to play the animation or not.                                                                         |\n| maintainSize       | Specifies whether the size of the layout text should be maintained.                                               |\n| duration           | Delay time between each character.                                                                                |\n| alignment          | Alignment of the text layout.                                                                                     |\n| text               | The text to be displayed during the typewriter animation.                                                         |\n| onChanged          | Callback function for when the text is changed.                                                                   |\n| textAlign          | Alignment of the text.                                                                                            |\n| style              | Style of the text.                                                                                                |\n| maxLines           | Maximum number of lines to be displayed.                                                                          |\n| overflow           | Overflow behavior of the text.                                                                                    |\n| semanticsLabel     | Semantics label of the text.                                                                                      |\n| softWrap           | Specifies whether the text should break at soft line breaks.                                                      |\n| strutStyle         | Strut style of the text.                                                                                          |\n| locale             | Locale of the text.                                                                                               |\n| textDirection      | Text direction of the text.                                                                                       |\n| textHeightBehavior | Text height behavior of the text.                                                                                 |\n| textWidthBasis     | Text width basis of the text.                                                                                     |\n| selectionColor     | Color of the selection.                                                                                           |\n| onFinished         | Is a callback that triggered when the animation is done. This requires [enabled] as `true` and repeat as `false`. |\n\n### TypeWriter\n\n| Property   | Purpose                                                                                                           |\n| ---------- | ----------------------------------------------------------------------------------------------------------------- |\n| controller | Controller that manage the animation. You can use `TypeWriterController` or `TypeWriterController.fromValue`.     |\n| enabled    | Is the flag to play the animation or not.                                                                         |\n| builder    | Builder that contains `TypeWriterValue` in sequence.                                                              |\n| onFinished | Is a callback that triggered when the animation is done. This requires [enabled] as `true` and repeat as `false`. |\n\n## Example\n\n- \u003ca href=\"https://github.com/Nialixus/typewritertext/blob/master/example/lib/main.dart\"\u003etypewritertext/example/lib/main.dart\u003c/a\u003e\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fnialixus%2Ftypewritertext","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fnialixus%2Ftypewritertext","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fnialixus%2Ftypewritertext/lists"}