How do you detect the host platform from Dart code?

Question

For UI that should differ slightly on iOS and Android, i.e. on different platforms, there must be a way to detect which one the app is running on, but I couldn't find it in the docs. What is it?

Md. Yeasin Sheikh · Accepted Answer · 2021-12-26 09:44:04Z

937

import 'dart:io' show Platform;

if (Platform.isAndroid) {
  // Android-specific code
} else if (Platform.isIOS) {
  // iOS-specific code
}

All options include:

Platform.isAndroid
Platform.isFuchsia
Platform.isIOS
Platform.isLinux
Platform.isMacOS
Platform.isWindows

You can also detect if you are running on the web using kIsWeb, a global constant indicating if the application was compiled to run on the web:

import 'package:flutter/foundation.dart' show kIsWeb;

if (kIsWeb) {
  // running on the web!
} else {
  // NOT running on the web! You can check for additional platforms here.
}

Platform documentation: https://api.flutter.dev/flutter/dart-io/Platform-class.html
kIsWeb documentation: https://api.flutter.dev/flutter/foundation/kIsWeb-constant.html

edited Dec 26, 2021 at 9:44

Md. Yeasin Sheikh

59.6k7 gold badges36 silver badges65 bronze badges

answered Jun 7, 2018 at 15:02

Westy92

20.2k4 gold badges76 silver badges61 bronze badges

Undefined name 'Platform'.dart(undefined_identifier) Is there any per-requisites to use Platform?
– Nato Boram
Jan 23, 2019 at 20:06
5

I have updated my answer to include the needed import.
– Westy92
Jan 23, 2019 at 23:50
@NatoBoram you have to call Platform.isAndroid in a method of class, direct call in class didnt work
– Jabir Ishaq
Sep 27, 2019 at 4:55
2

Note that this won't work for flutter web. Throws an exception because of dependence on dart:io
– Srikanth
Nov 13, 2020 at 5:27
3

@Srikanth if you check kIsWeb before checking other platforms, like my answer shows, it will work just fine. I just verified this on Dartpad web.
– Westy92
Nov 13, 2020 at 18:10

Add a comment |

CopsOnRoad · Accepted Answer · 2018-11-18 16:45:31Z

133

Thanks to Collin, the final answer is:

bool isIOS = Theme.of(context).platform == TargetPlatform.iOS;

edited Nov 18, 2018 at 16:45

CopsOnRoad

253k83 gold badges672 silver badges457 bronze badges

answered Aug 28, 2017 at 21:06

Gavin

6,9153 gold badges22 silver badges23 bronze badges

3

Only this answer is up-to-date with the latest Flutter framework. The rest answers are not wrong but defaultTargetPlatform seems to be no longer part of the framework
– Stoycho Andreev
Dec 10, 2017 at 14:31
1

This solution allow you to change the platform during tests, something that I couldn't with Platform.isIOS
– César N.
Feb 3, 2021 at 6:24
5

Watch out on this solution. If it's called in initstate() it will throw an exception as Theme.of() is a inherited widgets and will listen to changes. Which cannot be done in initstate() so it throws exception
– Panagiss
Jun 13, 2022 at 20:51

Add a comment |

Md. Yeasin Sheikh · Accepted Answer · 2021-12-26 09:42:49Z

47

Although defaultTargetPlatform will work, I would suggest using Theme.of(context).targetPlatform. This enables testing of iOS behavior (because defaultTargetPlatform is always TargetPlatform.android in tests). It also allows ancestors of your widget to override its target platform by wrapping it in a Theme widget.

edited Dec 26, 2021 at 9:42

Md. Yeasin Sheikh

59.6k7 gold badges36 silver badges65 bronze badges

answered Aug 28, 2017 at 17:58

Collin Jackson

114k31 gold badges223 silver badges152 bronze badges

1

