Restrict Landscape mode in Flutter

In this article, we'll learn how to restrict landscape mode in the flutter app. A production-ready app should be free from all sorts of bugs and errors. Mostly, we design our app for portrait orientation if we flip to landscape orientation, the UI might not be adjusted for that. So, there are two cases, first is that your app can be adjusted for landscape orientation, and second is that your app might not require landscape orientation.

So, in the second case, we can restrict the landscape orientation. This can be done by using the default SystemChrome class. This class has a method setPreferredOrientations, which takes a list of device orientations that need to be implemented in the app. 

Available Orientations

• landscapeLeft
• landscapeRight
• portraitDown
• portraitUp

Syntax:

SystemChrome.setPreferredOrientations([DeviceOrientation.yourChoice])

Here, SystemChrome is the default class that controls many device features. This class has a method setPreferredOrientations, which takes a list of type DeviceOrientation, and preferred orientations can be passed to it as a list.

Example to Restrict Landscape Mode in Flutter

main.dart:

import 'package:flutter/material.dart';

//For using SystemChrome
import 'package:flutter/services.dart'; 

void main() {
  WidgetsFlutterBinding.ensureInitialized();
  SystemChrome.setPreferredOrientations([DeviceOrientation.portraitUp]);
  runApp(MyApp());
}

class MyApp extends StatelessWidget {
  @override
  Widget build(BuildContext context) {
    return MaterialApp(
      debugShowCheckedModeBanner: false,
      home: Scaffold(
        appBar: AppBar(
          backgroundColor: Colors.green,
          foregroundColor: Colors.white,
          title: Text("GeeksForGekks"),
        ),
        body: Center(
          child: Text(
            'This app can\'t be rotated to Landscape mode',
            style: TextStyle(color: Colors.green, fontSize: 17),
          ),
        ),
      ),
    );
  }
}

Output:

The output app as shown above would be restricted to only portrait mode. Even if you rotate the device, it would not change to landscape mode. 

Points to remember

• Don't forget to include import 'package:flutter/services.dart';  as SystemChrome is defined in services.dart file.
• Also add WidgetsFlutterBinding.ensureInitialized(); before using SystemChrome class. If you don't add this line of code, then the orientation restriction might not work on some devices. In newer versions of Flutter, it is required to add this method.
• If your target device is an iPad, then the above code would only work, if multitasking is disabled.
• In order to solve this problem, you can opt-out of multitasking on iPad, then the above code would work, but your app wouldn't support Slide Over and Split View multitasking.
• If you decide to opt-out of multitasking, you can do this by changing the setting "Requires full screen” to true in the Xcode Deployment Info.