How to use flutter plugin, that I created, in my flutter app as local plugin

Question

I have created a flutter plugin for android and ios and I want to use that plugin in my flutter app locally. I don't want to upload it to pub.dev but to use it locally in my flutter app. I searched a bit and I found that I can use external packages locally but I didn't find anything about a plugin. These are directories under my plugin package all_pdf_tools:

Out of these which directory do I need to move to my flutter app directory and then how should I declare it to use it in my pubspec.yaml and then how can I use my plugin's methods in the flutter app.

Thank you.

Richard Heap · Accepted Answer · 2022-03-09 16:18:32Z

5

Make sure that your Flutter app and plugin are in sibling folders.

The add a dependency in pubspec.yaml of your Flutter app:

dependencies:
  all_pdf_tools:
    path: ../all_pdf_tools

This tells your Flutter project to look for your plugin at the relative path, rather than in pub or a local git repo.

(If you look in all_pdf_tools/example/pubspec.yaml you'll see this is how the example app refers to its plugin by using path: ../)

answered Mar 9, 2022 at 16:18

Richard Heap

52.1k11 gold badges143 silver badges118 bronze badges

Sign up to request clarification or add additional context in comments.

8 Comments

Martin Over a year ago

Means I'll have to copy paste this all_pdf_tools directory into my flutter app directory

Martin Over a year ago

Do I need these example and test directories?

Richard Heap Over a year ago

No - into an adjacent folder - e.g. /projects/my_app and /projects/my_plugin (and you can use a more complicated relative path if you want, too, if they aren't adjacent)

Richard Heap Over a year ago

import 'package:all_pdf_tools/all_pdf_tools.dart';

Martin Over a year ago

I will give it a try and will update you by tomorrow. Thank you.

|

Collectives™ on Stack Overflow

How to use flutter plugin, that I created, in my flutter app as local plugin

1 Answer 1

8 Comments

Your Answer

Hot Network Questions

Collectives™ on Stack Overflow

1 Answer 1

8 Comments

Your Answer

Sign up or log in

Post as a guest

Related