May I ask what is the difference between what is proposed and this if (Platform.isIOS) {//my iOS widgets}
– Shady Aziza
Aug 28, 2017 at 21:31
4

Platform.isIOS has the same problems as defaultTargetPlatform. It doesn't work in tests and can't be overwritten by the Theme widget.
– Collin Jackson
Aug 28, 2017 at 21:33
2

Now you can override defaultTargetPlatform in unittest with debugDefaultTargetPlatformOverride api.flutter.dev/flutter/foundation/…
– Yuwen Yan
Nov 20, 2019 at 8:32
Yuwen Yan is wrong, per debugDefaultTargetPlatform doc Setting debugDefaultTargetPlatformOverride (as opposed to, say, ThemeData.platform) will cause unexpected and undesirable effects. For example, setting this to TargetPlatform.iOS when the application is running on Android will cause the TalkBack accessibility tool on Android to be confused because it would be receiving data intended for iOS VoiceOver. Similarly, setting it to TargetPlatform.android while on iOS will cause certainly widgets to work assuming the presence of a system-wide back button, which
– Fred Grott
Nov 29, 2022 at 14:55

Add a comment |

Phani Rithvij · Accepted Answer · 2019-10-31 23:58:58Z

42

import 'dart:io' show Platform;  //at the top

String os = Platform.operatingSystem; //in your code
print(os);

edited Oct 31, 2019 at 23:58

Phani Rithvij

4,1903 gold badges26 silver badges63 bronze badges

answered Feb 16, 2019 at 12:41

C-Spydo

7898 silver badges8 bronze badges

10

Note that this won't work for flutter web. Throws an exception because of dependence on dart:io
– Srikanth
Nov 13, 2020 at 5:27

Add a comment |

Osama Buzdar · Accepted Answer · 2020-07-25 19:57:07Z

26

It is simple just import the io library

import'dart:io' show Platform;
void main(){
if(Platform.isIOS){
  return someThing();
}else if(Platform.isAndroid){
  return otherThing();
}else if(Platform.isMacOS){
  return anotherThing();
}

or in very simple way

Platform.isIOS ? someThing() : anOther(),

answered Jul 25, 2020 at 19:57

Osama Buzdar

1,16510 silver badges20 bronze badges

2

This is the correct answer. You simply need to remove any dart:HTML import from your code as it will cause an error.
– tyler powell
Jul 29, 2020 at 15:24

Add a comment |

Skandar Munir · Accepted Answer · 2021-02-09 04:45:41Z

if (Platform.isAndroid) {
  // Android-specific code/UI Component
} else if (Platform.isIOS) {
  // iOS-specific code/UI Component
}

Don't forget to import IO Library.

import 'dart:io';

If you are using import 'dart:html'; too in same file then you have to specify Platform definition as both libraries has definition of "Platform"

in that case use Platform Specific Code like Below:

import 'dart:io' as IO;
import 'dart:html';

if (IO.Platform.isAndroid) {
  // Android-specific code/UI Component
} else if (IO.Platform.isIOS) {
  // iOS-specific code/UI Component
}

If you are looking into Platform Integration properly I would Suggest Use Complete Example on Flutter site: https://flutter.dev/docs/development/platform-integration/platform-channels

Shirsh Shukla · Accepted Answer · 2020-12-04 10:27:08Z

for more simple way for web and app both.try this

import 'dart:io' show Platform;
import 'package:flutter/foundation.dart' show kIsWeb;


var platformName = '';
if (kIsWeb) {
  platformName = "Web";
} else {
  if (Platform.isAndroid) {
    platformName = "Android";
  } else if (Platform.isIOS) {
    platformName = "IOS";
  } else if (Platform.isFuchsia) {
    platformName = "Fuchsia";
  } else if (Platform.isLinux) {
    platformName = "Linux";
  } else if (Platform.isMacOS) {
    platformName = "MacOS";
  } else if (Platform.isWindows) {
    platformName = "Windows";
  }
}
print("platformName :- "+platformName.toString());

Rémi Rousselet · Accepted Answer · 2019-02-02 14:46:25Z

18

You can do

defaultTargetPlatform == TargetPlatform.iOS
          ? kIOSTheme
          : kDefaultTheme,

from import 'package:flutter/foundation.dart';

edited Feb 2, 2019 at 14:46

answered Aug 28, 2017 at 17:38

Rémi Rousselet

267k85 gold badges539 silver badges444 bronze badges

It doesn't work anymore. I failed to get defaultTargetPlatform.
– I. Pedan
Feb 2, 2019 at 14:05
1

May be with the import that you added yesterday to the post. :D
– I. Pedan
Feb 4, 2019 at 8:00

Add a comment |

Ugurcan Yildirim · Accepted Answer · 2019-02-15 12:14:13Z

15

Most "Flutter" answer is as follows:

import 'package:flutter/foundation.dart' show TargetPlatform;

//...

if(Theme.of(context).platform == TargetPlatform.android)
    //do sth for Android
else if(Theme.of(context).platform == TargetPlatform.iOS)
    //do sth else for iOS
else if(Theme.of(context).platform == TargetPlatform.fuchsia)
    //even do sth else for Fuchsia OS

answered Feb 15, 2019 at 12:14

Ugurcan Yildirim

6,0434 gold badges44 silver badges75 bronze badges

Add a comment |

Omar Mahmoud · Accepted Answer · 2022-06-19 14:58:05Z

10

you can add this extension file (platform_ext.dart) to the project and call in any object

import 'dart:io';
import 'package:flutter/foundation.dart' show kIsWeb;

extension Target on Object {
  bool isAndroid() {
    return Platform.isAndroid;
  } 
  bool isIOS() {
    return Platform.isIOS;
  } 
  bool isLinux() {
  return Platform.isLinux;
  } 
  bool isWindows() {
  return Platform.isWindows; 
  }
  bool isMacOS() {
  return Platform.isMacOS; 
  }
  bool isWeb() {
  return kIsWeb; 
  }
  // ···
}

just import the file and call it

   import 'platform_ext.dart';
        ....
        @override
          Widget build(BuildContext context) {
            return isAndroid()? Text("Android"):Text("Not Android");
          }

edited Jun 19, 2022 at 14:58

answered Aug 27, 2021 at 13:05

Omar Mahmoud

2,9921 gold badge15 silver badges24 bronze badges

3

This is really an overkill. Why would each and every object knew about Platforms? While it is convenient it is terrible now that your String object will know what platform it is.. Keep this in separate class that you can instantiate when you need this info..
– Martin Berger
Nov 29, 2022 at 14:20

Add a comment |

J. Nuno Negrão Martins · Accepted Answer · 2020-05-09 18:50:12Z

7

You can use Universal Platform package:

https://pub.dev/packages/universal_platform

import 'package:universal_platform/universal_platform.dart';

bool isIos = UniversalPlatform.isIOS;
bool isAndroid = UniversalPlatform.isAndroid;
bool isWeb = UniversalPlatform.isWeb;
print('iOS: $isIos');
print('Android: $isAndroid');
print('Web: $isWeb');

answered May 9, 2020 at 18:50

J. Nuno Negrão Martins

951 silver badge4 bronze badges

I recommend this... because only after I noticed strange behavior of Platform.isIOS on different browsers, I felt this was a package to go to! By the way it does deliver all 7 platforms
– Yo Apps
Oct 19, 2020 at 18:24
2

universal_platform just uses Platform.isWindows, Platform.isAndroid, etc. under the hood.
– spekary
Nov 12, 2020 at 18:27

Add a comment |

Anuran Barman · Accepted Answer · 2021-05-29 13:45:19Z

7

import 'dart:io' as io;

if(io.Platform.isAndroid){
 doSomething();
}else {
 doSomethingElse();
}

answered May 29, 2021 at 13:45

Anuran Barman

1192 silver badges7 bronze badges

Add a comment |

hunterino · Accepted Answer · 2021-07-30 18:13:25Z

So here is a little utility I use to detect platforms and os to be reactive as appropriate.

import'dart:io' show Platform;
import 'package:flutter/foundation.dart' show kIsWeb;

class Util {

  os getPlatform() {
    if (kIsWeb) {
      return os.Web;
    } else if (Platform.isIOS) {
      return os.IOS;
    } else if (Platform.isAndroid) {
      return os.Android;
    } else if (Platform.isFuchsia) {
      return os.Fuchsia;
    } else if (Platform.isLinux) {
      return os.Linux;
    } else if (Platform.isMacOS) {
      return os.MacOS;
    } else if (Platform.isWindows) {
      return os.Windows;
    }
    return os.Unknown;
  }

  bool isWeb() {
    return (getPlatform()==os.Web);
  }

  bool isMobile() {
    os platform = getPlatform();
    return (platform == os.Android || platform == os.IOS || platform== os.Fuchsia);
  }

  bool isComputer() {
    os platform = getPlatform();
    return (platform == os.Linux || platform == os.MacOS || platform== os.Windows);
  }

}

enum os { Unknown, Web, Android, Fuchsia, IOS, Linux, MacOS, Windows }

Anandh Krishnan · Accepted Answer · 2022-04-20 13:19:56Z

import 'dart:io' show Platform;

if (Platform.isAndroid) {
  // Android-specific code
} else if (Platform.isIOS) {
  // iOS-specific code
}else if (Platform.isFuchsia) {
  // Fuchsia-specific code
}else if (Platform.isLinux) {
  // Linux-specific code
}else if (Platform.isMacOS) {
  // MacOS-specific code
}else if (Platform.isWindows) {
  // Windows-specific code
}else if (Platform.isWindows) {
  // Windows-specific code
}

for web

import 'package:flutter/foundation.dart' show kIsWeb;

if (kIsWeb) {
  // running on the web!
} else {
  // NOT running on the web! You can check for additional platforms here.
}

Yunus Gedik · Accepted Answer · 2022-12-20 16:54:19Z

5

If you import both "dart:io" and "dart:html", it does not understand which Platform to import and gives error. So import one of them.

import 'dart:io';
Platform.isIOS ? CupertinoWidget() : MaterialWidget()

answered Dec 20, 2022 at 16:54

Yunus Gedik

1033 silver badges9 bronze badges

Add a comment |

bigzhu · Accepted Answer · 2023-11-24 03:51:31Z

import 'dart:io' show Platform;
import 'package:flutter/foundation.dart' show kIsWeb;

class PlatformUtil {
  static const bool isWeb = kIsWeb;

  static bool get isMobile {
    if (kIsWeb) {
      return false;
    } else {
      return Platform.isIOS || Platform.isAndroid;
    }
  }

  static bool get isDesktop {
    if (kIsWeb) {
      return false;
    } else {
      return Platform.isLinux || Platform.isFuchsia || Platform.isWindows || Platform.isMacOS;
    }
  }
}

Omar Khaled · Accepted Answer · 2024-01-06 08:39:40Z

EDITED

Since I have published the flutter_helper_utils package, and added all the boilerplate code in it. You can easily:

import 'package:flutter_helper_utils/flutter_helper_utils.dart';

context.isMobile;
context.isApple;
context.isIOS;
context.isMobileWeb;
context.isAndroidWeb;
// etc...

The package also provides a lot of helper functions and extensions.

Previous Answer:

You can add this extension to your project

import 'package:flutter/material.dart';

extension PlatformExtension on BuildContext {
  bool get isMobile =>
      Theme.of(this).platform == TargetPlatform.iOS ||
      Theme.of(this).platform == TargetPlatform.android;

  bool get isDesktop =>
      Theme.of(this).platform == TargetPlatform.macOS ||
      Theme.of(this).platform == TargetPlatform.windows ||
      Theme.of(this).platform == TargetPlatform.linux;
}

extension TargetPlatformExtension on TargetPlatform {
  bool get isMobile =>
      this == TargetPlatform.iOS || this == TargetPlatform.android;

  bool get isDesktop =>
      this == TargetPlatform.linux ||
      this == TargetPlatform.macOS ||
      this == TargetPlatform.windows;
}

Now you can access the host platform using.

BuildContext => context.isDesktop
TargetPlatform => defaultTargetPlatform.isDesktop

It is recommended to access the platform from context.

To detect if your app is running on browsers, you can use the kIsWeb constant from the foundation library.

import 'package:flutter/foundation.dart';

  log('$kIsWeb'); // will print true if the app is running on a browser

Note that if you are running a web app on a desktop, the isDesktop getter will return true, and same thing for mobile platforms. And to avoid that.

import 'package:flutter/foundation.dart';

  if (!kIsWeb && defaultTargetPlatform.isDesktop) {
    // do stuff for desktop apps only
  }

  if (!kIsWeb && defaultTargetPlatform.isMobile) {
    // do stuff for mobile apps only
  }

You can modify the extensions to get your preferred implementation.

mewadaarvind · Accepted Answer · 2022-08-10 12:49:49Z

**multiple platform you check and run your code according specific platform **

bool isIOS = Theme.of(context).platform == TargetPlatform.iOS;
bool isAndroid = Theme.of(context).platform == TargetPlatform.android;
bool islinux = Theme.of(context).platform == TargetPlatform.linux;
bool isfuchsia = Theme.of(context).platform == TargetPlatform.fuchsia;
bool isMacOS = Theme.of(context).platform == TargetPlatform.macOS;
bool iswindows = Theme.of(context).platform == TargetPlatform.windows;

Suragch · Accepted Answer · 2021-08-17 04:10:20Z

1

If you just need a string for logging purposes, you can use Platform.operatingSystem, which returns the OS name as a lowercase string.

import 'dart:io';
import 'package:flutter/foundation.dart';

String _getPlatform() {
  if (kIsWeb) return 'web';
  return Platform.operatingSystem;
}

answered Aug 17, 2021 at 4:10

Suragch

498k325 gold badges1.4k silver badges1.4k bronze badges

Until you try to use that during widget and goldens testing where we wrap the widget with MaterialApp and set the platform simulated through ThemeData platform property. Then it fails quite big!
– Fred Grott
Nov 14, 2023 at 15:05

Add a comment |

Emmanuel Ametepee · Accepted Answer · 2022-01-21 09:20:10Z

0

Checking Host Platform in Dart.

import 'dart:io' as IO;

_checkingHostPlatform(){
    if(IO.Platform.isAndroid){
      //Execute code for android
    }else if(IO.Platform.isIOS){
      //Execute code for iOS
    }else{
      //Execute code for other platforms
    }
  }

answered Jan 21, 2022 at 9:20

Emmanuel Ametepee

4956 silver badges2 bronze badges

Add a comment |

ahmnouira · Accepted Answer · 2023-01-29 10:59:51Z

This custom-created class will help you to detect the platform:

import 'package:flutter/foundation.dart'
    show defaultTargetPlatform, kIsWeb, TargetPlatform;

enum Os {
  web,
  android,
  ios,
  macOS,
  linux,
  windows,
  fuchsia,
}

class Platform {
  const Platform();

  /// Platform is Web.
  static bool get isWeb => os == Os.web;

  /// Platform is Android.
  static bool get isAndroid => os == Os.android;

  /// Platform is IOS.
  static bool get isIOS => os == Os.ios;

  /// Platform is Fuchsia.
  static bool get isFuchsia => os == Os.fuchsia;

  /// Platform is Linux.
  static bool get isLinux => os == Os.linux;

  /// Platform is MacOS.
  static bool get isMacOS => os == Os.macOS;

  /// Platform is Windows.
  static bool get isWindows => os == Os.windows;

  /// Platform is Android or IOS.
  static bool get isMobile => isAndroid || isIOS;

  /// Platform is Android or IOS or Fuchsia.
  static bool get isFullMobile => isMobile || isFuchsia;

  /// Platform is Linux or Windows or MacOS.
  static bool get isDesktop => isLinux || isWindows || isMacOS;

  /// Getting the os name.
  static Os get os {
    if (kIsWeb) {
      return Os.web;
    }
    switch (defaultTargetPlatform) {
      case TargetPlatform.android:
        return Os.android;
      case TargetPlatform.iOS:
        return Os.ios;
      case TargetPlatform.macOS:
        return Os.macOS;
      case TargetPlatform.windows:
        return Os.windows;
      case TargetPlatform.fuchsia:
        return Os.fuchsia;
      case TargetPlatform.linux:
        return Os.linux;
    }
  }
}

This is problematic, because web isn't entirely a seperate platform. Users can be on Android mobile and look at the site from their browsers, for example. — Valiumdiät, May 2, 2023 at 14:30

Arsham · Accepted Answer · 2023-12-04 14:12:37Z

Note most of the answers here are wrong due to:

defaultTargetPlatform is always set to android in unit testing and setting to something else always causes problems per the Flutter Docs explainations.
We always wrap widgets to golden, BDD, and widget test with a MaterialApp in which we set the ThemeData.platform property to simulate the target platfrom.

Thus the solution should be this:

import 'package:flutter/material.dart';

extension PlatformExtension on BuildContext {
  bool get isMobile =>
      Theme.of(this).platform == TargetPlatform.iOS ||
      Theme.of(this).platform == TargetPlatform.android ||
      Theme.of(this).platform == TargetPlatform.fuchsia;

  bool get isDesktop =>
      Theme.of(this).platform == TargetPlatform.macOS ||
      Theme.of(this).platform == TargetPlatform.windows ||
      Theme.of(this).platform == TargetPlatform.linux;
  
  bool get isIOS => Theme.of(this).platform == TargetPlatform.iOS;
  bool get isAndroid => Theme.of(this).platform == TargetPlatform.android;
  bool get isFuchsia => Theme.of(this).platform == TargetPlatform.fuchsia;
  bool get isLinux => Theme.of(this).platform == TargetPlatform.linux;
  bool get isWindows => Theme.of(this).platform == TargetPlatform.windows;
  bool get isMacOS => Theme.of(this).platform == TargetPlatform.macOS;
  
}

There is a growing list of Flutter Mentors on substack that do one day a week chats to answer questions such as this and that list is on the right side of my substack and my substack link is in my profile.

Harminder Singh · Accepted Answer · 2024-03-11 07:30:28Z

-2

Below two line will give you the name of OS.

import 'dart:io' as OS; //on top

OS.Platform.operatingSystem // use this to get name of OS

If you want checks based on OS use below properties:

OS.Platform.isAndroid
OS.Platform.isIOS

answered Mar 11 at 7:30

Harminder Singh

3221 silver badge11 bronze badges

Add a comment |

Collectives™ on Stack Overflow

How do you detect the host platform from Dart code?

23 Answers 23

Your Answer

Not the answer you're looking for? Browse other questions tagged
flutter
dart
host
or ask your own question.

Linked

Hot Network Questions

Collectives™ on Stack Overflow

23 Answers 23

Your Answer

Sign up or log in

Post as a guest

Not the answer you're looking for? Browse other questions tagged flutterdarthost or ask your own question.

Linked

Related

Not the answer you're looking for? Browse other questions tagged
flutter
dart
host
or ask your own question.