flutter_quick_look 0.0.1

  • Readme
  • Changelog
  • Example
  • Installing
  • 50

flutter_quick_look #

iOS Quick Look implementation on Flutter.

Usage #

You need to setup your root view controller as UINavigationController. Example :

// AppDelegate.swift

import UIKit
import Flutter

@UIApplicationMain
@objc class AppDelegate: FlutterAppDelegate {
  var navigationController: UINavigationController?;    
    
  override func application(
    _ application: UIApplication,
    didFinishLaunchingWithOptions launchOptions: [UIApplication.LaunchOptionsKey: Any]?
  ) -> Bool {
    let flutterViewController: FlutterViewController = window?.rootViewController as! FlutterViewController
    GeneratedPluginRegistrant.register(with: self)
    self.navigationController = UINavigationController(rootViewController: flutterViewController);
    self.navigationController?.setNavigationBarHidden(true, animated: false);
        
    self.window = UIWindow(frame: UIScreen.main.bounds);
    self.window.rootViewController = self.navigationController;
    self.window.makeKeyAndVisible();

    return super.application(application, didFinishLaunchingWithOptions: launchOptions)
  }
}

Import package:flutter_quick_look/flutter_quick_look.dart use FlutterQuickLook.openURL(filePath); to launch Quick Look

You will find the complete example in the example directory.

0.0.1 #

  • Initial release.

example/lib/main.dart

import 'dart:io';

import 'package:csv/csv.dart';
import 'package:flutter/foundation.dart';
import 'package:flutter/material.dart';
import 'package:flutter_quick_look/flutter_quick_look.dart';
import 'package:path_provider/path_provider.dart';

void main() => runApp(MyApp());

class MyApp extends StatefulWidget {
  @override
  _MyAppState createState() => _MyAppState();
}

class _MyAppState extends State<MyApp> {
  bool writing = false;  

  @override
  void initState() {
    super.initState();    
  }  

  writeCSV() async {
    if (defaultTargetPlatform  == TargetPlatform.iOS) {      
      const data = [
        ['O', 'X', 'X'],
        ['X', 'O', 'X'],
        ['X', 'X', 'O']
      ];

      String csv = const ListToCsvConverter().convert(data);
      String directory = (await getApplicationDocumentsDirectory()).path;
      var file = await File('$directory/test.csv').writeAsString(csv);
      await FlutterQuickLook.openURL(file.path);
      setState(() {        
        writing = false;  
      });
    } else {
      setState(() {
        writing = false;  
      });  
    }     
  }

  @override
  Widget build(BuildContext context) {     
    return MaterialApp(
      home: Scaffold(
        appBar: AppBar(
          title: const Text('Plugin example app'),
        ),
        body: Center(
          child: Text('Please press Open CSV button'),            
        ),
        persistentFooterButtons: <Widget>[
          writing ? Text('Writing') : RaisedButton(            
            onPressed: () {
              setState(() {
                writing = true;  
              });              
              writeCSV();
            },
            child: Text('Open CSV', style: TextStyle(color: Colors.black),),
          )
        ],
      ),
    );
  }
}

Use this package as a library

1. Depend on it

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


dependencies:
  flutter_quick_look: ^0.0.1

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_quick_look/flutter_quick_look.dart';
  
Popularity:
Describes how popular the package is relative to other packages. [more]
12
Health:
Code health derived from static analysis. [more]
99
Maintenance:
Reflects how tidy and up-to-date the package is. [more]
70
Overall:
Weighted score of the above. [more]
50
Learn more about scoring.

We analyzed this package on Mar 31, 2020, and provided a score, details, and suggestions below. Analysis was completed with status completed using:

  • Dart: 2.7.1
  • pana: 0.13.6
  • Flutter: 1.12.13+hotfix.8

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.

Format lib/flutter_quick_look.dart.

Run flutter format to format lib/flutter_quick_look.dart.

Maintenance suggestions

The package description is too short. (-20 points)

Add more detail to the description field of pubspec.yaml. Use 60 to 180 characters to describe the package, what it does, and its target use case.

Package is pre-v0.1 release. (-10 points)

While nothing is inherently wrong with versions of 0.0.*, it might mean that the author is still experimenting with the general direction of the API.

Dependencies

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