How to Create a Flutter Package: Step-by-Step Guide

To create a Flutter package, use the flutter create --template=package package_name command to generate the package structure. Then, add your Dart code inside the lib/ folder and manage dependencies in pubspec.yaml.

Syntax

The basic command to create a Flutter package is:

• flutter create --template=package package_name: Creates a new package project with the given name.
• lib/ folder: Place your Dart code here.
• pubspec.yaml: Manage package metadata and dependencies.

bash

flutter create --template=package my_flutter_package

Output

Creates a new Flutter package project named 'my_flutter_package' with standard package structure.

Example

This example shows creating a simple Flutter package that exports a greeting function.

dart

// Run this command to create the package
flutter create --template=package greeting_package

// lib/greeting_package.dart
String greet(String name) {
  return 'Hello, $name!';
}

// Usage in another Flutter app:
// import 'package:greeting_package/greeting_package.dart';
// print(greet('Alice'));

Output

Hello, Alice!

Common Pitfalls

Common mistakes when creating Flutter packages include:

• Not using the --template=package flag, which creates an app instead of a package.
• Placing code outside the lib/ folder, which prevents it from being accessible.
• Forgetting to update pubspec.yaml with correct package info and dependencies.
• Not testing the package by importing it in a sample app.

bash

Wrong:
flutter create my_package

Right:
flutter create --template=package my_package

Quick Reference

Summary tips for creating Flutter packages:

• Always use flutter create --template=package to start.
• Write reusable Dart code inside lib/.
• Keep pubspec.yaml updated with version and dependencies.
• Test your package by adding it as a dependency in a Flutter app.

Key Takeaways

Use the command flutter create --template=package package_name to create a Flutter package.

Place all reusable Dart code inside the lib/ folder for proper exporting.

Update pubspec.yaml with package details and dependencies before publishing.

Test your package by importing it into a Flutter app to ensure it works correctly.

Avoid creating an app project by forgetting the --template=package flag.