{"id":22015620,"url":"https://github.com/iconica-development/flutter_start","last_synced_at":"2025-07-26T11:40:42.773Z","repository":{"id":218922835,"uuid":"747621432","full_name":"Iconica-Development/flutter_start","owner":"Iconica-Development","description":"Flutter_start is a package that allows you to jumpstart your application with a splashScreen, introduction and a home.","archived":false,"fork":false,"pushed_at":"2024-07-30T11:19:43.000Z","size":75,"stargazers_count":0,"open_issues_count":1,"forks_count":0,"subscribers_count":1,"default_branch":"master","last_synced_at":"2024-10-20T03:57:57.783Z","etag":null,"topics":["component","user-story"],"latest_commit_sha":null,"homepage":"","language":"Dart","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"bsd-3-clause","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/Iconica-Development.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":"CONTRIBUTING.md","funding":null,"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}},"created_at":"2024-01-24T10:01:14.000Z","updated_at":"2024-07-30T11:19:23.000Z","dependencies_parsed_at":"2024-02-02T16:26:49.384Z","dependency_job_id":"935f4110-93ca-41aa-b287-0ccac735c858","html_url":"https://github.com/Iconica-Development/flutter_start","commit_stats":null,"previous_names":["iconica-development/flutter_start"],"tags_count":12,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Iconica-Development%2Fflutter_start","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Iconica-Development%2Fflutter_start/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Iconica-Development%2Fflutter_start/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Iconica-Development%2Fflutter_start/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/Iconica-Development","download_url":"https://codeload.github.com/Iconica-Development/flutter_start/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":245078198,"owners_count":20557282,"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":["component","user-story"],"created_at":"2024-11-30T04:26:44.811Z","updated_at":"2025-07-26T11:40:42.762Z","avatar_url":"https://github.com/Iconica-Development.png","language":"Dart","readme":"# flutter_start\n\nFlutter_start is a package that allows you to jumpstart your application with a splashScreen, introduction and a home.\n\n## Setup\n\nTo use this package, add flutter_start as a dependency in your pubspec.yaml file:\n\n```yaml\ndependencies:\n  flutter_start: \n    hosted: https://forgejo.internal.iconica.nl/api/packages/internal/pub\n    version: \u003ccurrent version\u003e\n```\n\n## go_router\n\nAdd `go_router` as dependency to your project.\n\nAdd the following configuration to your flutter_application:\n\n```\nList\u003cGoRoute\u003e getStartStoryRoutes() =\u003e getStartStoryRoutes();\n```\n\nOr with options:\n\nPlace the following code somewhere in your project where it can be accessed globally:\n\n```\nvar startUserStoryConfiguration = const StartUserStoryConfiguration();\n```\n\n```\nList\u003cGoRoute\u003e getStartStoryRoutes() =\u003e getStartStoryRoutes(\n      configuration: startUserStoryConfiguration,\n    );\n```\n\nFinally add the `getStartRoutes` to your `go_router` routes like so:\n\n```\nfinal GoRouter _router = GoRouter(\n  routes: \u003cRouteBase\u003e[\n    ...getStartStoryRoutes()\n  ],\n);\n```\n\nThe routes that can be used to navigate are:\n\nFor routing to the `splashScreen`:\n\n```\nstatic const String splashScreen = '/splashScreen';\n```\n\nFor routing to the `introduction`:\n\n```\nstatic const String introduction = '/introduction';\n```\n\nFor routing to the `home`:\n\n```\nstatic const String home = '/home';\n```\n\nIf you don't want a SplashScreen in your application set your initialRoute to `Introduction`:\n\n```\nfinal GoRouter _router = GoRouter(\n  routes: \u003cRouteBase\u003e[\n    ...getStartRoutes()\n  ],\n    initialLocation: '/introduction',\n);\n```\n\n## Navigator\n\nAdd the following code to the build-method of a chosen widget like so:\n```\nclass Example extends StatelessWidget {\n  const Example({super.key});\n\n  @override\n  Widget build(BuildContext context) {\n    return NavigatorStartUserStory(\n      onComplete: (context) {},\n    );\n  }\n}\n```\n\nor with options:\n\nPlace the following code somewhere in your project where it can be accessed globally:\n\n```\nvar startUserStoryConfiguration = const StartUserStoryConfiguration();\n```\n\n```\nclass Example extends StatelessWidget {\n  const Example({super.key});\n\n  @override\n  Widget build(BuildContext context) {\n    return NavigatorStartUserStory(\n      configuration: startUserStoryConfiguration,\n      onComplete: (context) {},\n    );\n  }\n}\n```\n\nThe `StartUserStoryConfiguration` has its own parameters, as specified below:\n| Parameter | Explanation |\n|-----------|-------------|\n| `splashScreenBuilder` | The builder to override the default splashScreen |\n| `introductionBuilder` | A builder to wrap the introductions in your own page |\n| `introductionOptionsBuilder` | The builder to override the default `introductionOptions` |\n|`introductionService` | The service to override the default `introductionService` |\n| `homeScreenRoute` | The route to navigate to after the introduction or splashScreen is completed |\n| `introductionFallbackScreen` | The screen that is shown when something goes wrong fetching data for the introduction |\n| `introductionScrollPhysics` | The scroll physics for the introduction |\n| `showIntroduction` | A boolean to show the introduction or not. Defaults to true |\n| `useKillswitch` | A boolean to use the killswitch or not. Defaults to false |\n| `minimumSplashScreenDuration` | The minimum duration the splashScreen should be shown. Defaults to 3 seconds |\n| `splashScreenFuture` | The future to be completed before the splashScreen is completed |\n| `splashScreenCenterWidget` | The widget to be shown in the center of the splashScreen |\n| `splashScreenBackgroundColor` | The color of the splashScreen background. Defaults to ThemeData.scaffoldBackgroundColor |\n| `canPopFromIntroduction` | Allow popping from introduction, defaults to true. Defaults to true |\n| `killswitchService` | The service to override the default killswitch service |\n| `showSplashScreen` | A boolean to show the splashScreen or not. Defaults to true |\n\n\n## Issues\n\nPlease file any issues, bugs or feature request as an issue on our [GitHub](https://github.com/Iconica-Development/flutter_start) page. Commercial support is available if you need help with integration with your app or services. You can contact us at [support@iconica.nl](mailto:support@iconica.nl).\n\n## Want to contribute\n[text](about:blank#blocked)\nIf you would like to contribute to the plugin (e.g. by improving the documentation, solving a bug or adding a cool new feature), please carefully review our [contribution guide](./CONTRIBUTING.md) and send us your [pull request](https://github.com/Iconica-Development/flutter_start/pulls).\n\n## Author\n\nThis flutter_start for Flutter is developed by [Iconica](https://iconica.nl). You can contact us at \u003csupport@iconica.nl\u003e","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ficonica-development%2Fflutter_start","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Ficonica-development%2Fflutter_start","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ficonica-development%2Fflutter_start/lists"}