Configuring the URL strategy on the web

Flutter web apps support two ways of configuring URL-based navigation on the web:

Hash (default)

Paths are read and written to the hash fragment. For example, flutterexample.dev/#/path/to/screen.

Path

Paths are read and written without a hash. For example, flutterexample.dev/path/to/screen.

To configure Flutter to use the path instead, use the usePathUrlStrategy function provided by the flutter_web_plugins library, which is part of the Flutter SDK.

You can't directly add flutter_web_plugins using pub add. Include it as a Flutter SDK dependency in your pubspec.yaml file:

dependencies:
  flutter:
    sdk: flutter
  flutter_web_plugins:
    sdk: flutter

Then call the usePathUrlStrategy function before runApp:

import 'package:flutter_web_plugins/url_strategy.dart';

void main() {
  usePathUrlStrategy();
  runApp(ExampleApp());
}

PathUrlStrategy uses the History API, which requires additional configuration for web servers.

To configure your web server to support PathUrlStrategy, check your web server's documentation to rewrite requests to index.html. Check your web server's documentation for details on how to configure single-page apps.

If you are using Firebase Hosting, choose the "Configure as a single-page app" option when initializing your project. For more information see Firebase's Configure rewrites documentation.

The local dev server created by running flutter run -d chrome is configured to handle any path gracefully and fallback to your app's index.html file.

Update the <base href="/"> tag in web/index.html to the path where your app is hosted. For example, to host your Flutter app at my_app.dev/flutter_app, change this tag to <base href="/flutter_app/">.

Relative base href tags are supported for release builds but they must take into account the full URL where the page was served from. This means a relative base href for a request to /flutter_app/, /flutter_app/nested/route, and /flutter_app/nested/route/ will be different (for example ".", "..", and "../.." respectively).

Unless stated otherwise, the documentation on this site reflects the latest stable version of Flutter. Page last updated on 2024-10-16. View source or report an issue.