flutter_ssreadinglist 0.1.1

  • Readme
  • Changelog
  • Example
  • Installing
  • 48

SSReadingList #

IOS SSReadingList Api for Flutter. It gives access to SafariServices SSReadingList APIs so Flutter apps can easily add urls to Safari Reading List without having to open links in a Safari view.

Usage #

import 'package:flutter_ssreadinglist/flutter_ssreadinglist.dart';

myFunction() async {
    try {
      supported = await SSReadingList.supportsURL(
          Uri.parse("http://www.thisisgood.com"));
      await SSReadingList.addURL(
          url: Uri.parse("http://www.thisisgood.com"),
          title: "optional title",
          previewText: "optional text",
      );
    } on PlatformException {
      print("something is wrong");
    }
}

Please refer to Apple Documentation about SSReadingList API for more information. LINK

Supported Platform #

IOS 6+

License #

Apache 2.0

0.1.1 #

  • Update README to reflect the correct import path

0.1.0 #

  • Working initial version

example/lib/main.dart

import 'package:flutter/material.dart';
import 'dart:async';

import 'package:flutter/services.dart';
import 'package:flutter_ssreadinglist/flutter_ssreadinglist.dart';

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

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

class _MyAppState extends State<MyApp> {
  bool _supported;

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

  // Platform messages are asynchronous, so we initialize in an async method.
  Future<void> initPlatformState() async {
    bool supported;
    // Platform messages may fail, so we use a try/catch PlatformException.
    try {
      supported = await SSReadingList.supportsURL(
          Uri.parse("http://www.thisisgood.com"));
    } on PlatformException {
      print("something is wrong");
    }

    // If the widget was removed from the tree while the asynchronous platform
    // message was in flight, we want to discard the reply rather than calling
    // setState to update our non-existent appearance.
    if (!mounted) return;

    setState(() {
      _supported = supported;
    });
  }

  @override
  Widget build(BuildContext context) {
    return MaterialApp(
      home: Scaffold(
        appBar: AppBar(
          title: const Text('Plugin example app'),
        ),
        body: Center(
          child: FlatButton(
              child: Text(
                  'Safari Reading List is supported: ${_supported}\nTap to add a random url to reading list.'),
              onPressed: () async {
                try {
                  await SSReadingList.addURL(
                      Uri.parse("http://www.something.com"),
                      title: "Random Title", 
                      previewText: "This is a paragraph of random text. So you can get a brief idea of what this url is about",
                      );
                  print("done");
                } catch (err) {
                  print("$err");
                }
              }),
        ),
      ),
    );
  }
}

Use this package as a library

1. Depend on it

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


dependencies:
  flutter_ssreadinglist: ^0.1.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_ssreadinglist/flutter_ssreadinglist.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]
90
Overall:
Weighted score of the above. [more]
48
Learn more about scoring.

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

  • Dart: 2.8.4
  • pana: 0.13.9+1
  • Flutter: 1.17.3

Analysis suggestions

Package does not support Flutter platform linux

Because of import path [package:flutter_ssreadinglist/flutter_ssreadinglist.dart]

Package does not support Flutter platform macos

Because of import path [package:flutter_ssreadinglist/flutter_ssreadinglist.dart]

Package does not support Flutter platform web

Because of import path [package:flutter_ssreadinglist/flutter_ssreadinglist.dart]

Package does not support Flutter platform windows

Because of import path [package:flutter_ssreadinglist/flutter_ssreadinglist.dart]

Package not compatible with SDK dart

because of import path [flutter_ssreadinglist]

Health issues and suggestions

Document public APIs. (-1 points)

5 out of 5 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.

Maintenance suggestions

The description is too long. (-10 points)

Search engines display only the first part of the description. Try to keep the value of the description field in your package's pubspec.yaml file between 60 and 180 characters.

Dependencies

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