{"id":15556546,"url":"https://github.com/comigor/showcase","last_synced_at":"2026-01-11T13:32:24.086Z","repository":{"id":56839108,"uuid":"151665175","full_name":"comigor/showcase","owner":"comigor","description":"Generate documentation screenshots of your widgets.","archived":false,"fork":false,"pushed_at":"2020-01-25T01:42:20.000Z","size":401,"stargazers_count":18,"open_issues_count":2,"forks_count":2,"subscribers_count":2,"default_branch":"master","last_synced_at":"2025-04-18T05:53:32.871Z","etag":null,"topics":["dart","documentation","flutter","screenshot","test","testing"],"latest_commit_sha":null,"homepage":"https://pub.dartlang.org/packages/showcase","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/comigor.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2018-10-05T03:17:38.000Z","updated_at":"2023-12-07T06:52:02.000Z","dependencies_parsed_at":"2022-08-28T23:30:51.078Z","dependency_job_id":null,"html_url":"https://github.com/comigor/showcase","commit_stats":null,"previous_names":[],"tags_count":13,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/comigor%2Fshowcase","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/comigor%2Fshowcase/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/comigor%2Fshowcase/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/comigor%2Fshowcase/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/comigor","download_url":"https://codeload.github.com/comigor/showcase/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":250513250,"owners_count":21443189,"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","documentation","flutter","screenshot","test","testing"],"created_at":"2024-10-02T15:14:10.749Z","updated_at":"2026-01-11T13:32:24.053Z","avatar_url":"https://github.com/comigor.png","language":"Dart","funding_links":[],"categories":[],"sub_categories":[],"readme":"\u003cp align=\"center\"\u003e\n  \u003cimg src=\"https://user-images.githubusercontent.com/735858/46586739-1cddd400-ca59-11e8-9e61-42961d8a8b3b.gif\" width=\"300\"\u003e\n  \u003ch1\u003e\u003cb\u003eShowcase\u003c/b\u003e\u003c/h1\u003e\n\u003c/p\u003e\n\n\u003c!-- Badges --\u003e\n\n[![Pub Package](https://img.shields.io/pub/v/showcase.svg)](https://pub.dartlang.org/packages/showcase)\n[![CircleCI](https://circleci.com/gh/Igor1201/showcase/tree/master.svg?style=svg\u0026circle-token=ea7145c55f42eb71149713dc604a911571022ff9)](https://circleci.com/gh/Igor1201/showcase/tree/master)\n\n**Generate documentation screenshots of your widgets.**\n\n---\n\n## **Installation**\nAdd the following to your `pubspec.yaml` file:\n```yaml\ndev_dependencies:\n  showcase: \u003c1.0.0\n```\nthen run:\n```shell\nflutter packages get\n```\n\nThen you can either annotate the widgets you want to have showcased or manually create a test file with multiple widgets:\n\n### **With annotations**\nAdd another dependency to your `pubspec.yaml` file:\n```yaml\ndev_dependencies:\n  build_runner: ^1.2.8\n```\n\nJust annotate the widgets you want with `@Showcased`:\n```dart\nimport 'package:showcase/showcase.dart';\n\n@Showcased()\nclass MyWidget extends StatelessWidget {\n  // ...\n}\n```\n\nThe builder will generate a `.showcased_test.dart` test file for each annotated class file. Just run:\n```shell\nflutter packages pub run build_runner build\n```\n\n### **Manually testing**\nCreate a test file with the following:\n```dart\nimport 'package:flutter_test/flutter_test.dart';\nimport 'package:showcase/showcase.dart';\n\nvoid main() {\n  group('Showcase!', () {\n    showcaseWidgets([]);\n  });\n}\n```\n\nReplace the empty list with a collection of widgets. `showcaseWidgets` also have some options you can tweak.\n\nThen it's just a matter of running `flutter test` and have your screenshots generated on `./showcase/` (or another output directory you had configured).\n\n## **Example showcase**\nThe example app provided generates the following showcase image:\n![](example/test/showcase/000_MyWidget.png)","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcomigor%2Fshowcase","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fcomigor%2Fshowcase","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcomigor%2Fshowcase/lists"}