flutter_native_config 1.0.0

  • Readme
  • Changelog
  • Example
  • Installing
  • 50

flutter_native_config #

A plugin to access native configuration for both Android and iOS from Flutter.

For some third party integrations, for example Google and Facebook, the API keys are usually stored in the native realm -- namely AndroidManifest.xml and Info.plist -- and there's no way to access these values from Flutter. Until now, that it :)

This plugin allows you to access those values directly from Flutter so you don't have to include then in Dart code in addition to the native realm.

Usage #

Import package:flutter_native_config/flutter_native_config.dart, and use the public function FlutterNativeConfig.getConfig() to retrieve a value from both Android and iOS. Because most of the time the key names are different for these two platforms, the function accepts a separate key for each platform.

Example:

import 'package:flutter_native_config/flutter_native_config.dart';

Future<String> get appId {
  return FlutterNativeConfig.getConfig<String>(
    android: 'version_name',
    ios: 'CFBundleName',
  );
}

Future<String> get appVersion {
  return FlutterNativeConfig.getConfig<String>(
    android: 'version_code',
    ios: 'CFBundleShortVersionString',
  );
}

Future.wait([appId, appVersion]).then((result) {
  print('App: ${result[0]} v${result[1]}');
});

Issues #

For reporting bugs, incompatibilities, or feature requests, please submit a new issue.

Contributing #

If you wish to contribute a fix or a new feature, please submit a pr.

License #

This plugin is released under the MIT license.

1.0.0 #

  • Initial release with an API consisting of a single FlutterNativeConfig.getConfig() function.

example/README.md

flutter_native_config_example #

Demonstrates how to use the flutter_native_config plugin.

Getting Started #

This project is a starting point for a Flutter application.

A few resources to get you started if this is your first Flutter project:

For help getting started with Flutter, view our online documentation, which offers tutorials, samples, guidance on mobile development, and a full API reference.

Use this package as a library

1. Depend on it

Add this to your package's pubspec.yaml file:


dependencies:
  flutter_native_config: ^1.0.0

2. Install it

You can install packages from the command line:

with Flutter:


$ flutter pub get

Alternatively, your editor might support flutter pub get. Check the docs for your editor to learn more.

3. Import it

Now in your Dart code, you can use:


import 'package:flutter_native_config/flutter_native_config.dart';
  
Popularity:
Describes how popular the package is relative to other packages. [more]
0
Health:
Code health derived from static analysis. [more]
99
Maintenance:
Reflects how tidy and up-to-date the package is. [more]
100
Overall:
Weighted score of the above. [more]
50
Learn more about scoring.

We analyzed this package on Oct 22, 2019, and provided a score, details, and suggestions below. Analysis was completed with status completed using:

  • Dart: 2.5.1
  • pana: 0.12.21
  • Flutter: 1.9.1+hotfix.4

Platforms

Detected platforms: Flutter

References Flutter, and has no conflicting libraries.

Health issues and suggestions

Document public APIs. (-1 points)

4 out of 4 API elements have no dartdoc comment.Providing good documentation for libraries, classes, functions, and other API elements improves code readability and helps developers find and use your API.

Dependencies

Package Constraint Resolved Available
Direct dependencies
Dart SDK >=2.0.0 <3.0.0
flutter 0.0.0
Transitive dependencies
collection 1.14.11 1.14.12
meta 1.1.7
sky_engine 0.0.99
typed_data 1.1.6
vector_math 2.0.8
Dev dependencies
flutter_test