Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/plugfox/platform_info

Contains info about the current platform, such as Build mode and Operating system.
https://github.com/plugfox/platform_info

android angulardart cupertino dart desktop-device flutter fuchsia ios linux mac macos web wtfpl

Last synced: 12 days ago
JSON representation

Contains info about the current platform, such as Build mode and Operating system.

Host: GitHub
URL: https://github.com/plugfox/platform_info
Owner: PlugFox
License: mit
Created: 2020-04-22T10:46:14.000Z (over 4 years ago)
Default Branch: master
Last Pushed: 2024-08-13T14:27:37.000Z (3 months ago)
Last Synced: 2024-10-12T05:43:14.853Z (28 days ago)
Topics: android, angulardart, cupertino, dart, desktop-device, flutter, fuchsia, ios, linux, mac, macos, web, wtfpl
Language: Dart
Homepage: https://pub.dev/packages/platform_info
Size: 1.46 MB
Stars: 27
Watchers: 2
Forks: 3
Open Issues: 0
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE

Awesome Lists containing this project

README

        # platform_info

[![platform_info](https://img.shields.io/pub/v/platform_info.svg)](https://pub.dev/packages/platform_info)

[![Checkout](https://github.com/PlugFox/platform_info/actions/workflows/checkout.yml/badge.svg)](https://github.com/PlugFox/platform_info/actions/workflows/checkout.yml)

[![Coverage](https://codecov.io/gh/PlugFox/platform_info/branch/master/graph/badge.svg)](https://codecov.io/gh/PlugFox/platform_info)

[![License: MIT](https://img.shields.io/badge/license-MIT-purple.svg)](https://opensource.org/licenses/MIT)

[![Linter](https://img.shields.io/badge/style-linter-40c4ff.svg)](https://pub.dev/packages/linter)

[![GitHub stars](https://img.shields.io/github/stars/plugfox/platform_info?style=social)](https://github.com/plugfox/platform_info/)

## About

Cross-platform io/html package.

Works on the web, mobile phones, desktops and console.

Fully caches itself on first initialization.

Easy to use, just add to `pubspec.yaml` as dependency and then import:

`import 'package:platform_info/platform_info.dart';`

Platform is a singleton, and the default way to access an instance of Platform is to call static getters:

`Platform.instance` or `Platform.I` or `platform`

## Usage

![](example.png)

[Example of using the library](https://pub.dev/packages/platform_info/example) to get the current platform info

## Platform Information

Provides platform information such as:

- Build mode

  - release

  - profile

  - debug

- Host platform type

  - vm (io, desktops, mobile, console, server)

  - js (web, html, browser)

- Operating system

  - Fuchsia

  - Linux

  - MacOS

  - Windows

  - iOS

  - Android

  - Unknown

- Version (`unknown` if not available)

- Locale string (`en` if not available)

- The number of individual execution units of the machine (`0` if not available)

- Operating system is a known type

- Is a Web-based applications

- Is a VM supporting for non-web applications

- Is a mobile device (Android, iOS)

- Is a desktop device (Windows, macOS, Fuchsia)

- Is Material design device (Android, Fuchsia)

- Is Cupertino design device (macOS, iOS)

- is Linux

- is macOS

- is Windows

- is android

- is iOS

- is fuchsia

- `when` method allowing to compose a complex condition

## Pattern matching

Run functions that satisfy the current state of the platform.

You can use nested methods to compose more complex queries.

##### Operating System

[fuchsia] - whether the operating system is a version of Fuchsia

[windows] - whether the operating system is a version of Windows

[android] - whether the operating system is a version of Android

[iOS] - whether the operating system is a version of iOS

[macOS] - whether the operating system is a version of MacOS

[linux] - whether the operating system is a version of Linux

[unknown] - operating system unknown

##### Design

[material] - is material (Android, Fuchsia)

[cupertino] - is cupertino (macOS, iOS)

##### Mobile or desktop

[mobile] - is mobile device (Android, iOS)

[desktop] - is desktop device (Windows, MacOS, Fuchsia)

##### VM (IO) or JS (Web)

[js] - is web-based applications

[vm] - is I/O supporting for non-web applications

##### Build mode

[release] - release build mode

[profile] - profile build mode

[debug] - debug build mode

[orElse] - any callback was not called

##### Sequence of checks

1. Operating System

2. Design

3. Mobile/Desktop

4. VM/JS

5. Build mode

6. Call [orElse] if any callback was not called

## Coverage

[![](https://codecov.io/gh/PlugFox/platform_info/branch/master/graphs/sunburst.svg)](https://codecov.io/gh/PlugFox/platform_info/branch/master)

## Changelog

Refer to the [Changelog](https://github.com/plugfox/platform_info/blob/master/CHANGELOG.md) to get all release notes.

## Maintainers

[Plague Fox](https://plugfox.dev)

## Funding

If you want to support the development of our library, there are several ways you can do it:

- [Buy me a coffee](https://www.buymeacoffee.com/plugfox)

- [Support on Patreon](https://www.patreon.com/plugfox)

- [Subscribe through Boosty](https://boosty.to/plugfox)

We appreciate any form of support, whether it's a financial donation or just a star on GitHub. It helps us to continue developing and improving our library. Thank you for your support!

## License

[MIT](https://opensource.org/licenses/MIT)

## Tags

cross, platform, info