CINXE.COM

<!doctype html><html lang="en"><head><meta charset="utf-8"><title>Developing | Flutter</title><link rel="icon" href="/assets/images/branding/flutter/icon/64.png" eleventy:ignore><link rel="apple-touch-icon" href="/assets/images/branding/flutter/logo/flutter-logomark-320px.png" eleventy:ignore><meta name="viewport" content="width=device-width,initial-scale=1"><meta name="theme-color" content="#ffffff"><link rel="preconnect" href="https://fonts.googleapis.com"><link rel="preconnect" href="https://fonts.gstatic.com" crossorigin><meta name="google-site-verification" content="HFqxhSbf9YA_0rBglNLzDiWnrHiK_w4cqDh2YD2GEY4"><script>!function(e,t,a,n){e[n]=e[n]||[],e[n].push({"gtm.start":(new Date).getTime(),event:"gtm.js"});var g=t.getElementsByTagName(a)[0],m=t.createElement(a);m.async=!0,m.src="https://www.googletagmanager.com/gtm.js?id=GTM-ND4LWWZ",g.parentNode.insertBefore(m,g)}(window,document,"script","dataLayer")</script><script>!function(e,a,t,n,c,o,s){e.GoogleAnalyticsObject=c,e[c]=e[c]||function(){(e[c].q=e[c].q||[]).push(arguments)},e[c].l=1*new Date,o=a.createElement(t),s=a.getElementsByTagName(t)[0],o.async=1,o.src="//www.google-analytics.com/analytics.js",s.parentNode.insertBefore(o,s)}(window,document,"script",0,"ga"),ga("create","UA-67589403-1","auto"),ga("send","pageview")</script><meta name="description" content="How to write packages and plugins for Flutter."><meta name="twitter:card" content="summary_large_image"><meta name="twitter:site" content="@flutterdev"><meta property="og:title" content="Developing packages & plugins"><meta property="og:url" content="https://docs.flutter.dev/packages-and-plugins/developing-packages"><meta property="og:description" content="How to write packages and plugins for Flutter."><meta property="og:image" content="https://docs.flutter.dev/assets/images/flutter-logo-sharing.png" eleventy:ignore><link href="https://fonts.googleapis.com/css2?family=Google+Sans:wght@400;500;700&display=swap" rel="stylesheet"><link href="https://fonts.googleapis.com/css2?family=Google+Sans+Text:wght@400;500;700&display=swap" rel="stylesheet"><link href="https://fonts.googleapis.com/css2?family=Google+Sans+Mono:wght@400;500;700&display=swap" rel="stylesheet"><link href="https://fonts.googleapis.com/css2?family=Material+Symbols+Outlined:opsz,wght,FILL,GRAD@24,400,0,0" rel="stylesheet"><script>window.__CALLBACKS=[]</script><link rel="stylesheet" href="/assets/css/main.css?v=4"></head><body><section id="cookie-notice"><div class="container"><p>docs.flutter.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. <a href="https://policies.google.com/technologies/cookies" target="_blank" rel="noopener">Learn more</a>.</p><button id="cookie-consent" class="filled-button">OK, got it</button></div></section><noscript><iframe src="https://www.googletagmanager.com/ns.html?id=GTM-ND4LWWZ" height="0" width="0" style="display:none;visibility:hidden"></iframe></noscript><div id="site-banner" role="alert"><p>Flutter 3.29 is here with a bouquet of performance and fidelity improvements for your apps! <a href="https://medium.com/flutter/whats-new-in-flutter-3-29-f90c380c2317">Learn more</a><br></p></div><header class="site-header"><a href="#document-title" id="skip-to-main" class="filled-button" tabindex="1">Skip to main content</a><nav class="navbar"><div id="site-switcher" class="dropdown"><button class="dropdown-button site-wordmark" aria-expanded="false" aria-controls="site-switcher-menu" aria-label="Switch between Flutter and Dart sites"><img src="/assets/images/branding/flutter/logo/default.svg" alt="Flutter logo" width="28"> <span>Flutter</span> <span class="subtype">Docs</span> <span class="material-symbols" aria-hidden="true">unfold_more</span></button><div class="dropdown-content" id="site-switcher-menu"><nav class="dropdown-menu" role="menu"><ul><li role="presentation"><a href="https://flutter.dev" class="site-wordmark" role="menuitem" title="Flutter homepage" aria-label="Go to the Flutter homepage"><img src="/assets/images/branding/flutter/logo/default.svg" alt="Flutter logo" width="28"> <span>Flutter</span></a></li><li role="presentation"><a href="https://docs.flutter.dev" class="site-wordmark current-site" role="menuitem" aria-current="true" title="Flutter docs homepage" aria-label="Go to the Flutter docs homepage"><img src="/assets/images/branding/flutter/logo/default.svg" alt="Flutter logo" width="28"> <span>Flutter</span> <span class="subtype">Docs</span></a></li><li role="presentation"><a href="https://api.flutter.dev" class="site-wordmark" role="menuitem" title="Flutter API reference" aria-label="Go to the Flutter API reference"><img src="/assets/images/branding/flutter/logo/default.svg" alt="Flutter logo" width="28"> <span>Flutter</span> <span class="subtype">API</span></a></li><li aria-hidden="true" class="dropdown-divider" role="separator"></li><li role="presentation"><a href="https://dart.dev" class="site-wordmark" role="menuitem" title="Dart homepage" aria-label="Go to the Dart homepage"><img src="/assets/images/branding/dart/logo.svg" alt="Dart logo" width="28" height="28"> <span>Dart</span></a></li><li role="presentation"><a href="https://dartpad.dev" class="site-wordmark" role="menuitem" title="DartPad playground" aria-label="Go to the DartPad playground"><img src="/assets/images/branding/dart/logo.svg" alt="Dart logo" width="28" height="28"> <span>DartPad</span></a></li><li role="presentation"><a href="https://pub.dev" class="site-wordmark" role="menuitem" title="pub.dev homepage" aria-label="Go to the pub.dev homepage"><img src="/assets/images/branding/dart/logo.svg" alt="Dart logo" width="28" height="28"> <span>pub.dev</span></a></li></ul></nav></div></div><div class="navbar-contents"><ul class="navbar-nav"><li class="nav-item"><a class="nav-link" href="https://flutter.dev">Homepage</a></li><li class="nav-item"><a class="nav-link" href="https://flutter.dev/community">Community</a></li><li class="nav-item"><a class="nav-link" href="https://pub.dev">Packages</a></li><li class="nav-item"><a class="nav-link" href="https://api.flutter.dev">API reference</a></li></ul><form action="/search/" class="site-header__search"><input class="site-header__searchfield search-field" type="search" name="q" id="q" autocomplete="off" placeholder="Search" aria-label="Search"></form><a href="/search" id="fallback-search-button" class="icon-button" aria-label="Navigate to the docs search page." title="Navigate to the docs search page."><span class="material-symbols" aria-hidden="true">search</span> </a><a id="call-to-action" class="filled-button" href="/get-started/install/">Get started</a> <button id="menu-toggle" class="icon-button" type="button" aria-controls="sidenav" aria-label="Toggle navigation" title="Toggle navigation"><span class="material-symbols" aria-hidden="true">menu</span></button></div></nav></header><div id="site-below-header"><div id="site-main-row"><div id="sidenav" class="site-sidebar"><nav><ul><li class="nav-header">Get started</li><li class="nav-item"><a class="nav-link" href="/get-started/install"><div><span>Set up Flutter</span></div></a></li><li class="nav-item"><button class="nav-link collapsed collapsible" data-toggle="collapse" data-target="#sidenav-3" role="button" aria-expanded="false" aria-controls="sidenav-3"><span>Learn Flutter</span> <span class="material-symbols expander" aria-hidden="true">expand_more</span></button><ul class="nav collapse" id="sidenav-3"><li class="nav-item"><a class="nav-link" href="/get-started/learn-flutter"><div><span>Introduction</span></div></a></li><li class="nav-item"><a class="nav-link" href="/get-started/codelab"><div><span>Write your first app</span></div></a></li><li class="nav-item"><button class="nav-link collapsible" data-toggle="collapse" data-target="#sidenav-3-3" role="button" aria-expanded="true" aria-controls="sidenav-3-3"><span>Learn the fundamentals</span> <span class="material-symbols expander" aria-hidden="true">expand_more</span></button><ul class="nav collapse show" id="sidenav-3-3"><li class="nav-item"><a class="nav-link" href="/get-started/fundamentals"><div><span>Introduction</span></div></a></li><li class="nav-item"><a class="nav-link" href="/get-started/fundamentals/dart"><div><span>Intro to Dart</span></div></a></li><li class="nav-item"><a class="nav-link" href="/get-started/fundamentals/widgets"><div><span>Widgets</span></div></a></li><li class="nav-item"><a class="nav-link" href="/get-started/fundamentals/layout"><div><span>Layout</span></div></a></li><li class="nav-item"><a class="nav-link" href="/get-started/fundamentals/state-management"><div><span>State management</span></div></a></li><li class="nav-item"><a class="nav-link" href="/get-started/fundamentals/user-input"><div><span>Handling user input</span></div></a></li><li class="nav-item"><a class="nav-link" href="/get-started/fundamentals/networking"><div><span>Networking and data</span></div></a></li><li class="nav-item"><a class="nav-link" href="/get-started/fundamentals/local-caching"><div><span>Local data and caching</span></div></a></li></ul></li><li class="nav-item"><button class="nav-link collapsible collapsed" data-toggle="collapse" data-target="#sidenav-3-4" role="button" aria-expanded="false" aria-controls="sidenav-3-4"><span>From another platform?</span> <span class="material-symbols expander" aria-hidden="true">expand_more</span></button><ul class="nav collapse" id="sidenav-3-4"><li class="nav-item"><a class="nav-link" href="/get-started/flutter-for/android-devs"><div><span>Flutter for Android devs</span></div></a></li><li class="nav-item"><a class="nav-link" href="/get-started/flutter-for/compose-devs"><div><span>Flutter for Jetpack Compose devs</span></div></a></li><li class="nav-item"><a class="nav-link" href="/get-started/flutter-for/swiftui-devs"><div><span>Flutter for SwiftUI devs</span></div></a></li><li class="nav-item"><a class="nav-link" href="/get-started/flutter-for/uikit-devs"><div><span>Flutter for UIKit devs</span></div></a></li><li class="nav-item"><a class="nav-link" href="/get-started/flutter-for/react-native-devs"><div><span>Flutter for React Native devs</span></div></a></li><li class="nav-item"><a class="nav-link" href="/get-started/flutter-for/web-devs"><div><span>Flutter for web devs</span></div></a></li><li class="nav-item"><a class="nav-link" href="/get-started/flutter-for/xamarin-forms-devs"><div><span>Flutter for Xamarin.Forms devs</span></div></a></li><li class="nav-item"><a class="nav-link" href="/get-started/flutter-for/declarative"><div><span>Introduction to declarative UI</span></div></a></li><li class="nav-item"><a class="nav-link" href="/get-started/flutter-for/dart-swift-concurrency"><div><span>Flutter versus Swift concurrency</span></div></a></li></ul></li><div class="sidenav-divider"></div><li class="nav-item"><a class="nav-link" href="/codelabs"><div><span>Codelabs</span></div></a></li><li class="nav-item"><a class="nav-link" href="/cookbook"><div><span>Cookbook</span></div></a></li><li class="nav-item"><a class="nav-link" href="https://github.com/flutter/samples" target="_blank" rel="noopener"><div><span>Demos and samples</span><span class="material-symbols" aria-hidden="true">open_in_new</span></div></a></li></ul></li><li class="nav-item"><button class="nav-link collapsed collapsible" data-toggle="collapse" data-target="#sidenav-4" role="button" aria-expanded="false" aria-controls="sidenav-4"><span>Stay up to date</span> <span class="material-symbols expander" aria-hidden="true">expand_more</span></button><ul class="nav collapse" id="sidenav-4"><li class="nav-item"><a class="nav-link" href="/release/upgrade"><div><span>Upgrade</span></div></a></li><li class="nav-item"><a class="nav-link" href="/release/archive"><div><span>SDK archive</span></div></a></li><div class="sidenav-divider"></div><li class="nav-item"><a class="nav-link" href="/release/whats-new"><div><span>What's new</span></div></a></li><li class="nav-item"><a class="nav-link" href="/release/release-notes"><div><span>Release notes</span></div></a></li><li class="nav-item"><a class="nav-link" href="/release/breaking-changes"><div><span>Breaking changes</span></div></a></li><li class="nav-item"><a class="nav-link" href="/release/compatibility-policy"><div><span>Compatibility policy</span></div></a></li></ul></li><li class="nav-item"><button class="nav-link collapsed collapsible" data-toggle="collapse" data-target="#sidenav-5" role="button" aria-expanded="false" aria-controls="sidenav-5"><span>App solutions</span> <span class="material-symbols expander" aria-hidden="true">expand_more</span></button><ul class="nav collapse" id="sidenav-5"><li class="nav-item"><button class="nav-link collapsible collapsed" data-toggle="collapse" data-target="#sidenav-5-1" role="button" aria-expanded="false" aria-controls="sidenav-5-1"><span>AI</span> <span class="material-symbols expander" aria-hidden="true">expand_more</span></button><ul class="nav collapse" id="sidenav-5-1"><li class="nav-item"><button class="nav-link collapsible collapsed" data-toggle="collapse" data-target="#sidenav-5-1-1" role="button" aria-expanded="false" aria-controls="sidenav-5-1-1"><span>AI Toolkit guide</span> <span class="material-symbols expander" aria-hidden="true">expand_more</span></button><ul class="nav collapse" id="sidenav-5-1-1"><li class="nav-item"><a class="nav-link" href="/ai-toolkit"><div><span>Overview</span></div></a></li><li class="nav-item"><a class="nav-link" href="/ai-toolkit/user-experience"><div><span>User experience</span></div></a></li><li class="nav-item"><a class="nav-link" href="/ai-toolkit/feature-integration"><div><span>Feature integration</span></div></a></li><li class="nav-item"><a class="nav-link" href="/ai-toolkit/custom-llm-providers"><div><span>Custom LLM providers</span></div></a></li><li class="nav-item"><a class="nav-link" href="/ai-toolkit/chat-client-sample"><div><span>Chat client sample</span></div></a></li></ul></li><li class="nav-item"><a class="nav-link" href="https://www.youtube.com/watch?v=1AuzJEiHjO4" target="_blank" rel="noopener"><div><span>Build with Google AI Dart SDK (video)</span><span class="material-symbols" aria-hidden="true">open_in_new</span></div></a></li></ul></li><li class="nav-item"><button class="nav-link collapsible collapsed" data-toggle="collapse" data-target="#sidenav-5-2" role="button" aria-expanded="false" aria-controls="sidenav-5-2"><span>Firebase & Firestore</span> <span class="material-symbols expander" aria-hidden="true">expand_more</span></button><ul class="nav collapse" id="sidenav-5-2"><li class="nav-item"><a class="nav-link" href="/data-and-backend/firebase"><div><span>Overview</span></div></a></li><li class="nav-item"><a class="nav-link" href="https://firebase.google.com/docs/flutter" target="_blank" rel="noopener"><div><span>Discover Firebase for Flutter</span><span class="material-symbols" aria-hidden="true">open_in_new</span></div></a></li><li class="nav-item"><a class="nav-link" href="https://www.youtube.com/watch?v=wUSkeTaBonA" target="_blank" rel="noopener"><div><span>Get to know Firebase for Flutter</span><span class="material-symbols" aria-hidden="true">open_in_new</span></div></a></li><li class="nav-item"><a class="nav-link" href="https://firebase.google.com/codelabs/firebase-auth-in-flutter-apps" target="_blank" rel="noopener"><div><span>Add a user authentication flow to a Flutter app using FirebaseUI</span><span class="material-symbols" aria-hidden="true">open_in_new</span></div></a></li><li class="nav-item"><a class="nav-link" href="https://firebase.google.com/codelabs/firebase-get-to-know-web" target="_blank" rel="noopener"><div><span>Get to know Firebase for web</span><span class="material-symbols" aria-hidden="true">open_in_new</span></div></a></li></ul></li><li class="nav-item"><button class="nav-link collapsible collapsed" data-toggle="collapse" data-target="#sidenav-5-3" role="button" aria-expanded="false" aria-controls="sidenav-5-3"><span>Games</span> <span class="material-symbols expander" aria-hidden="true">expand_more</span></button><ul class="nav collapse" id="sidenav-5-3"><li class="nav-item"><a class="nav-link" href="/resources/games-toolkit"><div><span>Overview</span></div></a></li><li class="nav-item"><a class="nav-link" href="/cookbook/games/achievements-leaderboard"><div><span>Add achievements and leaderboards</span></div></a></li><li class="nav-item"><a class="nav-link" href="https://firebase.google.com/codelabs/build-leaderboards-with-firestore#0" target="_blank" rel="noopener"><div><span>Build leaderboards with Firestore</span><span class="material-symbols" aria-hidden="true">open_in_new</span></div></a></li><li class="nav-item"><a class="nav-link" href="/cookbook/plugins/google-mobile-ads"><div><span>Add advertising</span></div></a></li><li class="nav-item"><a class="nav-link" href="/cookbook/games/firestore-multiplayer"><div><span>Add multiplayer support</span></div></a></li><li class="nav-item"><a class="nav-link" href="https://codelabs.developers.google.com/codelabs/flutter-in-app-purchases" target="_blank" rel="noopener"><div><span>Add in-app purchases</span><span class="material-symbols" aria-hidden="true">open_in_new</span></div></a></li><li class="nav-item"><a class="nav-link" href="https://firebase.google.com/codelabs/firebase-auth-in-flutter-apps" target="_blank" rel="noopener"><div><span>Add user authentication</span><span class="material-symbols" aria-hidden="true">open_in_new</span></div></a></li><li class="nav-item"><a class="nav-link" href="https://firebase.google.com/docs/crashlytics/get-started?platform=flutter" target="_blank" rel="noopener"><div><span>Debug using Crashlytics</span><span class="material-symbols" aria-hidden="true">open_in_new</span></div></a></li><li class="nav-item"><a class="nav-link" href="https://codelabs.developers.google.com/codelabs/flutter-flame-brick-breaker" target="_blank" rel="noopener"><div><span>Intro to Flame with Flutter</span><span class="material-symbols" aria-hidden="true">open_in_new</span></div></a></li></ul></li><li class="nav-item"><button class="nav-link collapsible collapsed" data-toggle="collapse" data-target="#sidenav-5-4" role="button" aria-expanded="false" aria-controls="sidenav-5-4"><span>Monetization</span> <span class="material-symbols expander" aria-hidden="true">expand_more</span></button><ul class="nav collapse" id="sidenav-5-4"><li class="nav-item"><button class="nav-link collapsible collapsed" data-toggle="collapse" data-target="#sidenav-5-4-1" role="button" aria-expanded="false" aria-controls="sidenav-5-4-1"><span>Advertising</span> <span class="material-symbols expander" aria-hidden="true">expand_more</span></button><ul class="nav collapse" id="sidenav-5-4-1"><li class="nav-item"><a class="nav-link" href="/resources/ads-overview"><div><span>Ads overview</span></div></a></li><li class="nav-item"><a class="nav-link" href="/cookbook/plugins/google-mobile-ads"><div><span>Add advertising</span></div></a></li><li class="nav-item"><a class="nav-link" href="https://codelabs.developers.google.com/codelabs/admob-ads-in-flutter" target="_blank" rel="noopener"><div><span>Add AdMob ads to your Flutter app</span><span class="material-symbols" aria-hidden="true">open_in_new</span></div></a></li><li class="nav-item"><a class="nav-link" href="https://codelabs.developers.google.com/codelabs/admob-inline-ads-in-flutter" target="_blank" rel="noopener"><div><span>Add an AdMob banner and native inline ads</span><span class="material-symbols" aria-hidden="true">open_in_new</span></div></a></li><li class="nav-item"><a class="nav-link" href="https://developers.google.com/admob/flutter/mediation" target="_blank" rel="noopener"><div><span>Google AdMob mediation</span><span class="material-symbols" aria-hidden="true">open_in_new</span></div></a></li><li class="nav-item"><a class="nav-link" href="https://pub.dev/packages/interactive_media_ads" target="_blank" rel="noopener"><div><span>Interactive Media Ads SDK</span><span class="material-symbols" aria-hidden="true">open_in_new</span></div></a></li></ul></li><li class="nav-item"><button class="nav-link collapsible collapsed" data-toggle="collapse" data-target="#sidenav-5-4-2" role="button" aria-expanded="false" aria-controls="sidenav-5-4-2"><span>In-app purchases</span> <span class="material-symbols expander" aria-hidden="true">expand_more</span></button><ul class="nav collapse" id="sidenav-5-4-2"><li class="nav-item"><a class="nav-link" href="/resources/in-app-purchases-overview"><div><span>In-app purchases overview</span></div></a></li><li class="nav-item"><a class="nav-link" href="https://codelabs.developers.google.com/codelabs/flutter-in-app-purchases" target="_blank" rel="noopener"><div><span>Add in-app purchases</span><span class="material-symbols" aria-hidden="true">open_in_new</span></div></a></li></ul></li><li class="nav-item"><button class="nav-link collapsible collapsed" data-toggle="collapse" data-target="#sidenav-5-4-3" role="button" aria-expanded="false" aria-controls="sidenav-5-4-3"><span>Payments</span> <span class="material-symbols expander" aria-hidden="true">expand_more</span></button><ul class="nav collapse" id="sidenav-5-4-3"><li class="nav-item"><a class="nav-link" href="/resources/payments-overview"><div><span>Payments overview</span></div></a></li><li class="nav-item"><a class="nav-link" href="https://pub.dev/packages/pay" target="_blank" rel="noopener"><div><span>Google pay package</span><span class="material-symbols" aria-hidden="true">open_in_new</span></div></a></li></ul></li></ul></li><li class="nav-item"><button class="nav-link collapsible collapsed" data-toggle="collapse" data-target="#sidenav-5-5" role="button" aria-expanded="false" aria-controls="sidenav-5-5"><span>Maps</span> <span class="material-symbols expander" aria-hidden="true">expand_more</span></button><ul class="nav collapse" id="sidenav-5-5"><li class="nav-item"><a class="nav-link" href="https://codelabs.developers.google.com/codelabs/google-maps-in-flutter" target="_blank" rel="noopener"><div><span>Add Google maps to a Flutter app</span><span class="material-symbols" aria-hidden="true">open_in_new</span></div></a></li><li class="nav-item"><a class="nav-link" href="https://developers.google.com/maps/flutter-package" target="_blank" rel="noopener"><div><span>Google Maps package</span><span class="material-symbols" aria-hidden="true">open_in_new</span></div></a></li></ul></li><li class="nav-item"><button class="nav-link collapsible collapsed" data-toggle="collapse" data-target="#sidenav-5-6" role="button" aria-expanded="false" aria-controls="sidenav-5-6"><span>News</span> <span class="material-symbols expander" aria-hidden="true">expand_more</span></button><ul class="nav collapse" id="sidenav-5-6"><li class="nav-item"><a class="nav-link" href="/resources/news-toolkit"><div><span>Build a news app</span></div></a></li></ul></li></ul></li><li aria-hidden="true"><div class="sidenav-divider"></div></li><li class="nav-header">User interface</li><li class="nav-item"><a class="nav-link" href="/ui"><div><span>Introduction</span></div></a></li><li class="nav-item"><a class="nav-link" href="/ui/widgets"><div><span>Widget catalog</span></div></a></li><li class="nav-item"><button class="nav-link collapsed collapsible" data-toggle="collapse" data-target="#sidenav-10" role="button" aria-expanded="false" aria-controls="sidenav-10"><span>Layout</span> <span class="material-symbols expander" aria-hidden="true">expand_more</span></button><ul class="nav collapse" id="sidenav-10"><li class="nav-item"><a class="nav-link" href="/ui/layout"><div><span>Introduction</span></div></a></li><li class="nav-item"><a class="nav-link" href="/ui/layout/tutorial"><div><span>Build a layout</span></div></a></li><li class="nav-item"><button class="nav-link collapsible collapsed" data-toggle="collapse" data-target="#sidenav-10-3" role="button" aria-expanded="false" aria-controls="sidenav-10-3"><span>Lists & grids</span> <span class="material-symbols expander" aria-hidden="true">expand_more</span></button><ul class="nav collapse" id="sidenav-10-3"><li class="nav-item"><a class="nav-link" href="/cookbook/lists/basic-list"><div><span>Create and use lists</span></div></a></li><li class="nav-item"><a class="nav-link" href="/cookbook/lists/horizontal-list"><div><span>Create a horizontal list</span></div></a></li><li class="nav-item"><a class="nav-link" href="/cookbook/lists/grid-lists"><div><span>Create a grid view</span></div></a></li><li class="nav-item"><a class="nav-link" href="/cookbook/lists/mixed-list"><div><span>Create lists with different types of items</span></div></a></li><li class="nav-item"><a class="nav-link" href="/cookbook/lists/spaced-items"><div><span>Create lists with spaced items</span></div></a></li><li class="nav-item"><a class="nav-link" href="/cookbook/lists/long-lists"><div><span>Work with long lists</span></div></a></li></ul></li><li class="nav-item"><button class="nav-link collapsible collapsed" data-toggle="collapse" data-target="#sidenav-10-4" role="button" aria-expanded="false" aria-controls="sidenav-10-4"><span>Scrolling</span> <span class="material-symbols expander" aria-hidden="true">expand_more</span></button><ul class="nav collapse" id="sidenav-10-4"><li class="nav-item"><a class="nav-link" href="/ui/layout/scrolling"><div><span>Overview</span></div></a></li><li class="nav-item"><a class="nav-link" href="/ui/layout/scrolling/slivers"><div><span>Use slivers to achieve fancy scrolling</span></div></a></li><li class="nav-item"><a class="nav-link" href="/cookbook/lists/floating-app-bar"><div><span>Place a floating app bar above a list</span></div></a></li><li class="nav-item"><a class="nav-link" href="/cookbook/effects/parallax-scrolling"><div><span>Create a scrolling parallax effect</span></div></a></li></ul></li></ul></li><li class="nav-item"><button class="nav-link collapsed collapsible" data-toggle="collapse" data-target="#sidenav-11" role="button" aria-expanded="false" aria-controls="sidenav-11"><span>Adaptive & responsive design</span> <span class="material-symbols expander" aria-hidden="true">expand_more</span></button><ul class="nav collapse" id="sidenav-11"><li class="nav-item"><a class="nav-link" href="/ui/adaptive-responsive"><div><span>Overview</span></div></a></li><li class="nav-item"><a class="nav-link" href="/ui/adaptive-responsive/general"><div><span>General approach</span></div></a></li><li class="nav-item"><a class="nav-link" href="/ui/adaptive-responsive/safearea-mediaquery"><div><span>SafeArea & MediaQuery</span></div></a></li><li class="nav-item"><a class="nav-link" href="/ui/adaptive-responsive/large-screens"><div><span>Large screens & foldables</span></div></a></li><li class="nav-item"><a class="nav-link" href="/ui/adaptive-responsive/input"><div><span>User input & accessibility</span></div></a></li><li class="nav-item"><a class="nav-link" href="/ui/adaptive-responsive/capabilities"><div><span>Capabilities & policies</span></div></a></li><li class="nav-item"><a class="nav-link" href="/ui/adaptive-responsive/platform-adaptations"><div><span>Automatic platform adaptations</span></div></a></li><li class="nav-item"><a class="nav-link" href="/ui/adaptive-responsive/best-practices"><div><span>Best practices</span></div></a></li><li class="nav-item"><a class="nav-link" href="/ui/adaptive-responsive/more-info"><div><span>Additional resources</span></div></a></li></ul></li><li class="nav-item"><button class="nav-link collapsed collapsible" data-toggle="collapse" data-target="#sidenav-12" role="button" aria-expanded="false" aria-controls="sidenav-12"><span>Design & theming</span> <span class="material-symbols expander" aria-hidden="true">expand_more</span></button><ul class="nav collapse" id="sidenav-12"><li class="nav-item"><a class="nav-link" href="/cookbook/design/themes"><div><span>Share styles with themes</span></div></a></li><li class="nav-item"><a class="nav-link" href="/ui/design/material"><div><span>Material design</span></div></a></li><li class="nav-item"><a class="nav-link" href="/release/breaking-changes/material-3-migration"><div><span>Migrate to Material 3</span></div></a></li><li class="nav-item"><button class="nav-link collapsible collapsed" data-toggle="collapse" data-target="#sidenav-12-4" role="button" aria-expanded="false" aria-controls="sidenav-12-4"><span>Text</span> <span class="material-symbols expander" aria-hidden="true">expand_more</span></button><ul class="nav collapse" id="sidenav-12-4"><li class="nav-item"><a class="nav-link" href="/ui/design/text/typography"><div><span>Fonts & typography</span></div></a></li><li class="nav-item"><a class="nav-link" href="/cookbook/design/fonts"><div><span>Use a custom font</span></div></a></li><li class="nav-item"><a class="nav-link" href="/cookbook/design/package-fonts"><div><span>Export fonts from a package</span></div></a></li><li class="nav-item"><a class="nav-link" href="https://pub.dev/packages/google_fonts" target="_blank" rel="noopener"><div><span>Google Fonts package</span><span class="material-symbols" aria-hidden="true">open_in_new</span></div></a></li></ul></li><li class="nav-item"><button class="nav-link collapsible collapsed" data-toggle="collapse" data-target="#sidenav-12-5" role="button" aria-expanded="false" aria-controls="sidenav-12-5"><span>Custom graphics</span> <span class="material-symbols expander" aria-hidden="true">expand_more</span></button><ul class="nav collapse" id="sidenav-12-5"><li class="nav-item"><a class="nav-link" href="/ui/design/graphics/fragment-shaders"><div><span>Use custom fragment shaders</span></div></a></li></ul></li></ul></li><li class="nav-item"><button class="nav-link collapsed collapsible" data-toggle="collapse" data-target="#sidenav-13" role="button" aria-expanded="false" aria-controls="sidenav-13"><span>Interactivity</span> <span class="material-symbols expander" aria-hidden="true">expand_more</span></button><ul class="nav collapse" id="sidenav-13"><li class="nav-item"><a class="nav-link" href="/ui/interactivity"><div><span>Add interactivity to your app</span></div></a></li><li class="nav-item"><button class="nav-link collapsible collapsed" data-toggle="collapse" data-target="#sidenav-13-2" role="button" aria-expanded="false" aria-controls="sidenav-13-2"><span>Gestures</span> <span class="material-symbols expander" aria-hidden="true">expand_more</span></button><ul class="nav collapse" id="sidenav-13-2"><li class="nav-item"><a class="nav-link" href="/ui/interactivity/gestures"><div><span>Introduction</span></div></a></li><li class="nav-item"><a class="nav-link" href="/cookbook/gestures/handling-taps"><div><span>Handle taps</span></div></a></li><li class="nav-item"><a class="nav-link" href="/ui/interactivity/gestures/drag-outside"><div><span>Drag an object outside an app</span></div></a></li><li class="nav-item"><a class="nav-link" href="/cookbook/effects/drag-a-widget"><div><span>Drag a UI element within an app</span></div></a></li><li class="nav-item"><a class="nav-link" href="/cookbook/gestures/ripples"><div><span>Add Material touch ripples</span></div></a></li><li class="nav-item"><a class="nav-link" href="/cookbook/gestures/dismissible"><div><span>Implement swipe to dismiss</span></div></a></li></ul></li><li class="nav-item"><button class="nav-link collapsible collapsed" data-toggle="collapse" data-target="#sidenav-13-3" role="button" aria-expanded="false" aria-controls="sidenav-13-3"><span>Input & forms</span> <span class="material-symbols expander" aria-hidden="true">expand_more</span></button><ul class="nav collapse" id="sidenav-13-3"><li class="nav-item"><a class="nav-link" href="/cookbook/forms/text-input"><div><span>Create and style a text field</span></div></a></li><li class="nav-item"><a class="nav-link" href="/cookbook/forms/retrieve-input"><div><span>Retrieve the value of a text field</span></div></a></li><li class="nav-item"><a class="nav-link" href="/cookbook/forms/text-field-changes"><div><span>Handle changes to a text field</span></div></a></li><li class="nav-item"><a class="nav-link" href="/cookbook/forms/focus"><div><span>Manage focus in text fields</span></div></a></li><li class="nav-item"><a class="nav-link" href="/cookbook/forms/validation"><div><span>Build a form with validation</span></div></a></li></ul></li><li class="nav-item"><a class="nav-link" href="/cookbook/design/snackbars"><div><span>Display a snackbar</span></div></a></li><li class="nav-item"><a class="nav-link" href="/ui/interactivity/actions-and-shortcuts"><div><span>Implement actions & shortcuts</span></div></a></li><li class="nav-item"><a class="nav-link" href="/ui/interactivity/focus"><div><span>Manage keyboard focus</span></div></a></li></ul></li><li class="nav-item"><button class="nav-link collapsed collapsible" data-toggle="collapse" data-target="#sidenav-14" role="button" aria-expanded="false" aria-controls="sidenav-14"><span>Assets & media</span> <span class="material-symbols expander" aria-hidden="true">expand_more</span></button><ul class="nav collapse" id="sidenav-14"><li class="nav-item"><a class="nav-link" href="/ui/assets/assets-and-images"><div><span>Add assets and images</span></div></a></li><li class="nav-item"><a class="nav-link" href="/cookbook/images/network-image"><div><span>Display images from the internet</span></div></a></li><li class="nav-item"><a class="nav-link" href="/cookbook/images/fading-in-images"><div><span>Fade in images with a placeholder</span></div></a></li><li class="nav-item"><a class="nav-link" href="/cookbook/plugins/play-video"><div><span>Play and pause a video</span></div></a></li><li class="nav-item"><a class="nav-link" href="/ui/assets/asset-transformation"><div><span>Transform assets at build time</span></div></a></li></ul></li><li class="nav-item"><button class="nav-link collapsed collapsible" data-toggle="collapse" data-target="#sidenav-15" role="button" aria-expanded="false" aria-controls="sidenav-15"><span>Navigation & routing</span> <span class="material-symbols expander" aria-hidden="true">expand_more</span></button><ul class="nav collapse" id="sidenav-15"><li class="nav-item"><a class="nav-link" href="/ui/navigation"><div><span>Overview</span></div></a></li><li class="nav-item"><a class="nav-link" href="/cookbook/design/tabs"><div><span>Add tabs to your app</span></div></a></li><li class="nav-item"><a class="nav-link" href="/cookbook/navigation/navigation-basics"><div><span>Navigate to a new screen and back</span></div></a></li><li class="nav-item"><a class="nav-link" href="/cookbook/navigation/passing-data"><div><span>Send data to a new screen</span></div></a></li><li class="nav-item"><a class="nav-link" href="/cookbook/navigation/returning-data"><div><span>Return data from a screen</span></div></a></li><li class="nav-item"><a class="nav-link" href="/cookbook/design/drawer"><div><span>Add a drawer to a screen</span></div></a></li><li class="nav-item"><a class="nav-link" href="/ui/navigation/deep-linking"><div><span>Set up deep linking</span></div></a></li><li class="nav-item"><a class="nav-link" href="/cookbook/navigation/set-up-app-links"><div><span>Set up app links for Android</span></div></a></li><li class="nav-item"><a class="nav-link" href="/cookbook/navigation/set-up-universal-links"><div><span>Set up universal links for iOS</span></div></a></li><li class="nav-item"><a class="nav-link" href="/ui/navigation/url-strategies"><div><span>Configure web URL strategies</span></div></a></li></ul></li><li class="nav-item"><button class="nav-link collapsed collapsible" data-toggle="collapse" data-target="#sidenav-16" role="button" aria-expanded="false" aria-controls="sidenav-16"><span>Animations & transitions</span> <span class="material-symbols expander" aria-hidden="true">expand_more</span></button><ul class="nav collapse" id="sidenav-16"><li class="nav-item"><a class="nav-link" href="/ui/animations"><div><span>Introduction</span></div></a></li><li class="nav-item"><a class="nav-link" href="/ui/animations/tutorial"><div><span>Tutorial</span></div></a></li><li class="nav-item"><a class="nav-link" href="/ui/animations/implicit-animations"><div><span>Implicit animations</span></div></a></li><li class="nav-item"><a class="nav-link" href="/cookbook/animation/animated-container"><div><span>Animate the properties of a container</span></div></a></li><li class="nav-item"><a class="nav-link" href="/cookbook/animation/opacity-animation"><div><span>Fade a widget in and out</span></div></a></li><li class="nav-item"><a class="nav-link" href="/ui/animations/hero-animations"><div><span>Hero animations</span></div></a></li><li class="nav-item"><a class="nav-link" href="/cookbook/animation/page-route-animation"><div><span>Animate a page route transition</span></div></a></li><li class="nav-item"><a class="nav-link" href="/cookbook/animation/physics-simulation"><div><span>Animate using a physics simulation</span></div></a></li><li class="nav-item"><a class="nav-link" href="/ui/animations/staggered-animations"><div><span>Staggered animations</span></div></a></li><li class="nav-item"><a class="nav-link" href="/cookbook/effects/staggered-menu-animation"><div><span>Create a staggered menu animation</span></div></a></li><li class="nav-item"><a class="nav-link" href="/ui/animations/overview"><div><span>API overview</span></div></a></li></ul></li><li class="nav-item"><button class="nav-link collapsed collapsible" data-toggle="collapse" data-target="#sidenav-17" role="button" aria-expanded="false" aria-controls="sidenav-17"><span>Accessibility & internationalization</span> <span class="material-symbols expander" aria-hidden="true">expand_more</span></button><ul class="nav collapse" id="sidenav-17"><li class="nav-item"><a class="nav-link" href="/ui/accessibility-and-internationalization/accessibility"><div><span>Accessibility</span></div></a></li><li class="nav-item"><a class="nav-link" href="/ui/accessibility-and-internationalization/internationalization"><div><span>Internationalization</span></div></a></li></ul></li><li aria-hidden="true"><div class="sidenav-divider"></div></li><li class="nav-header">Beyond UI</li><li class="nav-item"><button class="nav-link collapsed collapsible" data-toggle="collapse" data-target="#sidenav-20" role="button" aria-expanded="false" aria-controls="sidenav-20"><span>Data & backend</span> <span class="material-symbols expander" aria-hidden="true">expand_more</span></button><ul class="nav collapse" id="sidenav-20"><li class="nav-item"><button class="nav-link collapsible collapsed" data-toggle="collapse" data-target="#sidenav-20-1" role="button" aria-expanded="false" aria-controls="sidenav-20-1"><span>State management</span> <span class="material-symbols expander" aria-hidden="true">expand_more</span></button><ul class="nav collapse" id="sidenav-20-1"><li class="nav-item"><a class="nav-link" href="/data-and-backend/state-mgmt/intro"><div><span>Introduction</span></div></a></li><li class="nav-item"><a class="nav-link" href="/data-and-backend/state-mgmt/declarative"><div><span>Think declaratively</span></div></a></li><li class="nav-item"><a class="nav-link" href="/data-and-backend/state-mgmt/ephemeral-vs-app"><div><span>Ephemeral vs app state</span></div></a></li><li class="nav-item"><a class="nav-link" href="/data-and-backend/state-mgmt/simple"><div><span>Simple app state management</span></div></a></li><li class="nav-item"><a class="nav-link" href="/data-and-backend/state-mgmt/options"><div><span>Options</span></div></a></li></ul></li><li class="nav-item"><button class="nav-link collapsible collapsed" data-toggle="collapse" data-target="#sidenav-20-2" role="button" aria-expanded="false" aria-controls="sidenav-20-2"><span>Networking & http</span> <span class="material-symbols expander" aria-hidden="true">expand_more</span></button><ul class="nav collapse" id="sidenav-20-2"><li class="nav-item"><a class="nav-link" href="/data-and-backend/networking"><div><span>Overview</span></div></a></li><li class="nav-item"><a class="nav-link" href="/cookbook/networking/fetch-data"><div><span>Fetch data from the internet</span></div></a></li><li class="nav-item"><a class="nav-link" href="/cookbook/networking/authenticated-requests"><div><span>Make authenticated requests</span></div></a></li><li class="nav-item"><a class="nav-link" href="/cookbook/networking/send-data"><div><span>Send data to the internet</span></div></a></li><li class="nav-item"><a class="nav-link" href="/cookbook/networking/update-data"><div><span>Update data over the internet</span></div></a></li><li class="nav-item"><a class="nav-link" href="/cookbook/networking/delete-data"><div><span>Delete data on the internet</span></div></a></li><li class="nav-item"><a class="nav-link" href="/cookbook/networking/web-sockets"><div><span>Communicate with WebSockets</span></div></a></li></ul></li><li class="nav-item"><button class="nav-link collapsible collapsed" data-toggle="collapse" data-target="#sidenav-20-3" role="button" aria-expanded="false" aria-controls="sidenav-20-3"><span>Serialization</span> <span class="material-symbols expander" aria-hidden="true">expand_more</span></button><ul class="nav collapse" id="sidenav-20-3"><li class="nav-item"><a class="nav-link" href="/data-and-backend/serialization/json"><div><span>JSON serialization</span></div></a></li><li class="nav-item"><a class="nav-link" href="/cookbook/networking/background-parsing"><div><span>Parse JSON in the background</span></div></a></li></ul></li><li class="nav-item"><button class="nav-link collapsible collapsed" data-toggle="collapse" data-target="#sidenav-20-4" role="button" aria-expanded="false" aria-controls="sidenav-20-4"><span>Persistence</span> <span class="material-symbols expander" aria-hidden="true">expand_more</span></button><ul class="nav collapse" id="sidenav-20-4"><li class="nav-item"><a class="nav-link" href="/cookbook/persistence/key-value"><div><span>Store key-value data on disk</span></div></a></li><li class="nav-item"><a class="nav-link" href="/cookbook/persistence/reading-writing-files"><div><span>Read and write files</span></div></a></li><li class="nav-item"><a class="nav-link" href="/cookbook/persistence/sqlite"><div><span>Persist data with SQLite</span></div></a></li></ul></li><li class="nav-item"><button class="nav-link collapsible collapsed" data-toggle="collapse" data-target="#sidenav-20-5" role="button" aria-expanded="false" aria-controls="sidenav-20-5"><span>Firebase</span> <span class="material-symbols expander" aria-hidden="true">expand_more</span></button><ul class="nav collapse" id="sidenav-20-5"><li class="nav-item"><a class="nav-link" href="/data-and-backend/firebase"><div><span>Overview</span></div></a></li><li class="nav-item"><a class="nav-link" href="https://firebase.google.com/docs/flutter/setup" target="_blank" rel="noopener"><div><span>Add Firebase to your Flutter app</span><span class="material-symbols" aria-hidden="true">open_in_new</span></div></a></li></ul></li><li class="nav-item"><a class="nav-link" href="/data-and-backend/google-apis"><div><span>Google APIs</span></div></a></li></ul></li><li class="nav-item"><button class="nav-link collapsed collapsible" data-toggle="collapse" data-target="#sidenav-21" role="button" aria-expanded="false" aria-controls="sidenav-21"><span>App architecture</span> <span class="material-symbols expander" aria-hidden="true">expand_more</span></button><ul class="nav collapse" id="sidenav-21"><li class="nav-item"><a class="nav-link" href="/app-architecture"><div><span>Introduction</span></div></a></li><li class="nav-item"><a class="nav-link" href="/app-architecture/concepts"><div><span>Architecture concepts</span></div></a></li><li class="nav-item"><a class="nav-link" href="/app-architecture/guide"><div><span>Guide to app architecture</span></div></a></li><li class="nav-item"><button class="nav-link collapsible collapsed" data-toggle="collapse" data-target="#sidenav-21-4" role="button" aria-expanded="false" aria-controls="sidenav-21-4"><span>Architecture case study</span> <span class="material-symbols expander" aria-hidden="true">expand_more</span></button><ul class="nav collapse" id="sidenav-21-4"><li class="nav-item"><a class="nav-link" href="/app-architecture/case-study"><div><span>Overview</span></div></a></li><li class="nav-item"><a class="nav-link" href="/app-architecture/case-study/ui-layer"><div><span>UI layer</span></div></a></li><li class="nav-item"><a class="nav-link" href="/app-architecture/case-study/data-layer"><div><span>Data layer</span></div></a></li><li class="nav-item"><a class="nav-link" href="/app-architecture/case-study/dependency-injection"><div><span>Dependency injection</span></div></a></li><li class="nav-item"><a class="nav-link" href="/app-architecture/case-study/testing"><div><span>Testing each layer</span></div></a></li></ul></li><li class="nav-item"><a class="nav-link" href="/app-architecture/recommendations"><div><span>Recommendations</span></div></a></li><li class="nav-item"><a class="nav-link" href="/app-architecture/design-patterns"><div><span>Design patterns</span></div></a></li></ul></li><li class="nav-item"><button class="nav-link collapsed collapsible" data-toggle="collapse" data-target="#sidenav-22" role="button" aria-expanded="false" aria-controls="sidenav-22"><span>Platform integration</span> <span class="material-symbols expander" aria-hidden="true">expand_more</span></button><ul class="nav collapse" id="sidenav-22"><li class="nav-item"><a class="nav-link" href="/reference/supported-platforms"><div><span>Supported platforms</span></div></a></li><li class="nav-item"><a class="nav-link" href="/platform-integration/desktop"><div><span>Build desktop apps with Flutter</span></div></a></li><li class="nav-item"><a class="nav-link" href="/platform-integration/platform-channels"><div><span>Write platform-specific code</span></div></a></li><li class="nav-item"><button class="nav-link collapsible collapsed" data-toggle="collapse" data-target="#sidenav-22-4" role="button" aria-expanded="false" aria-controls="sidenav-22-4"><span>Android</span> <span class="material-symbols expander" aria-hidden="true">expand_more</span></button><ul class="nav collapse" id="sidenav-22-4"><li class="nav-item"><a class="nav-link" href="/platform-integration/android/install-android"><div><span>Add Android as build target</span></div></a></li><li class="nav-item"><a class="nav-link" href="/platform-integration/android/splash-screen"><div><span>Add a splash screen</span></div></a></li><li class="nav-item"><a class="nav-link" href="/platform-integration/android/predictive-back"><div><span>Add predictive back</span></div></a></li><li class="nav-item"><a class="nav-link" href="/platform-integration/android/c-interop"><div><span>Bind to native code</span></div></a></li><li class="nav-item"><a class="nav-link" href="/platform-integration/android/platform-views"><div><span>Host a native Android view</span></div></a></li><li class="nav-item"><a class="nav-link" href="/platform-integration/android/call-jetpack-apis"><div><span>Calling JetPack APIs</span></div></a></li><li class="nav-item"><a class="nav-link" href="/platform-integration/android/compose-activity"><div><span>Launch a Jetpack Compose activity</span></div></a></li><li class="nav-item"><a class="nav-link" href="/platform-integration/android/restore-state-android"><div><span>Restore state on Android</span></div></a></li><li class="nav-item"><a class="nav-link" href="/platform-integration/android/chromeos"><div><span>Target ChromeOS with Android</span></div></a></li></ul></li><li class="nav-item"><button class="nav-link collapsible collapsed" data-toggle="collapse" data-target="#sidenav-22-5" role="button" aria-expanded="false" aria-controls="sidenav-22-5"><span>iOS</span> <span class="material-symbols expander" aria-hidden="true">expand_more</span></button><ul class="nav collapse" id="sidenav-22-5"><li class="nav-item"><a class="nav-link" href="/platform-integration/ios/install-ios"><div><span>Add iOS as build target</span></div></a></li><li class="nav-item"><a class="nav-link" href="/platform-integration/ios/ios-latest"><div><span>Flutter on latest iOS</span></div></a></li><li class="nav-item"><a class="nav-link" href="/platform-integration/ios/apple-frameworks"><div><span>Leverage Apple's system libraries</span></div></a></li><li class="nav-item"><a class="nav-link" href="/platform-integration/ios/launch-screen"><div><span>Add a launch screen</span></div></a></li><li class="nav-item"><a class="nav-link" href="/platform-integration/ios/ios-app-clip"><div><span>Add iOS App Clip support</span></div></a></li><li class="nav-item"><a class="nav-link" href="/platform-integration/ios/app-extensions"><div><span>Add iOS app extensions</span></div></a></li><li class="nav-item"><a class="nav-link" href="/platform-integration/ios/c-interop"><div><span>Bind to native code</span></div></a></li><li class="nav-item"><a class="nav-link" href="/platform-integration/ios/platform-views"><div><span>Host a native iOS view</span></div></a></li><li class="nav-item"><a class="nav-link" href="/platform-integration/ios/ios-debugging"><div><span>Enable debugging on iOS</span></div></a></li><li class="nav-item"><a class="nav-link" href="/platform-integration/ios/restore-state-ios"><div><span>Restore state on iOS</span></div></a></li></ul></li><li class="nav-item"><button class="nav-link collapsible collapsed" data-toggle="collapse" data-target="#sidenav-22-6" role="button" aria-expanded="false" aria-controls="sidenav-22-6"><span>Linux</span> <span class="material-symbols expander" aria-hidden="true">expand_more</span></button><ul class="nav collapse" id="sidenav-22-6"><li class="nav-item"><a class="nav-link" href="/platform-integration/linux/install-linux"><div><span>Add Linux as build target</span></div></a></li><li class="nav-item"><a class="nav-link" href="/platform-integration/linux/building"><div><span>Build a Linux app</span></div></a></li></ul></li><li class="nav-item"><button class="nav-link collapsible collapsed" data-toggle="collapse" data-target="#sidenav-22-7" role="button" aria-expanded="false" aria-controls="sidenav-22-7"><span>macOS</span> <span class="material-symbols expander" aria-hidden="true">expand_more</span></button><ul class="nav collapse" id="sidenav-22-7"><li class="nav-item"><a class="nav-link" href="/platform-integration/macos/install-macos"><div><span>Add macOS as build target</span></div></a></li><li class="nav-item"><a class="nav-link" href="/platform-integration/macos/building"><div><span>Build a macOS app</span></div></a></li><li class="nav-item"><a class="nav-link" href="/platform-integration/macos/c-interop"><div><span>Bind to native code</span></div></a></li><li class="nav-item"><a class="nav-link" href="/platform-integration/macos/platform-views"><div><span>Host a native macOS view</span></div></a></li></ul></li><li class="nav-item"><button class="nav-link collapsible collapsed" data-toggle="collapse" data-target="#sidenav-22-8" role="button" aria-expanded="false" aria-controls="sidenav-22-8"><span>Web</span> <span class="material-symbols expander" aria-hidden="true">expand_more</span></button><ul class="nav collapse" id="sidenav-22-8"><li class="nav-item"><a class="nav-link" href="/platform-integration/web"><div><span>Web support in Flutter</span></div></a></li><li class="nav-item"><a class="nav-link" href="/platform-integration/web/install-web"><div><span>Add web as build target</span></div></a></li><li class="nav-item"><a class="nav-link" href="/platform-integration/web/building"><div><span>Build a web app</span></div></a></li><li class="nav-item"><a class="nav-link" href="/platform-integration/web/wasm"><div><span>Compile to WebAssembly</span></div></a></li><li class="nav-item"><a class="nav-link" href="/platform-integration/web/initialization"><div><span>Customize app initialization</span></div></a></li><li class="nav-item"><a class="nav-link" href="/platform-integration/web/embedding-flutter-web"><div><span>Add Flutter to any web app</span></div></a></li><li class="nav-item"><a class="nav-link" href="/platform-integration/web/web-content-in-flutter"><div><span>Web content in Flutter</span></div></a></li><li class="nav-item"><a class="nav-link" href="/platform-integration/web/renderers"><div><span>Web renderers</span></div></a></li><li class="nav-item"><a class="nav-link" href="/platform-integration/web/web-images"><div><span>Display images on the web</span></div></a></li><li class="nav-item"><a class="nav-link" href="/platform-integration/web/faq"><div><span>Web FAQ</span></div></a></li></ul></li><li class="nav-item"><button class="nav-link collapsible collapsed" data-toggle="collapse" data-target="#sidenav-22-9" role="button" aria-expanded="false" aria-controls="sidenav-22-9"><span>Windows</span> <span class="material-symbols expander" aria-hidden="true">expand_more</span></button><ul class="nav collapse" id="sidenav-22-9"><li class="nav-item"><a class="nav-link" href="/platform-integration/windows/install-windows"><div><span>Add Windows as build target</span></div></a></li><li class="nav-item"><a class="nav-link" href="/platform-integration/windows/building"><div><span>Build a Windows app</span></div></a></li></ul></li></ul></li><li class="nav-item"><button class="nav-link active collapsible" data-toggle="collapse" data-target="#sidenav-23" role="button" aria-expanded="true" aria-controls="sidenav-23"><span>Packages & plugins</span> <span class="material-symbols expander" aria-hidden="true">expand_more</span></button><ul class="nav collapse show" id="sidenav-23"><li class="nav-item"><a class="nav-link" href="/packages-and-plugins/using-packages"><div><span>Use packages & plugins</span></div></a></li><li class="nav-item"><a class="nav-link active" href="/packages-and-plugins/developing-packages"><div><span>Develop packages & plugins</span></div></a></li><li class="nav-item"><button class="nav-link collapsible collapsed" data-toggle="collapse" data-target="#sidenav-23-3" role="button" aria-expanded="false" aria-controls="sidenav-23-3"><span>Swift Package Manager</span> <span class="material-symbols expander" aria-hidden="true">expand_more</span></button><ul class="nav collapse" id="sidenav-23-3"><li class="nav-item"><a class="nav-link" href="/packages-and-plugins/swift-package-manager/for-app-developers"><div><span>For app developers</span></div></a></li><li class="nav-item"><a class="nav-link" href="/packages-and-plugins/swift-package-manager/for-plugin-authors"><div><span>For plugin authors</span></div></a></li></ul></li><div class="sidenav-divider"></div><li class="nav-item"><a class="nav-link" href="/packages-and-plugins/favorites"><div><span>Flutter Favorites</span></div></a></li><li class="nav-item"><a class="nav-link" href="https://pub.dev/flutter" target="_blank" rel="noopener"><div><span>Package repository</span><span class="material-symbols" aria-hidden="true">open_in_new</span></div></a></li></ul></li><li class="nav-item"><button class="nav-link collapsed collapsible" data-toggle="collapse" data-target="#sidenav-24" role="button" aria-expanded="false" aria-controls="sidenav-24"><span>Testing & debugging</span> <span class="material-symbols expander" aria-hidden="true">expand_more</span></button><ul class="nav collapse" id="sidenav-24"><li class="nav-header">Testing</li><li class="nav-item"><a class="nav-link" href="/testing/overview"><div><span>Overview</span></div></a></li><li class="nav-item"><button class="nav-link collapsible collapsed" data-toggle="collapse" data-target="#sidenav-24-3" role="button" aria-expanded="false" aria-controls="sidenav-24-3"><span>Unit testing</span> <span class="material-symbols expander" aria-hidden="true">expand_more</span></button><ul class="nav collapse" id="sidenav-24-3"><li class="nav-item"><a class="nav-link" href="/cookbook/testing/unit/introduction"><div><span>Introduction</span></div></a></li><li class="nav-item"><a class="nav-link" href="/cookbook/testing/unit/mocking"><div><span>Mock dependencies</span></div></a></li></ul></li><li class="nav-item"><button class="nav-link collapsible collapsed" data-toggle="collapse" data-target="#sidenav-24-4" role="button" aria-expanded="false" aria-controls="sidenav-24-4"><span>Widget testing</span> <span class="material-symbols expander" aria-hidden="true">expand_more</span></button><ul class="nav collapse" id="sidenav-24-4"><li class="nav-item"><a class="nav-link" href="/cookbook/testing/widget/introduction"><div><span>Introduction</span></div></a></li><li class="nav-item"><a class="nav-link" href="/cookbook/testing/widget/finders"><div><span>Find widgets</span></div></a></li><li class="nav-item"><a class="nav-link" href="/cookbook/testing/widget/scrolling"><div><span>Simulate scrolling</span></div></a></li><li class="nav-item"><a class="nav-link" href="/cookbook/testing/widget/tap-drag"><div><span>Simulate user interaction</span></div></a></li></ul></li><li class="nav-item"><button class="nav-link collapsible collapsed" data-toggle="collapse" data-target="#sidenav-24-5" role="button" aria-expanded="false" aria-controls="sidenav-24-5"><span>Integration testing</span> <span class="material-symbols expander" aria-hidden="true">expand_more</span></button><ul class="nav collapse" id="sidenav-24-5"><li class="nav-item"><a class="nav-link" href="/cookbook/testing/integration/introduction"><div><span>Introduction</span></div></a></li><li class="nav-item"><a class="nav-link" href="/testing/integration-tests"><div><span>Write and run an integration test</span></div></a></li><li class="nav-item"><a class="nav-link" href="/cookbook/testing/integration/profiling"><div><span>Profile an integration test</span></div></a></li></ul></li><li class="nav-item"><a class="nav-link" href="/testing/testing-plugins"><div><span>Test a plugin</span></div></a></li><li class="nav-item"><a class="nav-link" href="/testing/plugins-in-tests"><div><span>Handle plugin code in tests</span></div></a></li><li class="nav-header">Debugging</li><li class="nav-item"><a class="nav-link" href="/testing/debugging"><div><span>Debugging tools</span></div></a></li><li class="nav-item"><a class="nav-link" href="/testing/code-debugging"><div><span>Debug your app programmatically</span></div></a></li><li class="nav-item"><a class="nav-link" href="/testing/native-debugging"><div><span>Use a native language debugger</span></div></a></li><li class="nav-item"><a class="nav-link" href="/testing/common-errors"><div><span>Common Flutter errors</span></div></a></li><li class="nav-item"><a class="nav-link" href="/testing/errors"><div><span>Handle errors</span></div></a></li><li class="nav-item"><a class="nav-link" href="/cookbook/maintenance/error-reporting"><div><span>Report errors to a service</span></div></a></li></ul></li><li class="nav-item"><button class="nav-link collapsed collapsible" data-toggle="collapse" data-target="#sidenav-25" role="button" aria-expanded="false" aria-controls="sidenav-25"><span>Performance & optimization</span> <span class="material-symbols expander" aria-hidden="true">expand_more</span></button><ul class="nav collapse" id="sidenav-25"><li class="nav-item"><a class="nav-link" href="/perf"><div><span>Overview</span></div></a></li><li class="nav-item"><a class="nav-link" href="/perf/impeller"><div><span>Impeller</span></div></a></li><li class="nav-item"><a class="nav-link" href="/perf/best-practices"><div><span>Performance best practices</span></div></a></li><li class="nav-item"><a class="nav-link" href="/perf/app-size"><div><span>App size</span></div></a></li><li class="nav-item"><a class="nav-link" href="/perf/deferred-components"><div><span>Deferred components</span></div></a></li><li class="nav-item"><a class="nav-link" href="/perf/rendering-performance"><div><span>Rendering performance</span></div></a></li><li class="nav-item"><a class="nav-link" href="/perf/ui-performance"><div><span>Performance profiling</span></div></a></li><li class="nav-item"><a class="nav-link" href="/perf/web-performance"><div><span>Performance profiling for web</span></div></a></li><li class="nav-item"><a class="nav-link" href="/perf/metrics"><div><span>Performance metrics</span></div></a></li><li class="nav-item"><a class="nav-link" href="/perf/isolates"><div><span>Concurrency and isolates</span></div></a></li><li class="nav-item"><a class="nav-link" href="/perf/faq"><div><span>Performance FAQ</span></div></a></li><li class="nav-item"><a class="nav-link" href="/perf/appendix"><div><span>Appendix</span></div></a></li></ul></li><li class="nav-item"><button class="nav-link collapsed collapsible" data-toggle="collapse" data-target="#sidenav-26" role="button" aria-expanded="false" aria-controls="sidenav-26"><span>Deployment</span> <span class="material-symbols expander" aria-hidden="true">expand_more</span></button><ul class="nav collapse" id="sidenav-26"><li class="nav-item"><a class="nav-link" href="/deployment/obfuscate"><div><span>Obfuscate Dart code</span></div></a></li><li class="nav-item"><a class="nav-link" href="/deployment/flavors"><div><span>Create app flavors for Android</span></div></a></li><li class="nav-item"><a class="nav-link" href="/deployment/flavors-ios"><div><span>Create app flavors for iOS and macOS</span></div></a></li><li class="nav-item"><a class="nav-link" href="/deployment/android"><div><span>Build and release an Android app</span></div></a></li><li class="nav-item"><a class="nav-link" href="/deployment/ios"><div><span>Build and release an iOS app</span></div></a></li><li class="nav-item"><a class="nav-link" href="/deployment/macos"><div><span>Build and release a macOS app</span></div></a></li><li class="nav-item"><a class="nav-link" href="/deployment/linux"><div><span>Build and release a Linux app</span></div></a></li><li class="nav-item"><a class="nav-link" href="/deployment/windows"><div><span>Build and release a Windows app</span></div></a></li><li class="nav-item"><a class="nav-link" href="/deployment/web"><div><span>Build and release a web app</span></div></a></li><li class="nav-item"><a class="nav-link" href="/deployment/cd"><div><span>Set up continuous deployment</span></div></a></li></ul></li><li class="nav-item"><button class="nav-link collapsed collapsible" data-toggle="collapse" data-target="#sidenav-27" role="button" aria-expanded="false" aria-controls="sidenav-27"><span>Add to an existing app</span> <span class="material-symbols expander" aria-hidden="true">expand_more</span></button><ul class="nav collapse" id="sidenav-27"><li class="nav-item"><a class="nav-link" href="/add-to-app"><div><span>Introduction</span></div></a></li><li class="nav-item"><button class="nav-link collapsible collapsed" data-toggle="collapse" data-target="#sidenav-27-2" role="button" aria-expanded="false" aria-controls="sidenav-27-2"><span>Add to an Android app</span> <span class="material-symbols expander" aria-hidden="true">expand_more</span></button><ul class="nav collapse" id="sidenav-27-2"><li class="nav-item"><a class="nav-link" href="/add-to-app/android/project-setup"><div><span>Set up Android project</span></div></a></li><li class="nav-item"><a class="nav-link" href="/add-to-app/android/add-flutter-screen"><div><span>Add a single Flutter screen</span></div></a></li><li class="nav-item"><a class="nav-link" href="/add-to-app/android/add-flutter-fragment"><div><span>Add a Flutter Fragment</span></div></a></li><li class="nav-item"><a class="nav-link" href="/add-to-app/android/add-flutter-view"><div><span>Add a Flutter View</span></div></a></li><li class="nav-item"><a class="nav-link" href="/add-to-app/android/plugin-setup"><div><span>Use a Flutter plugin</span></div></a></li></ul></li><li class="nav-item"><button class="nav-link collapsible collapsed" data-toggle="collapse" data-target="#sidenav-27-3" role="button" aria-expanded="false" aria-controls="sidenav-27-3"><span>Add to an iOS app</span> <span class="material-symbols expander" aria-hidden="true">expand_more</span></button><ul class="nav collapse" id="sidenav-27-3"><li class="nav-item"><a class="nav-link" href="/add-to-app/ios/project-setup"><div><span>Set up iOS project</span></div></a></li><li class="nav-item"><a class="nav-link" href="/add-to-app/ios/add-flutter-screen"><div><span>Add a single Flutter screen</span></div></a></li></ul></li><li class="nav-item"><a class="nav-link" href="/platform-integration/web/embedding-flutter-web"><div><span>Add to a web app</span></div></a></li><li class="nav-item"><a class="nav-link" href="/add-to-app/debugging"><div><span>Debug embedded Flutter module</span></div></a></li><li class="nav-item"><a class="nav-link" href="/add-to-app/multiple-flutters"><div><span>Add multiple Flutter instances</span></div></a></li><li class="nav-item"><a class="nav-link" href="/add-to-app/performance"><div><span>Loading sequence and performance</span></div></a></li></ul></li><li aria-hidden="true"><div class="sidenav-divider"></div></li><li class="nav-item"><button class="nav-link collapsed collapsible" data-toggle="collapse" data-target="#sidenav-29" role="button" aria-expanded="false" aria-controls="sidenav-29"><span>Tools & editors</span> <span class="material-symbols expander" aria-hidden="true">expand_more</span></button><ul class="nav collapse" id="sidenav-29"><li class="nav-item"><a class="nav-link" href="/tools/android-studio"><div><span>Android Studio & IntelliJ</span></div></a></li><li class="nav-item"><a class="nav-link" href="/tools/vs-code"><div><span>Visual Studio Code</span></div></a></li><li class="nav-item"><button class="nav-link collapsible collapsed" data-toggle="collapse" data-target="#sidenav-29-3" role="button" aria-expanded="false" aria-controls="sidenav-29-3"><span>DevTools</span> <span class="material-symbols expander" aria-hidden="true">expand_more</span></button><ul class="nav collapse" id="sidenav-29-3"><li class="nav-item"><a class="nav-link" href="/tools/devtools"><div><span>Overview</span></div></a></li><li class="nav-item"><a class="nav-link" href="/tools/devtools/android-studio"><div><span>Run from Android Studio & IntelliJ</span></div></a></li><li class="nav-item"><a class="nav-link" href="/tools/devtools/vscode"><div><span>Run from VS Code</span></div></a></li><li class="nav-item"><a class="nav-link" href="/tools/devtools/cli"><div><span>Run from command line</span></div></a></li><li class="nav-item"><a class="nav-link" href="/tools/devtools/inspector"><div><span>Flutter inspector</span></div></a></li><li class="nav-item"><a class="nav-link" href="/tools/devtools/legacy-inspector"><div><span>Legacy Flutter inspector</span></div></a></li><li class="nav-item"><a class="nav-link" href="/tools/devtools/performance"><div><span>Performance view</span></div></a></li><li class="nav-item"><a class="nav-link" href="/tools/devtools/cpu-profiler"><div><span>CPU Profiler view</span></div></a></li><li class="nav-item"><a class="nav-link" href="/tools/devtools/memory"><div><span>Memory view</span></div></a></li><li class="nav-item"><a class="nav-link" href="/tools/devtools/console"><div><span>Debug console view</span></div></a></li><li class="nav-item"><a class="nav-link" href="/tools/devtools/network"><div><span>Network view</span></div></a></li><li class="nav-item"><a class="nav-link" href="/tools/devtools/debugger"><div><span>Debugger</span></div></a></li><li class="nav-item"><a class="nav-link" href="/tools/devtools/logging"><div><span>Logging view</span></div></a></li><li class="nav-item"><a class="nav-link" href="/tools/devtools/app-size"><div><span>App size tool</span></div></a></li><li class="nav-item"><a class="nav-link" href="/tools/devtools/extensions"><div><span>DevTools extensions</span></div></a></li><li class="nav-item"><a class="nav-link" href="/tools/devtools/deep-links"><div><span>Validate deep links</span></div></a></li><li class="nav-item"><a class="nav-link" href="/tools/devtools/release-notes"><div><span>Release notes</span></div></a></li></ul></li><li class="nav-item"><a class="nav-link" href="/tools/sdk"><div><span>SDK overview</span></div></a></li><li class="nav-item"><a class="nav-link" href="/tools/pubspec"><div><span>Flutter's pubspec options</span></div></a></li><li class="nav-item"><a class="nav-link" href="/tools/flutter-fix"><div><span>Automated fixes</span></div></a></li><li class="nav-item"><a class="nav-link" href="/tools/formatting"><div><span>Code formatting</span></div></a></li></ul></li><li class="nav-item"><button class="nav-link collapsed collapsible" data-toggle="collapse" data-target="#sidenav-30" role="button" aria-expanded="false" aria-controls="sidenav-30"><span>Flutter concepts</span> <span class="material-symbols expander" aria-hidden="true">expand_more</span></button><ul class="nav collapse" id="sidenav-30"><li class="nav-item"><a class="nav-link" href="/resources/architectural-overview"><div><span>Architectural overview</span></div></a></li><li class="nav-item"><a class="nav-link" href="/resources/inside-flutter"><div><span>Inside Flutter</span></div></a></li><li class="nav-item"><a class="nav-link" href="/ui/layout/constraints"><div><span>Understanding constraints</span></div></a></li><li class="nav-item"><a class="nav-link" href="/testing/build-modes"><div><span>Flutter's build modes</span></div></a></li><li class="nav-item"><a class="nav-link" href="/tools/hot-reload"><div><span>Hot reload</span></div></a></li></ul></li><li class="nav-item"><button class="nav-link collapsed collapsible" data-toggle="collapse" data-target="#sidenav-31" role="button" aria-expanded="false" aria-controls="sidenav-31"><span>Resources</span> <span class="material-symbols expander" aria-hidden="true">expand_more</span></button><ul class="nav collapse" id="sidenav-31"><li class="nav-item"><a class="nav-link" href="/resources/faq"><div><span>FAQ</span></div></a></li><li class="nav-item"><a class="nav-link" href="/resources/books"><div><span>Books</span></div></a></li><li class="nav-item"><a class="nav-link" href="/resources/videos"><div><span>Videos</span></div></a></li><li class="nav-item"><a class="nav-link" href="/resources/courses"><div><span>Courses</span></div></a></li><li class="nav-item"><a class="nav-link" href="/resources/bootstrap-into-dart"><div><span>Learn Dart</span></div></a></li><li class="nav-item"><a class="nav-link" href="/resources/support"><div><span>Get support</span></div></a></li><div class="sidenav-divider"></div><li class="nav-item"><button class="nav-link collapsible collapsed" data-toggle="collapse" data-target="#sidenav-31-8" role="button" aria-expanded="false" aria-controls="sidenav-31-8"><span>Contribute</span> <span class="material-symbols expander" aria-hidden="true">expand_more</span></button><ul class="nav collapse" id="sidenav-31-8"><li class="nav-item"><a class="nav-link" href="/resources/bug-reports"><div><span>Create useful bug reports</span></div></a></li><li class="nav-item"><a class="nav-link" href="https://github.com/flutter/flutter/blob/main/CONTRIBUTING.md" target="_blank" rel="noopener"><div><span>Contribute to Flutter</span><span class="material-symbols" aria-hidden="true">open_in_new</span></div></a></li><li class="nav-item"><a class="nav-link" href="/resources/design-docs"><div><span>Discover proposed features</span></div></a></li></ul></li><li class="nav-item"><button class="nav-link collapsible collapsed" data-toggle="collapse" data-target="#sidenav-31-9" role="button" aria-expanded="false" aria-controls="sidenav-31-9"><span>Reference</span> <span class="material-symbols expander" aria-hidden="true">expand_more</span></button><ul class="nav collapse" id="sidenav-31-9"><li class="nav-item"><a class="nav-link" href="/dash"><div><span>Who is Dash?</span></div></a></li><li class="nav-item"><a class="nav-link" href="/reference/widgets"><div><span>Widget index</span></div></a></li><li class="nav-item"><a class="nav-link" href="/reference/flutter-cli"><div><span>flutter CLI</span></div></a></li><li class="nav-item"><a class="nav-link" href="https://api.flutter.dev" target="_blank" rel="noopener"><div><span>API docs</span><span class="material-symbols" aria-hidden="true">open_in_new</span></div></a></li></ul></li></ul></li></ul></nav></div><main class="site-content"><div id="site-toc--side" class="site-toc"><header class="site-toc__title">Contents</header><ul class="section-nav"><li class="toc-entry nav-item"><a class="nav-link" href="#package-introduction">Package introduction</a><ul class="nav"><li class="toc-entry nav-item"><a class="nav-link" href="#types">Package types</a></li></ul></li><li class="toc-entry nav-item"><a class="nav-link" href="#dart">Developing Dart packages</a><ul class="nav"><li class="toc-entry nav-item"><a class="nav-link" href="#step-1-create-the-package">Step 1: Create the package</a></li><li class="toc-entry nav-item"><a class="nav-link" href="#step-2-implement-the-package">Step 2: Implement the package</a></li></ul></li><li class="toc-entry nav-item"><a class="nav-link" href="#plugin">Developing plugin packages</a><ul class="nav"><li class="toc-entry nav-item"><a class="nav-link" href="#federated-plugins">Federated plugins</a></li><li class="toc-entry nav-item"><a class="nav-link" href="#plugin-platforms">Specifying a plugin's supported platforms</a></li><li class="toc-entry nav-item"><a class="nav-link" href="#step-1-create-the-package-1">Step 1: Create the package</a></li><li class="toc-entry nav-item"><a class="nav-link" href="#edit-plugin-package">Step 2: Implement the package</a></li><li class="toc-entry nav-item"><a class="nav-link" href="#add-support-for-platforms-in-an-existing-plugin-project">Add support for platforms in an existing plugin project</a></li><li class="toc-entry nav-item"><a class="nav-link" href="#dart-platform-implementations">Dart platform implementations</a></li><li class="toc-entry nav-item"><a class="nav-link" href="#testing-your-plugin">Testing your plugin</a></li></ul></li><li class="toc-entry nav-item"><a class="nav-link" href="#plugin-ffi">Developing FFI plugin packages</a><ul class="nav"><li class="toc-entry nav-item"><a class="nav-link" href="#step-1-create-the-package-2">Step 1: Create the package</a></li><li class="toc-entry nav-item"><a class="nav-link" href="#step-2-building-and-bundling-native-code">Step 2: Building and bundling native code</a></li><li class="toc-entry nav-item"><a class="nav-link" href="#step-3-binding-to-native-code">Step 3: Binding to native code</a></li><li class="toc-entry nav-item"><a class="nav-link" href="#step-4-invoking-native-code">Step 4: Invoking native code</a></li></ul></li><li class="toc-entry nav-item"><a class="nav-link" href="#adding-documentation">Adding documentation</a><ul class="nav"><li class="toc-entry nav-item"><a class="nav-link" href="#api-documentation">API documentation</a></li><li class="toc-entry nav-item"><a class="nav-link" href="#adding-licenses-to-the-license-file">Adding licenses to the LICENSE file</a></li></ul></li><li class="toc-entry nav-item"><a class="nav-link" href="#publish">Publishing your package</a></li><li class="toc-entry nav-item"><a class="nav-link" href="#dependencies">Handling package interdependencies</a><ul class="nav"><li class="toc-entry nav-item"><a class="nav-link" href="#android">Android</a></li><li class="toc-entry nav-item"><a class="nav-link" href="#ios">iOS</a></li><li class="toc-entry nav-item"><a class="nav-link" href="#web">Web</a></li></ul></li></ul></div><article><header class="site-content__title"><h1 id="document-title">Developing packages & plugins</h1><nav class="breadcrumbs" aria-label="breadcrumb"><ol vocab="https://schema.org/" typeof="BreadcrumbList"><li class="breadcrumb-item" property="itemListElement" typeof="ListItem"><a href="/packages-and-plugins" property="item" typeof="WebPage"><span property="name">Packages & plugins</span></a><meta property="position" content="0"><span class="material-symbols child-icon" aria-hidden="true">chevron_right</span></li><li class="breadcrumb-item active" property="itemListElement" typeof="ListItem" aria-current="page"><a href="/packages-and-plugins/developing-packages" property="item" typeof="WebPage"><span property="name">Developing</span></a><meta property="position" content="1"></li></ol></nav></header><div id="site-toc--inline" class="site-toc toc-collapsible toc-collapsed"><header class="site-toc__title">Contents <span class="site-toc--inline__toggle toc-toggle-down" title="Expand table of contents"><i class="material-symbols" aria-hidden="true">keyboard_arrow_down</i></span> <span class="site-toc--inline__toggle toc-toggle-up" title="Collapse table of contents"><i class="material-symbols" aria-hidden="true">keyboard_arrow_up</i></span></header><ul class="section-nav"><li class="toc-entry"><a href="#package-introduction">Package introduction</a><ul><li class="toc-entry"><a href="#types">Package types</a></li></ul></li><li class="toc-entry"><a href="#dart">Developing Dart packages</a><ul><li class="toc-entry"><a href="#step-1-create-the-package">Step 1: Create the package</a></li><li class="toc-entry"><a href="#step-2-implement-the-package">Step 2: Implement the package</a></li></ul></li><li class="toc-entry"><a href="#plugin">Developing plugin packages</a><ul><li class="toc-entry"><a href="#federated-plugins">Federated plugins</a></li><li class="toc-entry"><a href="#plugin-platforms">Specifying a plugin's supported platforms</a></li><li class="toc-entry"><a href="#step-1-create-the-package-1">Step 1: Create the package</a></li><li class="toc-entry"><a href="#edit-plugin-package">Step 2: Implement the package</a></li><li class="toc-entry"><a href="#add-support-for-platforms-in-an-existing-plugin-project">Add support for platforms in an existing plugin project</a></li><li class="toc-entry"><a href="#dart-platform-implementations">Dart platform implementations</a></li><li class="toc-entry"><a href="#testing-your-plugin">Testing your plugin</a></li></ul></li><li class="toc-entry"><a href="#plugin-ffi">Developing FFI plugin packages</a><ul><li class="toc-entry"><a href="#step-1-create-the-package-2">Step 1: Create the package</a></li><li class="toc-entry"><a href="#step-2-building-and-bundling-native-code">Step 2: Building and bundling native code</a></li><li class="toc-entry"><a href="#step-3-binding-to-native-code">Step 3: Binding to native code</a></li><li class="toc-entry"><a href="#step-4-invoking-native-code">Step 4: Invoking native code</a></li></ul></li><li class="toc-entry"><a href="#adding-documentation">Adding documentation</a><ul><li class="toc-entry"><a href="#api-documentation">API documentation</a></li><li class="toc-entry"><a href="#adding-licenses-to-the-license-file">Adding licenses to the LICENSE file</a></li></ul></li><li class="toc-entry"><a href="#publish">Publishing your package</a></li><li class="toc-entry"><a href="#dependencies">Handling package interdependencies</a><ul><li class="toc-entry"><a href="#android">Android</a></li><li class="toc-entry"><a href="#ios">iOS</a></li><li class="toc-entry"><a href="#web">Web</a></li></ul></li></ul><span class="site-toc--inline__toggle toc-toggle-more-items" title="Expand table of contents"><i class="material-symbols" aria-hidden="true">more_horiz</i></span></div><div class="header-wrapper"><h2 id="package-introduction">Package introduction</h2><a class="heading-link" href="#package-introduction" aria-label="Link to 'Package introduction' section">#</a></div><p>Packages enable the creation of modular code that can be shared easily. A minimal package consists of the following:</p><dl><dt><strong><code>pubspec.yaml</code></strong></dt><dd>A metadata file that declares the package name, version, author, and so on.</dd><dt><strong><code>lib</code></strong></dt><dd>The <code>lib</code> directory contains the public code in the package, minimally a single <code><package-name>.dart</code> file.</dd></dl><aside class="alert alert-info"><div class="alert-header"><i class="material-symbols" aria-hidden="true">info</i> <span>Note</span></div><div class="alert-content"><p>For a list of dos and don'ts when writing an effective plugin, see the Medium article by Mehmet Fidanboylu, <a href="https://medium.com/flutter/writing-a-good-flutter-plugin-1a561b986c9c">Writing a good plugin</a>.</p></div></aside><div class="header-wrapper"><h3 id="types">Package types</h3><a class="heading-link" href="#types" aria-label="Link to 'Package types' section">#</a></div><p>Packages can contain more than one kind of content:</p><dl><dt><strong>Dart packages</strong></dt><dd><p>General packages written in Dart, for example the <a href="https://pub.dev/packages/path"><code>path</code></a> package. Some of these might contain Flutter specific functionality and thus have a dependency on the Flutter framework, restricting their use to Flutter only, for example the <a href="https://pub.dev/packages/fluro"><code>fluro</code></a> package.</p></dd><dt><strong>Plugin packages</strong></dt><dd><p>A specialized Dart package that contains an API written in Dart code combined with one or more platform-specific implementations.</p><p>Plugin packages can be written for Android (using Kotlin or Java), iOS (using Swift or Objective-C), web, macOS, Windows, or Linux, or any combination thereof.</p><p>A concrete example is the <a href="https://pub.dev/packages/url_launcher"><code>url_launcher</code></a> plugin package. To see how to use the <code>url_launcher</code> package, and how it was extended to implement support for web, see the Medium article by Harry Terkelsen, <a href="https://medium.com/flutter/how-to-write-a-flutter-web-plugin-5e26c689ea1">How to Write a Flutter Web Plugin, Part 1</a>.</p></dd><dt><strong>FFI Plugin packages</strong></dt><dd><p>A specialized Dart package that contains an API written in Dart code combined with one or more platform-specific implementations that use Dart FFI(<a href="/platform-integration/android/c-interop">Android</a>, <a href="/platform-integration/ios/c-interop">iOS</a>, <a href="/platform-integration/macos/c-interop">macOS</a>).</p></dd></dl><div class="header-wrapper"><h2 id="dart">Developing Dart packages</h2><a class="heading-link" href="#dart" aria-label="Link to 'Developing Dart packages' section">#</a></div><p>The following instructions explain how to write a Flutter package.</p><div class="header-wrapper"><h3 id="step-1-create-the-package">Step 1: Create the package</h3><a class="heading-link" href="#step-1-create-the-package" aria-label="Link to 'Step 1: Create the package' section">#</a></div><p>To create a starter Flutter package, use the <code>--template=package</code> flag with <code>flutter create</code>:</p><div class="code-block-wrapper language-console"><div class="code-block-body"><pre class="shiki dash-light" tabindex="0"><code><span class="line"><span style="color:#222222" class="undefined terminal-command">flutter create --template=</span><span style="color:#0C7064">package</span><span style="color:#6200EE"> hello</span></span></code></pre></div></div><p>This creates a package project in the <code>hello</code> folder with the following content:</p><dl><dt><strong>LICENSE</strong></dt><dd>A (mostly) empty license text file.</dd><dt><strong>test/hello_test.dart</strong></dt><dd>The <a href="/testing/overview#unit-tests">unit tests</a> for the package.</dd><dt><strong>hello.iml</strong></dt><dd>A configuration file used by the IntelliJ IDEs.</dd><dt><strong>.gitignore</strong></dt><dd>A hidden file that tells Git which files or folders to ignore in a project.</dd><dt><strong>.metadata</strong></dt><dd>A hidden file used by IDEs to track the properties of the Flutter project.</dd><dt><strong>pubspec.yaml</strong></dt><dd>A yaml file containing metadata that specifies the package's dependencies. Used by the pub tool.</dd><dt><strong>README.md</strong></dt><dd>A starter markdown file that briefly describes the package's purpose.</dd><dt><strong>lib/hello.dart</strong></dt><dd>A starter app containing Dart code for the package.</dd><dt><strong>.idea/modules.xml</strong>, <strong>.idea/workspace.xml</strong></dt><dd>A hidden folder containing configuration files for the IntelliJ IDEs.</dd><dt><strong>CHANGELOG.md</strong></dt><dd>A (mostly) empty markdown file for tracking version changes to the package.</dd></dl><div class="header-wrapper"><h3 id="step-2-implement-the-package">Step 2: Implement the package</h3><a class="heading-link" href="#step-2-implement-the-package" aria-label="Link to 'Step 2: Implement the package' section">#</a></div><p>For pure Dart packages, simply add the functionality inside the main <code>lib/<package name>.dart</code> file, or in several files in the <code>lib</code> directory.</p><p>To test the package, add <a href="/testing/overview#unit-tests">unit tests</a> in a <code>test</code> directory.</p><p>For additional details on how to organize the package contents, see the <a href="https://dart.dev/guides/libraries/create-library-packages">Dart library package</a> documentation.</p><div class="header-wrapper"><h2 id="plugin">Developing plugin packages</h2><a class="heading-link" href="#plugin" aria-label="Link to 'Developing plugin packages' section">#</a></div><p>If you want to develop a package that calls into platform-specific APIs, you need to develop a plugin package.</p><p>The API is connected to the platform-specific implementation(s) using a <a href="/platform-integration/platform-channels">platform channel</a>.</p><div class="header-wrapper"><h3 id="federated-plugins">Federated plugins</h3><a class="heading-link" href="#federated-plugins" aria-label="Link to 'Federated plugins' section">#</a></div><p>Federated plugins are a way of splitting support for different platforms into separate packages. So, a federated plugin can use one package for iOS, another for Android, another for web, and yet another for a car (as an example of an IoT device). Among other benefits, this approach allows a domain expert to extend an existing plugin to work for the platform they know best.</p><p>A federated plugin requires the following packages:</p><dl><dt><strong>app-facing package</strong></dt><dd>The package that plugin users depend on to use the plugin. This package specifies the API used by the Flutter app.</dd><dt><strong>platform package(s)</strong></dt><dd>One or more packages that contain the platform-specific implementation code. The app-facing package calls into these packages—they aren't included into an app, unless they contain platform-specific functionality accessible to the end user.</dd><dt><strong>platform interface package</strong></dt><dd>The package that glues the app-facing package to the platform package(s). This package declares an interface that any platform package must implement to support the app-facing package. Having a single package that defines this interface ensures that all platform packages implement the same functionality in a uniform way.</dd></dl><div class="header-wrapper"><h4 id="endorsed-federated-plugin">Endorsed federated plugin</h4><a class="heading-link" href="#endorsed-federated-plugin" aria-label="Link to 'Endorsed federated plugin' section">#</a></div><p>Ideally, when adding a platform implementation to a federated plugin, you will coordinate with the package author to include your implementation. In this way, the original author <em>endorses</em> your implementation.</p><p>For example, say you write a <code>foobar_windows</code> implementation for the (imaginary) <code>foobar</code> plugin. In an endorsed plugin, the original <code>foobar</code> author adds your Windows implementation as a dependency in the pubspec for the app-facing package. Then, when a developer includes the <code>foobar</code> plugin in their Flutter app, the Windows implementation, as well as the other endorsed implementations, are automatically available to the app.</p><div class="header-wrapper"><h4 id="non-endorsed-federated-plugin">Non-endorsed federated plugin</h4><a class="heading-link" href="#non-endorsed-federated-plugin" aria-label="Link to 'Non-endorsed federated plugin' section">#</a></div><p>If you can't, for whatever reason, get your implementation added by the original plugin author, then your plugin is <em>not</em> endorsed. A developer can still use your implementation, but must manually add the plugin to the app's <code>pubspec.yaml</code> file:</p><div class="code-block-wrapper language-yaml"><div class="code-block-body"><span class="code-block-language" title="Language yaml">yaml</span><pre class="shiki dash-light" tabindex="0"><code><span class="line"><span style="color:#0468D7">dependencies</span><span style="color:#222222">:</span></span> <span class="line"><span style="color:#0468D7"> foobar</span><span style="color:#222222">: </span><span style="color:#0C7064">^1.0.0</span></span> <span class="line"><span style="color:#0468D7"> foobar_windows</span><span style="color:#222222">: </span><span style="color:#0C7064">^1.0.0</span><span style="color:#6E6E70"> # Non-endorsed plugin implementation</span></span></code></pre></div></div><p>This approach also works for overriding an already endorsed plugin implementation of <code>foobar</code>.</p><p>For more information on federated plugins, why they are useful, and how they are implemented, see the Medium article by Harry Terkelsen, <a href="https://medium.com/flutter/how-to-write-a-flutter-web-plugin-part-2-afdddb69ece6">How To Write a Flutter Web Plugin, Part 2</a>.</p><div class="header-wrapper"><h3 id="plugin-platforms">Specifying a plugin's supported platforms</h3><a class="heading-link" href="#plugin-platforms" aria-label="Link to 'Specifying a plugin's supported platforms' section">#</a></div><p>Plugins can specify the platforms they support by adding keys to the <code>platforms</code> map in the <code>pubspec.yaml</code> file. For example, the following pubspec file shows the <code>flutter:</code> map for the <code>hello</code> plugin, which supports only iOS and Android:</p><div class="code-block-wrapper language-yaml"><div class="code-block-body"><span class="code-block-language" title="Language yaml">yaml</span><pre class="shiki dash-light" tabindex="0"><code><span class="line"><span style="color:#0468D7">flutter</span><span style="color:#222222">:</span></span> <span class="line"><span style="color:#0468D7"> plugin</span><span style="color:#222222">:</span></span> <span class="line"><span style="color:#0468D7"> platforms</span><span style="color:#222222">:</span></span> <span class="line"><span style="color:#0468D7"> android</span><span style="color:#222222">:</span></span> <span class="line"><span style="color:#0468D7"> package</span><span style="color:#222222">: </span><span style="color:#0C7064">com.example.hello</span></span> <span class="line"><span style="color:#0468D7"> pluginClass</span><span style="color:#222222">: </span><span style="color:#0C7064">HelloPlugin</span></span> <span class="line"><span style="color:#0468D7"> ios</span><span style="color:#222222">:</span></span> <span class="line"><span style="color:#0468D7"> pluginClass</span><span style="color:#222222">: </span><span style="color:#0C7064">HelloPlugin</span></span></code></pre></div></div><p>When adding plugin implementations for more platforms, the <code>platforms</code> map should be updated accordingly. For example, here's the map in the pubspec file for the <code>hello</code> plugin, when updated to add support for macOS and web:</p><div class="code-block-wrapper language-yaml"><div class="code-block-body"><span class="code-block-language" title="Language yaml">yaml</span><pre class="shiki dash-light" tabindex="0"><code><span class="line"><span style="color:#0468D7">flutter</span><span style="color:#222222">:</span></span> <span class="line"><span style="color:#0468D7"> plugin</span><span style="color:#222222">:</span></span> <span class="line"><span style="color:#0468D7"> platforms</span><span style="color:#222222">:</span></span> <span class="line"><span style="color:#0468D7"> android</span><span style="color:#222222">:</span></span> <span class="line"><span style="color:#0468D7"> package</span><span style="color:#222222">: </span><span style="color:#0C7064">com.example.hello</span></span> <span class="line"><span style="color:#0468D7"> pluginClass</span><span style="color:#222222">: </span><span style="color:#0C7064">HelloPlugin</span></span> <span class="line"><span style="color:#0468D7"> ios</span><span style="color:#222222">:</span></span> <span class="line"><span style="color:#0468D7"> pluginClass</span><span style="color:#222222">: </span><span style="color:#0C7064">HelloPlugin</span></span> <span class="line"><span style="color:#0468D7"> macos</span><span style="color:#222222">:</span></span> <span class="line"><span style="color:#0468D7"> pluginClass</span><span style="color:#222222">: </span><span style="color:#0C7064">HelloPlugin</span></span> <span class="line"><span style="color:#0468D7"> web</span><span style="color:#222222">:</span></span> <span class="line"><span style="color:#0468D7"> pluginClass</span><span style="color:#222222">: </span><span style="color:#0C7064">HelloPlugin</span></span> <span class="line"><span style="color:#0468D7"> fileName</span><span style="color:#222222">: </span><span style="color:#0C7064">hello_web.dart</span></span></code></pre></div></div><div class="header-wrapper"><h4 id="federated-platform-packages">Federated platform packages</h4><a class="heading-link" href="#federated-platform-packages" aria-label="Link to 'Federated platform packages' section">#</a></div><p>A platform package uses the same format, but includes an <code>implements</code> entry indicating which app-facing package it implements. For example, a <code>hello_windows</code> plugin containing the Windows implementation for <code>hello</code> would have the following <code>flutter:</code> map:</p><div class="code-block-wrapper language-yaml"><div class="code-block-body"><span class="code-block-language" title="Language yaml">yaml</span><pre class="shiki dash-light" tabindex="0"><code><span class="line"><span style="color:#0468D7">flutter</span><span style="color:#222222">:</span></span> <span class="line"><span style="color:#0468D7"> plugin</span><span style="color:#222222">:</span></span> <span class="line"><span style="color:#0468D7"> implements</span><span style="color:#222222">: </span><span style="color:#0C7064">hello</span></span> <span class="line"><span style="color:#0468D7"> platforms</span><span style="color:#222222">:</span></span> <span class="line"><span style="color:#0468D7"> windows</span><span style="color:#222222">:</span></span> <span class="line"><span style="color:#0468D7"> pluginClass</span><span style="color:#222222">: </span><span style="color:#0C7064">HelloPlugin</span></span></code></pre></div></div><div class="header-wrapper"><h4 id="endorsed-implementations">Endorsed implementations</h4><a class="heading-link" href="#endorsed-implementations" aria-label="Link to 'Endorsed implementations' section">#</a></div><p>An app facing package can endorse a platform package by adding a dependency on it, and including it as a <code>default_package</code> in the <code>platforms:</code> map. If the <code>hello</code> plugin above endorsed <code>hello_windows</code>, it would look as follows:</p><div class="code-block-wrapper language-yaml"><div class="code-block-body"><span class="code-block-language" title="Language yaml">yaml</span><pre class="shiki dash-light" tabindex="0"><code><span class="line"><span style="color:#0468D7">flutter</span><span style="color:#222222">:</span></span> <span class="line"><span style="color:#0468D7"> plugin</span><span style="color:#222222">:</span></span> <span class="line"><span style="color:#0468D7"> platforms</span><span style="color:#222222">:</span></span> <span class="line"><span style="color:#0468D7"> android</span><span style="color:#222222">:</span></span> <span class="line"><span style="color:#0468D7"> package</span><span style="color:#222222">: </span><span style="color:#0C7064">com.example.hello</span></span> <span class="line"><span style="color:#0468D7"> pluginClass</span><span style="color:#222222">: </span><span style="color:#0C7064">HelloPlugin</span></span> <span class="line"><span style="color:#0468D7"> ios</span><span style="color:#222222">:</span></span> <span class="line"><span style="color:#0468D7"> pluginClass</span><span style="color:#222222">: </span><span style="color:#0C7064">HelloPlugin</span></span> <span class="line"><span style="color:#0468D7"> windows</span><span style="color:#222222">:</span></span> <span class="line"><span style="color:#0468D7"> default_package</span><span style="color:#222222">: </span><span style="color:#0C7064">hello_windows</span></span> <span class="line"></span> <span class="line"><span style="color:#0468D7">dependencies</span><span style="color:#222222">:</span></span> <span class="line"><span style="color:#0468D7"> hello_windows</span><span style="color:#222222">: </span><span style="color:#0C7064">^1.0.0</span></span></code></pre></div></div><p>Note that as shown here, an app-facing package can have some platforms implemented within the package, and others in endorsed federated implementations.</p><div class="header-wrapper"><h4 id="shared-ios-and-macos-implementations">Shared iOS and macOS implementations</h4><a class="heading-link" href="#shared-ios-and-macos-implementations" aria-label="Link to 'Shared iOS and macOS implementations' section">#</a></div><p>Many frameworks support both iOS and macOS with identical or mostly identical APIs, making it possible to implement some plugins for both iOS and macOS with the same codebase. Normally each platform's implementation is in its own folder, but the <code>sharedDarwinSource</code> option allows iOS and macOS to use the same folder instead:</p><div class="code-block-wrapper language-yaml"><div class="code-block-body"><span class="code-block-language" title="Language yaml">yaml</span><pre class="shiki dash-light" tabindex="0"><code><span class="line"><span style="color:#0468D7">flutter</span><span style="color:#222222">:</span></span> <span class="line"><span style="color:#0468D7"> plugin</span><span style="color:#222222">:</span></span> <span class="line"><span style="color:#0468D7"> platforms</span><span style="color:#222222">:</span></span> <span class="line"><span style="color:#0468D7"> ios</span><span style="color:#222222">:</span></span> <span class="line"><span style="color:#0468D7"> pluginClass</span><span style="color:#222222">: </span><span style="color:#0C7064">HelloPlugin</span></span> <span class="line"><span style="color:#0468D7"> sharedDarwinSource</span><span style="color:#222222">: </span><span style="color:#0C7064">true</span></span> <span class="line"><span style="color:#0468D7"> macos</span><span style="color:#222222">:</span></span> <span class="line"><span style="color:#0468D7"> pluginClass</span><span style="color:#222222">: </span><span style="color:#0C7064">HelloPlugin</span></span> <span class="line"><span style="color:#0468D7"> sharedDarwinSource</span><span style="color:#222222">: </span><span style="color:#0C7064">true</span></span> <span class="line"></span> <span class="line"><span style="color:#0468D7">environment</span><span style="color:#222222">:</span></span> <span class="line"><span style="color:#0468D7"> sdk</span><span style="color:#222222">: </span><span style="color:#0C7064">^3.0.0</span></span> <span class="line"><span style="color:#6E6E70"> # Flutter versions prior to 3.7 did not support the</span></span> <span class="line"><span style="color:#6E6E70"> # sharedDarwinSource option.</span></span> <span class="line"><span style="color:#0468D7"> flutter</span><span style="color:#222222">: </span><span style="color:#0C7064">">=3.7.0"</span></span></code></pre></div></div><p>When <code>sharedDarwinSource</code> is enabled, instead of an <code>ios</code> directory for iOS and a <code>macos</code> directory for macOS, both platforms use a shared <code>darwin</code> directory for all code and resources. When enabling this option, you need to move any existing files from <code>ios</code> and <code>macos</code> to the shared directory. You also need to update the podspec file to set the dependencies and deployment targets for both platforms, for example:</p><div class="code-block-wrapper language-ruby"><div class="code-block-body"><span class="code-block-language" title="Language ruby">ruby</span><pre class="shiki dash-light" tabindex="0"><code><span class="line"><span style="color:#222222"> s.</span><span style="color:#6200EE">ios</span><span style="color:#222222">.</span><span style="color:#6200EE">dependency</span><span style="color:#0C7064"> 'Flutter'</span></span> <span class="line"><span style="color:#222222"> s.</span><span style="color:#6200EE">osx</span><span style="color:#222222">.</span><span style="color:#6200EE">dependency</span><span style="color:#0C7064"> 'FlutterMacOS'</span></span> <span class="line"><span style="color:#222222"> s.</span><span style="color:#6200EE">ios</span><span style="color:#222222">.</span><span style="color:#6200EE">deployment_target</span><span style="color:#222222"> = </span><span style="color:#0C7064">'11.0'</span></span> <span class="line"><span style="color:#222222"> s.</span><span style="color:#6200EE">osx</span><span style="color:#222222">.</span><span style="color:#6200EE">deployment_target</span><span style="color:#222222"> = </span><span style="color:#0C7064">'10.14'</span></span></code></pre></div></div><div class="header-wrapper"><h3 id="step-1-create-the-package-1">Step 1: Create the package</h3><a class="heading-link" href="#step-1-create-the-package-1" aria-label="Link to 'Step 1: Create the package' section">#</a></div><p>To create a plugin package, use the <code>--template=plugin</code> flag with <code>flutter create</code>.</p><p>Use the <code>--platforms=</code> option followed by a comma-separated list to specify the platforms that the plugin supports. Available platforms are: <code>android</code>, <code>ios</code>, <code>web</code>, <code>linux</code>, <code>macos</code>, and <code>windows</code>. If no platforms are specified, the resulting project doesn't support any platforms.</p><p>Use the <code>--org</code> option to specify your organization, using reverse domain name notation. This value is used in various package and bundle identifiers in the generated plugin code.</p><p>By default, the plugin project uses Swift for iOS code and Kotlin for Android code. If you prefer Objective-C or Java, you can specify the iOS language using <code>-i</code> and the Android language using <code>-a</code>. Please choose <strong>one</strong> of the following:</p><div class="code-block-wrapper language-console"><div class="code-block-body"><pre class="shiki dash-light" tabindex="0"><code><span class="line"><span style="color:#222222" class="undefined terminal-command">flutter create --org com.example --template=</span><span style="color:#0C7064">plugin</span><span style="color:#222222"> --platforms=</span><span style="color:#0C7064">android,ios,linux,macos,windows</span><span style="color:#6200EE"> -a</span><span style="color:#0C7064"> kotlin</span><span style="color:#0C7064"> hello</span></span></code></pre></div></div><div class="code-block-wrapper language-console"><div class="code-block-body"><pre class="shiki dash-light" tabindex="0"><code><span class="line"><span style="color:#222222" class="undefined terminal-command">flutter create --org com.example --template=</span><span style="color:#0C7064">plugin</span><span style="color:#222222"> --platforms=</span><span style="color:#0C7064">android,ios,linux,macos,windows</span><span style="color:#6200EE"> -a</span><span style="color:#0C7064"> java</span><span style="color:#0C7064"> hello</span></span></code></pre></div></div><div class="code-block-wrapper language-console"><div class="code-block-body"><pre class="shiki dash-light" tabindex="0"><code><span class="line"><span style="color:#222222" class="undefined terminal-command">flutter create --org com.example --template=</span><span style="color:#0C7064">plugin</span><span style="color:#222222"> --platforms=</span><span style="color:#0C7064">android,ios,linux,macos,windows</span><span style="color:#6200EE"> -i</span><span style="color:#0C7064"> objc</span><span style="color:#0C7064"> hello</span></span></code></pre></div></div><div class="code-block-wrapper language-console"><div class="code-block-body"><pre class="shiki dash-light" tabindex="0"><code><span class="line"><span style="color:#222222" class="undefined terminal-command">flutter create --org com.example --template=</span><span style="color:#0C7064">plugin</span><span style="color:#222222"> --platforms=</span><span style="color:#0C7064">android,ios,linux,macos,windows</span><span style="color:#6200EE"> -i</span><span style="color:#0C7064"> swift</span><span style="color:#0C7064"> hello</span></span></code></pre></div></div><p>This creates a plugin project in the <code>hello</code> folder with the following specialized content:</p><dl><dt><strong><code>lib/hello.dart</code></strong></dt><dd>The Dart API for the plugin.</dd><dt><strong><code>android/src/main/java/com/example/hello/HelloPlugin.kt</code></strong></dt><dd>The Android platform-specific implementation of the plugin API in Kotlin.</dd><dt><strong><code>ios/Classes/HelloPlugin.m</code></strong></dt><dd>The iOS-platform specific implementation of the plugin API in Objective-C.</dd><dt><strong><code>example/</code></strong></dt><dd>A Flutter app that depends on the plugin, and illustrates how to use it.</dd></dl><div class="header-wrapper"><h3 id="edit-plugin-package">Step 2: Implement the package</h3><a class="heading-link" href="#edit-plugin-package" aria-label="Link to 'Step 2: Implement the package' section">#</a></div><p>As a plugin package contains code for several platforms written in several programming languages, some specific steps are needed to ensure a smooth experience.</p><div class="header-wrapper"><h4 id="step-2a-define-the-package-api-dart">Step 2a: Define the package API (.dart)</h4><a class="heading-link" href="#step-2a-define-the-package-api-dart" aria-label="Link to 'Step 2a: Define the package API (.dart)' section">#</a></div><p>The API of the plugin package is defined in Dart code. Open the main <code>hello/</code> folder in your favorite <a href="/get-started/editor">Flutter editor</a>. Locate the file <code>lib/hello.dart</code>.</p><div class="header-wrapper"><h4 id="step-2b-add-android-platform-code-kt-java">Step 2b: Add Android platform code (.kt/.java)</h4><a class="heading-link" href="#step-2b-add-android-platform-code-kt-java" aria-label="Link to 'Step 2b: Add Android platform code (.kt/.java)' section">#</a></div><p>We recommend you edit the Android code using Android Studio.</p><p>Before editing the Android platform code in Android Studio, first make sure that the code has been built at least once (in other words, run the example app from your IDE/editor, or in a terminal execute <code>cd hello/example; flutter build apk --config-only</code>).</p><p>Then use the following steps:</p><ol><li>Launch Android Studio.</li><li>Select <strong>Open an existing Android Studio Project</strong> in the <strong>Welcome to Android Studio</strong> dialog, or select <strong>File > Open</strong> from the menu, and select the <code>hello/example/android/build.gradle</code> file.</li><li>In the <strong>Gradle Sync</strong> dialog, select <strong>OK</strong>.</li><li>In the <strong>Android Gradle Plugin Update</strong> dialog, select <strong>Don't remind me again for this project</strong>.</li></ol><p>The Android platform code of your plugin is located in <code>hello/java/com.example.hello/HelloPlugin</code>.</p><p>You can run the example app from Android Studio by pressing the run (▶) button.</p><div class="header-wrapper"><h4 id="step-2c-add-ios-platform-code-swift-hplus-m">Step 2c: Add iOS platform code (.swift/.h+.m)</h4><a class="heading-link" href="#step-2c-add-ios-platform-code-swift-hplus-m" aria-label="Link to 'Step 2c: Add iOS platform code (.swift/.h+.m)' section">#</a></div><p>We recommend you edit the iOS code using Xcode.</p><p>Before editing the iOS platform code in Xcode, first make sure that the code has been built at least once (in other words, run the example app from your IDE/editor, or in a terminal execute <code>cd hello/example; flutter build ios --no-codesign --config-only</code>).</p><p>Then use the following steps:</p><ol><li>Launch Xcode.</li><li>Select <strong>File > Open</strong>, and select the <code>hello/example/ios/Runner.xcworkspace</code> file.</li></ol><p>The iOS platform code for your plugin is located in <code>Pods/Development Pods/hello/../../example/ios/.symlinks/plugins/hello/ios/Classes</code> in the Project Navigator. (If you are using <code>sharedDarwinSource</code>, the path will end with <code>hello/darwin/Classes</code> instead.)</p><p>You can run the example app by pressing the run (▶) button.</p><div class="header-wrapper"><h5 id="add-cocoapod-dependencies">Add CocoaPod dependencies</h5><a class="heading-link" href="#add-cocoapod-dependencies" aria-label="Link to 'Add CocoaPod dependencies' section">#</a></div><aside class="alert alert-warning"><div class="alert-header"><i class="material-symbols" aria-hidden="true">warning</i> <span>Warning</span></div><div class="alert-content"><p>Flutter is migrating to <a href="https://www.swift.org/documentation/package-manager/">Swift Package Manager</a> to manage iOS and macOS native dependencies. Flutter's support of Swift Package Manager is under development. The implementation might change in the future. Swift Package Manager support is only available on Flutter's <a href="/release/upgrade#switching-flutter-channels"><code>main</code> channel</a>. Flutter continues to support CocoaPods.</p></div></aside><p>Use the following instructions to add <code>HelloPod</code> with the version <code>0.0.1</code>:</p><ol><li><p>Specify the dependency at the end of <code>ios/hello.podspec</code>:</p><div class="code-block-wrapper language-ruby"><div class="code-block-body"><span class="code-block-language" title="Language ruby">ruby</span><pre class="shiki dash-light" tabindex="0"><code><span class="line"><span style="color:#222222">s.</span><span style="color:#6200EE">dependency</span><span style="color:#0C7064"> 'HelloPod'</span><span style="color:#222222">, </span><span style="color:#0C7064">'0.0.1'</span></span></code></pre></div></div><p>For private pods, refer to <a href="https://guides.cocoapods.org/making/private-cocoapods.html">Private CocoaPods</a> to ensure repo access:</p><div class="code-block-wrapper language-ruby"><div class="code-block-body"><span class="code-block-language" title="Language ruby">ruby</span><pre class="shiki dash-light" tabindex="0"><code><span class="line"><span style="color:#222222">s.</span><span style="color:#6200EE">source</span><span style="color:#222222"> = {</span></span> <span class="line"><span style="color:#6E6E70"> # For pods hosted on GitHub</span></span> <span class="line"><span style="color:#222222"> :</span><span style="color:#0C7064">git</span><span style="color:#222222"> => </span><span style="color:#0C7064">"https://github.com/path/to/HelloPod.git"</span><span style="color:#222222">,</span></span> <span class="line"><span style="color:#6E6E70"> # Alternatively, for pods hosted locally</span></span> <span class="line"><span style="color:#6E6E70"> # :path => "file:///path/to/private/repo",</span></span> <span class="line"><span style="color:#222222"> :</span><span style="color:#0C7064">tag</span><span style="color:#222222"> => s.</span><span style="color:#6200EE">version</span><span style="color:#222222">.</span><span style="color:#6200EE">to_s</span></span> <span class="line"><span style="color:#222222"> }</span><span style="color:#0C7064">`</span></span></code></pre></div></div></li></ol><ol start="2"><li><p>Installing the plugin</p><ul><li>Add the plugin in the project’s <code>pubspec.yaml</code> dependencies.</li><li>Run <code>flutter pub get</code>.</li><li>In the project’s <code>ios/</code> directory, run <code>pod install</code>.</li></ul></li></ol><p>The pod should appear in the installation summary.</p><p>If your plugin requires a privacy manifest, for example, if it uses any <strong>required reason APIs</strong>, update the <code>PrivacyInfo.xcprivacy</code> file to describe your plugin's privacy impact, and add the following to the bottom of your podspec file:</p><div class="code-block-wrapper language-ruby"><div class="code-block-body"><span class="code-block-language" title="Language ruby">ruby</span><pre class="shiki dash-light" tabindex="0"><code><span class="line"><span style="color:#222222">s.</span><span style="color:#6200EE">resource_bundles</span><span style="color:#222222"> = {</span><span style="color:#0C7064">'your_plugin_privacy'</span><span style="color:#222222"> => [</span><span style="color:#0C7064">'your_plugin/Sources/your_plugin/Resources/PrivacyInfo.xcprivacy'</span><span style="color:#222222">]}</span></span></code></pre></div></div><p>For more information, check out <a href="https://developer.apple.com/documentation/bundleresources/privacy_manifest_files">Privacy manifest files</a> on the Apple developer site.</p><div class="header-wrapper"><h4 id="step-2d-add-linux-platform-code-hplus-cc">Step 2d: Add Linux platform code (.h+.cc)</h4><a class="heading-link" href="#step-2d-add-linux-platform-code-hplus-cc" aria-label="Link to 'Step 2d: Add Linux platform code (.h+.cc)' section">#</a></div><p>We recommend you edit the Linux code using an IDE with C++ integration. The instructions below are for Visual Studio Code with the "C/C++" and "CMake" extensions installed, but can be adjusted for other IDEs.</p><p>Before editing the Linux platform code in an IDE, first make sure that the code has been built at least once (in other words, run the example app from your Flutter IDE/editor, or in a terminal execute <code>cd hello/example; flutter build linux</code>).</p><p>Then use the following steps:</p><ol><li>Launch Visual Studio Code.</li><li>Open the <code>hello/example/linux/</code> directory.</li><li>Choose <strong>Yes</strong> in the prompt asking: <code>Would you like to configure project "linux"?</code>. This will allow C++ autocomplete to work.</li></ol><p>The Linux platform code for your plugin is located in <code>flutter/ephemeral/.plugin_symlinks/hello/linux/</code>.</p><p>You can run the example app using <code>flutter run</code>. <strong>Note:</strong> Creating a runnable Flutter application on Linux requires steps that are part of the <code>flutter</code> tool, so even if your editor provides CMake integration building and running that way won't work correctly.</p><div class="header-wrapper"><h4 id="step-2e-add-macos-platform-code-swift">Step 2e: Add macOS platform code (.swift)</h4><a class="heading-link" href="#step-2e-add-macos-platform-code-swift" aria-label="Link to 'Step 2e: Add macOS platform code (.swift)' section">#</a></div><p>We recommend you edit the macOS code using Xcode.</p><p>Before editing the macOS platform code in Xcode, first make sure that the code has been built at least once (in other words, run the example app from your IDE/editor, or in a terminal execute <code>cd hello/example; flutter build macos --config-only</code>).</p><p>Then use the following steps:</p><ol><li>Launch Xcode.</li><li>Select <strong>File > Open</strong>, and select the <code>hello/example/macos/Runner.xcworkspace</code> file.</li></ol><p>The macOS platform code for your plugin is located in <code>Pods/Development Pods/hello/../../example/macos/Flutter/ephemeral/.symlinks/plugins/hello/macos/Classes</code> in the Project Navigator. (If you are using <code>sharedDarwinSource</code>, the path will end with <code>hello/darwin/Classes</code> instead.)</p><p>You can run the example app by pressing the run (▶) button.</p><div class="header-wrapper"><h4 id="step-2f-add-windows-platform-code-hplus-cpp">Step 2f: Add Windows platform code (.h+.cpp)</h4><a class="heading-link" href="#step-2f-add-windows-platform-code-hplus-cpp" aria-label="Link to 'Step 2f: Add Windows platform code (.h+.cpp)' section">#</a></div><p>We recommend you edit the Windows code using Visual Studio.</p><p>Before editing the Windows platform code in Visual Studio, first make sure that the code has been built at least once (in other words, run the example app from your IDE/editor, or in a terminal execute <code>cd hello/example; flutter build windows</code>).</p><p>Then use the following steps:</p><ol><li>Launch Visual Studio.</li><li>Select <strong>Open a project or solution</strong>, and select the <code>hello/example/build/windows/hello_example.sln</code> file.</li></ol><p>The Windows platform code for your plugin is located in <code>hello_plugin/Source Files</code> and <code>hello_plugin/Header Files</code> in the Solution Explorer.</p><p>You can run the example app by right-clicking <code>hello_example</code> in the Solution Explorer and selecting <strong>Set as Startup Project</strong>, then pressing the run (▶) button. <strong>Important:</strong> After making changes to plugin code, you must select <strong>Build > Build Solution</strong> before running again, otherwise an outdated copy of the built plugin will be run instead of the latest version containing your changes.</p><div class="header-wrapper"><h4 id="step-2g-connect-the-api-and-the-platform-code">Step 2g: Connect the API and the platform code</h4><a class="heading-link" href="#step-2g-connect-the-api-and-the-platform-code" aria-label="Link to 'Step 2g: Connect the API and the platform code' section">#</a></div><p>Finally, you need to connect the API written in Dart code with the platform-specific implementations. This is done using a <a href="/platform-integration/platform-channels">platform channel</a>, or through the interfaces defined in a platform interface package.</p><div class="header-wrapper"><h3 id="add-support-for-platforms-in-an-existing-plugin-project">Add support for platforms in an existing plugin project</h3><a class="heading-link" href="#add-support-for-platforms-in-an-existing-plugin-project" aria-label="Link to 'Add support for platforms in an existing plugin project' section">#</a></div><p>To add support for specific platforms to an existing plugin project, run <code>flutter create</code> with the <code>--template=plugin</code> flag again in the project directory. For example, to add web support in an existing plugin, run:</p><div class="code-block-wrapper language-console"><div class="code-block-body"><pre class="shiki dash-light" tabindex="0"><code><span class="line"><span style="color:#222222" class="undefined terminal-command">flutter create --template=</span><span style="color:#0C7064">plugin</span><span style="color:#222222"> --platforms=</span><span style="color:#0C7064">web</span><span style="color:#6200EE"> .</span></span></code></pre></div></div><p>If this command displays a message about updating the <code>pubspec.yaml</code> file, follow the provided instructions.</p><div class="header-wrapper"><h3 id="dart-platform-implementations">Dart platform implementations</h3><a class="heading-link" href="#dart-platform-implementations" aria-label="Link to 'Dart platform implementations' section">#</a></div><p>In many cases, non-web platform implementations only use the platform-specific implementation language, as shown above. However, platform implementations can also use platform-specific Dart as well.</p><aside class="alert alert-info"><div class="alert-header"><i class="material-symbols" aria-hidden="true">info</i> <span>Note</span></div><div class="alert-content"><p>The examples below only apply to non-web platforms. Web plugin implementations are always written in Dart, and use <code>pluginClass</code> and <code>fileName</code> for their Dart implementations as shown above.</p></div></aside><div class="header-wrapper"><h4 id="dart-only-platform-implementations">Dart-only platform implementations</h4><a class="heading-link" href="#dart-only-platform-implementations" aria-label="Link to 'Dart-only platform implementations' section">#</a></div><p>In some cases, some platforms can be implemented entirely in Dart (for example, using FFI). For a Dart-only platform implementation on a platform other than web, replace the <code>pluginClass</code> in pubspec.yaml with a <code>dartPluginClass</code>. Here is the <code>hello_windows</code> example above modified for a Dart-only implementation:</p><div class="code-block-wrapper language-yaml"><div class="code-block-body"><span class="code-block-language" title="Language yaml">yaml</span><pre class="shiki dash-light" tabindex="0"><code><span class="line"><span style="color:#0468D7">flutter</span><span style="color:#222222">:</span></span> <span class="line"><span style="color:#0468D7"> plugin</span><span style="color:#222222">:</span></span> <span class="line"><span style="color:#0468D7"> implements</span><span style="color:#222222">: </span><span style="color:#0C7064">hello</span></span> <span class="line"><span style="color:#0468D7"> platforms</span><span style="color:#222222">:</span></span> <span class="line"><span style="color:#0468D7"> windows</span><span style="color:#222222">:</span></span> <span class="line"><span style="color:#0468D7"> dartPluginClass</span><span style="color:#222222">: </span><span style="color:#0C7064">HelloPluginWindows</span></span></code></pre></div></div><p>In this version you would have no C++ Windows code, and would instead subclass the <code>hello</code> plugin's Dart platform interface class with a <code>HelloPluginWindows</code> class that includes a static <code>registerWith()</code> method. This method is called during startup, and can be used to register the Dart implementation:</p><div class="code-block-wrapper language-dart"><div class="code-block-body"><span class="code-block-language" title="Language dart">dart</span><pre class="shiki dash-light" tabindex="0"><code><span class="line"><span style="color:#BD2314">class</span><span style="color:#0468D7"> HelloPluginWindows</span><span style="color:#BD2314"> extends</span><span style="color:#0468D7"> HelloPluginPlatform</span><span style="color:#222222"> {</span></span> <span class="line"><span style="color:#6E6E70"> /// Registers this class as the default instance of </span><span style="color:#222222">[HelloPluginPlatform]</span><span style="color:#6E6E70">.</span></span> <span class="line"><span style="color:#BD2314"> static</span><span style="color:#BD2314"> void</span><span style="color:#6200EE"> registerWith</span><span style="color:#222222">() {</span></span> <span class="line"><span style="color:#0468D7"> HelloPluginPlatform</span><span style="color:#222222">.instance = </span><span style="color:#0468D7">HelloPluginWindows</span><span style="color:#222222">();</span></span> <span class="line"><span style="color:#222222"> }</span></span></code></pre></div></div><div class="header-wrapper"><h4 id="hybrid-platform-implementations">Hybrid platform implementations</h4><a class="heading-link" href="#hybrid-platform-implementations" aria-label="Link to 'Hybrid platform implementations' section">#</a></div><p>Platform implementations can also use both Dart and a platform-specific language. For example, a plugin could use a different platform channel for each platform so that the channels can be customized per platform.</p><p>A hybrid implementation uses both of the registration systems described above. Here is the <code>hello_windows</code> example above modified for a hybrid implementation:</p><div class="code-block-wrapper language-yaml"><div class="code-block-body"><span class="code-block-language" title="Language yaml">yaml</span><pre class="shiki dash-light" tabindex="0"><code><span class="line"><span style="color:#0468D7">flutter</span><span style="color:#222222">:</span></span> <span class="line"><span style="color:#0468D7"> plugin</span><span style="color:#222222">:</span></span> <span class="line"><span style="color:#0468D7"> implements</span><span style="color:#222222">: </span><span style="color:#0C7064">hello</span></span> <span class="line"><span style="color:#0468D7"> platforms</span><span style="color:#222222">:</span></span> <span class="line"><span style="color:#0468D7"> windows</span><span style="color:#222222">:</span></span> <span class="line"><span style="color:#0468D7"> dartPluginClass</span><span style="color:#222222">: </span><span style="color:#0C7064">HelloPluginWindows</span></span> <span class="line"><span style="color:#0468D7"> pluginClass</span><span style="color:#222222">: </span><span style="color:#0C7064">HelloPlugin</span></span></code></pre></div></div><p>The Dart <code>HelloPluginWindows</code> class would use the <code>registerWith()</code> shown above for Dart-only implementations, while the C++ <code>HelloPlugin</code> class would be the same as in a C++-only implementation.</p><div class="header-wrapper"><h3 id="testing-your-plugin">Testing your plugin</h3><a class="heading-link" href="#testing-your-plugin" aria-label="Link to 'Testing your plugin' section">#</a></div><p>We encourage you test your plugin with automated tests to ensure that functionality doesn't regress as you make changes to your code.</p><p>To learn more about testing your plugins, check out <a href="/testing/testing-plugins">Testing plugins</a>. If you are writing tests for your Flutter app and plugins are causing crashes, check out <a href="/testing/plugins-in-tests">Flutter in plugin tests</a>.</p><div class="header-wrapper"><h2 id="plugin-ffi">Developing FFI plugin packages</h2><a class="heading-link" href="#plugin-ffi" aria-label="Link to 'Developing FFI plugin packages' section">#</a></div><p>If you want to develop a package that calls into native APIs using Dart's FFI, you need to develop an FFI plugin package.</p><p>Both FFI plugin packages and non-FFI plugin packages support bundling native code. However, FFI plugin packages don't support method channels, but they <em>do</em> support method channel registration code. To implement a plugin that uses both method channels <em>and</em> FFI, use a non-FFI plugin. Each platform can use either an FFI or non-FFI platform.</p><div class="header-wrapper"><h3 id="step-1-create-the-package-2">Step 1: Create the package</h3><a class="heading-link" href="#step-1-create-the-package-2" aria-label="Link to 'Step 1: Create the package' section">#</a></div><p>To create a starter FFI plugin package, use the <code>--template=plugin_ffi</code> flag with <code>flutter create</code>:</p><div class="code-block-wrapper language-console"><div class="code-block-body"><pre class="shiki dash-light" tabindex="0"><code><span class="line"><span style="color:#222222" class="undefined terminal-command">flutter create --template=</span><span style="color:#0C7064">plugin_ffi</span><span style="color:#6200EE"> hello</span></span></code></pre></div></div><p>This creates an FFI plugin project in the <code>hello</code> folder with the following specialized content:</p><p><strong>lib</strong>: The Dart code that defines the API of the plugin, and which calls into the native code using <code>dart:ffi</code>.</p><p><strong>src</strong>: The native source code, and a <code>CMakeLists.txt</code> file for building that source code into a dynamic library.</p><p><strong>platform folders</strong> (<code>android</code>, <code>ios</code>, <code>windows</code>, etc.): The build files for building and bundling the native code library with the platform application.</p><div class="header-wrapper"><h3 id="step-2-building-and-bundling-native-code">Step 2: Building and bundling native code</h3><a class="heading-link" href="#step-2-building-and-bundling-native-code" aria-label="Link to 'Step 2: Building and bundling native code' section">#</a></div><p>The <code>pubspec.yaml</code> specifies FFI plugins as follows:</p><div class="code-block-wrapper language-yaml"><div class="code-block-body"><span class="code-block-language" title="Language yaml">yaml</span><pre class="shiki dash-light" tabindex="0"><code><span class="line"><span style="color:#0468D7"> plugin</span><span style="color:#222222">:</span></span> <span class="line"><span style="color:#0468D7"> platforms</span><span style="color:#222222">:</span></span> <span class="line"><span style="color:#0468D7"> some_platform</span><span style="color:#222222">:</span></span> <span class="line"><span style="color:#0468D7"> ffiPlugin</span><span style="color:#222222">: </span><span style="color:#0C7064">true</span></span></code></pre></div></div><p>This configuration invokes the native build for the various target platforms and bundles the binaries in Flutter applications using these FFI plugins.</p><p>This can be combined with <code>dartPluginClass</code>, such as when FFI is used for the implementation of one platform in a federated plugin:</p><div class="code-block-wrapper language-yaml"><div class="code-block-body"><span class="code-block-language" title="Language yaml">yaml</span><pre class="shiki dash-light" tabindex="0"><code><span class="line"><span style="color:#0468D7"> plugin</span><span style="color:#222222">:</span></span> <span class="line"><span style="color:#0468D7"> implements</span><span style="color:#222222">: </span><span style="color:#0C7064">some_other_plugin</span></span> <span class="line"><span style="color:#0468D7"> platforms</span><span style="color:#222222">:</span></span> <span class="line"><span style="color:#0468D7"> some_platform</span><span style="color:#222222">:</span></span> <span class="line"><span style="color:#0468D7"> dartPluginClass</span><span style="color:#222222">: </span><span style="color:#0C7064">SomeClass</span></span> <span class="line"><span style="color:#0468D7"> ffiPlugin</span><span style="color:#222222">: </span><span style="color:#0C7064">true</span></span></code></pre></div></div><p>A plugin can have both FFI and method channels:</p><div class="code-block-wrapper language-yaml"><div class="code-block-body"><span class="code-block-language" title="Language yaml">yaml</span><pre class="shiki dash-light" tabindex="0"><code><span class="line"><span style="color:#0468D7"> plugin</span><span style="color:#222222">:</span></span> <span class="line"><span style="color:#0468D7"> platforms</span><span style="color:#222222">:</span></span> <span class="line"><span style="color:#0468D7"> some_platform</span><span style="color:#222222">:</span></span> <span class="line"><span style="color:#0468D7"> pluginClass</span><span style="color:#222222">: </span><span style="color:#0C7064">SomeName</span></span> <span class="line"><span style="color:#0468D7"> ffiPlugin</span><span style="color:#222222">: </span><span style="color:#0C7064">true</span></span></code></pre></div></div><p>The native build systems that are invoked by FFI (and method channels) plugins are:</p><ul><li>For Android: Gradle, which invokes the Android NDK for native builds.<ul><li>See the documentation in <code>android/build.gradle</code>.</li></ul></li><li>For iOS and macOS: Xcode, using CocoaPods.<ul><li>See the documentation in <code>ios/hello.podspec</code>.</li><li>See the documentation in <code>macos/hello.podspec</code>.</li></ul></li><li>For Linux and Windows: CMake.<ul><li>See the documentation in <code>linux/CMakeLists.txt</code>.</li><li>See the documentation in <code>windows/CMakeLists.txt</code>.</li></ul></li></ul><div class="header-wrapper"><h3 id="step-3-binding-to-native-code">Step 3: Binding to native code</h3><a class="heading-link" href="#step-3-binding-to-native-code" aria-label="Link to 'Step 3: Binding to native code' section">#</a></div><p>To use the native code, bindings in Dart are needed.</p><p>To avoid writing these by hand, they are generated from the header file (<code>src/hello.h</code>) by <a href="https://pub.dev/packages/ffigen"><code>package:ffigen</code></a>. Reference the <a href="https://pub.dev/packages/ffigen/install">ffigen docs</a> for information on how to install this package.</p><p>To regenerate the bindings, run the following command:</p><div class="code-block-wrapper language-console"><div class="code-block-body"><pre class="shiki dash-light" tabindex="0"><code><span class="line"><span style="color:#222222" class="undefined terminal-command">dart run ffigen --config ffigen.yaml</span></span></code></pre></div></div><div class="header-wrapper"><h3 id="step-4-invoking-native-code">Step 4: Invoking native code</h3><a class="heading-link" href="#step-4-invoking-native-code" aria-label="Link to 'Step 4: Invoking native code' section">#</a></div><p>Very short-running native functions can be directly invoked from any isolate. For an example, see <code>sum</code> in <code>lib/hello.dart</code>.</p><p>Longer-running functions should be invoked on a <a href="https://dart.dev/guides/language/concurrency#background-workers">helper isolate</a> to avoid dropping frames in Flutter applications. For an example, see <code>sumAsync</code> in <code>lib/hello.dart</code>.</p><div class="header-wrapper"><h2 id="adding-documentation">Adding documentation</h2><a class="heading-link" href="#adding-documentation" aria-label="Link to 'Adding documentation' section">#</a></div><p>It is recommended practice to add the following documentation to all packages:</p><ol><li>A <code>README.md</code> file that introduces the package</li><li>A <code>CHANGELOG.md</code> file that documents changes in each version</li><li>A <a href="#adding-licenses-to-the-license-file"><code>LICENSE</code></a> file containing the terms under which the package is licensed</li><li>API documentation for all public APIs (see below for details)</li></ol><div class="header-wrapper"><h3 id="api-documentation">API documentation</h3><a class="heading-link" href="#api-documentation" aria-label="Link to 'API documentation' section">#</a></div><p>When you publish a package, API documentation is automatically generated and published to pub.dev/documentation. For example, see the docs for <a href="https://pub.dev/documentation/device_info_plus"><code>device_info_plus</code></a>.</p><p>If you wish to generate API documentation locally on your development machine, use the following commands:</p><ol><li><p>Change directory to the location of your package:</p><div class="code-block-wrapper language-console"><div class="code-block-body"><pre class="shiki dash-light" tabindex="0"><code><span class="line"><span style="color:#222222">cd ~/dev/mypackage</span></span></code></pre></div></div></li><li><p>Tell the documentation tool where the Flutter SDK is located (change the following commands to reflect where you placed it):</p><div class="code-block-wrapper language-console"><div class="code-block-body"><pre class="shiki dash-light" tabindex="0"><code><span class="line"><span style="color:#222222"> export FLUTTER_ROOT=~/dev/flutter # on macOS or Linux</span></span> <span class="line"></span> <span class="line"><span style="color:#222222"> set FLUTTER_ROOT=~/dev/flutter # on Windows</span></span></code></pre></div></div></li><li>Run the `dart doc` tool (included as part of the Flutter SDK), as follows:<div class="code-block-wrapper language-console"><div class="code-block-body"><pre class="shiki dash-light" tabindex="0"><code><span class="line"><span style="color:#222222"> $FLUTTER_ROOT/bin/cache/dart-sdk/bin/dart doc # on macOS or Linux</span></span> <span class="line"></span> <span class="line"><span style="color:#222222"> %FLUTTER_ROOT%\bin\cache\dart-sdk\bin\dart doc # on Windows</span></span></code></pre></div></div></li></ol><p>For tips on how to write API documentation, see <a href="https://dart.dev/guides/language/effective-dart/documentation">Effective Dart Documentation</a>.</p><div class="header-wrapper"><h3 id="adding-licenses-to-the-license-file">Adding licenses to the LICENSE file</h3><a class="heading-link" href="#adding-licenses-to-the-license-file" aria-label="Link to 'Adding licenses to the LICENSE file' section">#</a></div><p>Individual licenses inside each LICENSE file should be separated by 80 hyphens on their own on a line.</p><p>If a LICENSE file contains more than one component license, then each component license must start with the names of the packages to which the component license applies, with each package name on its own line, and the list of package names separated from the actual license text by a blank line. (The packages need not match the names of the pub package. For example, a package might itself contain code from multiple third-party sources, and might need to include a license for each one.)</p><p>The following example shows a well-organized license file:</p><div class="code-block-wrapper language-plaintext"><div class="code-block-body"><pre class="shiki dash-light" tabindex="0"><code><span class="line"><span>package_1</span></span> <span class="line"><span></span></span> <span class="line"><span><some license text></span></span> <span class="line"><span></span></span> <span class="line"><span>--------------------------------------------------------------------------------</span></span> <span class="line"><span>package_2</span></span> <span class="line"><span></span></span> <span class="line"><span><some license text></span></span></code></pre></div></div><p>Here is another example of a well-organized license file:</p><div class="code-block-wrapper language-plaintext"><div class="code-block-body"><pre class="shiki dash-light" tabindex="0"><code><span class="line"><span>package_1</span></span> <span class="line"><span></span></span> <span class="line"><span><some license text></span></span> <span class="line"><span></span></span> <span class="line"><span>--------------------------------------------------------------------------------</span></span> <span class="line"><span>package_1</span></span> <span class="line"><span>package_2</span></span> <span class="line"><span></span></span> <span class="line"><span><some license text></span></span></code></pre></div></div><p>Here is an example of a poorly-organized license file:</p><div class="code-block-wrapper language-plaintext"><div class="code-block-body"><pre class="shiki dash-light" tabindex="0"><code><span class="line"><span><some license text></span></span> <span class="line"><span></span></span> <span class="line"><span>--------------------------------------------------------------------------------</span></span> <span class="line"><span><some license text></span></span></code></pre></div></div><p>Another example of a poorly-organized license file:</p><div class="code-block-wrapper language-plaintext"><div class="code-block-body"><pre class="shiki dash-light" tabindex="0"><code><span class="line"><span>package_1</span></span> <span class="line"><span></span></span> <span class="line"><span><some license text></span></span> <span class="line"><span>--------------------------------------------------------------------------------</span></span> <span class="line"><span><some license text></span></span></code></pre></div></div><div class="header-wrapper"><h2 id="publish">Publishing your package</h2><a class="heading-link" href="#publish" aria-label="Link to 'Publishing your package' section">#</a></div><aside class="alert alert-success"><div class="alert-header"><i class="material-symbols" aria-hidden="true">lightbulb</i> <span>Tip</span></div><div class="alert-content"><p>Have you noticed that some of the packages and plugins on pub.dev are designated as <a href="https://pub.dev/flutter/favorites">Flutter Favorites</a>? These are the packages published by verified developers and are identified as the packages and plugins you should first consider using when writing your app. To learn more, see the <a href="/packages-and-plugins/favorites">Flutter Favorites program</a>.</p></div></aside><p>Once you have implemented a package, you can publish it on <a href="https://pub.dev">pub.dev</a>, so that other developers can easily use it.</p><p>Prior to publishing, make sure to review the <code>pubspec.yaml</code>, <code>README.md</code>, and <code>CHANGELOG.md</code> files to make sure their content is complete and correct. Also, to improve the quality and usability of your package (and to make it more likely to achieve the status of a Flutter Favorite), consider including the following items:</p><ul><li>Diverse code usage examples</li><li>Screenshots, animated gifs, or videos</li><li>A link to the corresponding code repository</li></ul><p>Next, run the publish command in <code>dry-run</code> mode to see if everything passes analysis:</p><div class="code-block-wrapper language-console"><div class="code-block-body"><pre class="shiki dash-light" tabindex="0"><code><span class="line"><span style="color:#222222" class="undefined terminal-command">flutter pub publish --dry-run</span></span></code></pre></div></div><p>The next step is publishing to pub.dev, but be sure that you are ready because <a href="https://dart.dev/tools/pub/publishing#publishing-is-forever">publishing is forever</a>:</p><div class="code-block-wrapper language-console"><div class="code-block-body"><pre class="shiki dash-light" tabindex="0"><code><span class="line"><span style="color:#222222" class="undefined terminal-command">flutter pub publish</span></span></code></pre></div></div><p>For more details on publishing, see the <a href="https://dart.dev/tools/pub/publishing">publishing docs</a> on dart.dev.</p><div class="header-wrapper"><h2 id="dependencies">Handling package interdependencies</h2><a class="heading-link" href="#dependencies" aria-label="Link to 'Handling package interdependencies' section">#</a></div><p>If you are developing a package <code>hello</code> that depends on the Dart API exposed by another package, you need to add that package to the <code>dependencies</code> section of your <code>pubspec.yaml</code> file. The code below makes the Dart API of the <code>url_launcher</code> plugin available to <code>hello</code>:</p><div class="code-block-wrapper language-yaml"><div class="code-block-body"><span class="code-block-language" title="Language yaml">yaml</span><pre class="shiki dash-light" tabindex="0"><code><span class="line"><span style="color:#0468D7">dependencies</span><span style="color:#222222">:</span></span> <span class="line"><span style="color:#0468D7"> url_launcher</span><span style="color:#222222">: </span><span style="color:#0C7064">^5.0.0</span></span></code></pre></div></div><p>You can now <code>import 'package:url_launcher/url_launcher.dart'</code> and <code>launch(someUrl)</code> in the Dart code of <code>hello</code>.</p><p>This is no different from how you include packages in Flutter apps or any other Dart project.</p><p>But if <code>hello</code> happens to be a <em>plugin</em> package whose platform-specific code needs access to the platform-specific APIs exposed by <code>url_launcher</code>, you also need to add suitable dependency declarations to your platform-specific build files, as shown below.</p><div class="header-wrapper"><h3 id="android">Android</h3><a class="heading-link" href="#android" aria-label="Link to 'Android' section">#</a></div><p>The following example sets a dependency for <code>url_launcher</code> in <code>hello/android/build.gradle</code>:</p><div class="code-block-wrapper language-groovy"><div class="code-block-body"><span class="code-block-language" title="Language groovy">groovy</span><pre class="shiki dash-light" tabindex="0"><code><span class="line"><span style="color:#222222">android {</span></span> <span class="line"><span style="color:#6E6E70"> // lines skipped</span></span> <span class="line"><span style="color:#222222"> dependencies {</span></span> <span class="line"><span style="color:#222222"> compileOnly rootProject.findProject(</span><span style="color:#0C7064">":url_launcher"</span><span style="color:#222222">)</span></span> <span class="line"><span style="color:#222222"> }</span></span> <span class="line"><span style="color:#222222">}</span></span></code></pre></div></div><p>You can now <code>import io.flutter.plugins.urllauncher.UrlLauncherPlugin</code> and access the <code>UrlLauncherPlugin</code> class in the source code at <code>hello/android/src</code>.</p><p>For more information on <code>build.gradle</code> files, see the <a href="https://docs.gradle.org/current/userguide/tutorial_using_tasks.html">Gradle Documentation</a> on build scripts.</p><div class="header-wrapper"><h3 id="ios">iOS</h3><a class="heading-link" href="#ios" aria-label="Link to 'iOS' section">#</a></div><p>The following example sets a dependency for <code>url_launcher</code> in <code>hello/ios/hello.podspec</code>:</p><div class="code-block-wrapper language-ruby"><div class="code-block-body"><span class="code-block-language" title="Language ruby">ruby</span><pre class="shiki dash-light" tabindex="0"><code><span class="line"><span style="color:#0468D7">Pod</span><span style="color:#222222">::</span><span style="color:#0468D7">Spec</span><span style="color:#222222">.</span><span style="color:#BD2314">new</span><span style="color:#BD2314"> do</span><span style="color:#222222"> |s|</span></span> <span class="line"><span style="color:#6E6E70"> # lines skipped</span></span> <span class="line"><span style="color:#222222"> s.</span><span style="color:#6200EE">dependency</span><span style="color:#0C7064"> 'url_launcher'</span></span></code></pre></div></div><p>You can now <code>#import "UrlLauncherPlugin.h"</code> and access the <code>UrlLauncherPlugin</code> class in the source code at <code>hello/ios/Classes</code>.</p><p>For additional details on <code>.podspec</code> files, see the <a href="https://guides.cocoapods.org/syntax/podspec.html">CocoaPods Documentation</a>.</p><div class="header-wrapper"><h3 id="web">Web</h3><a class="heading-link" href="#web" aria-label="Link to 'Web' section">#</a></div><p>All web dependencies are handled by the <code>pubspec.yaml</code> file, like any other Dart package.</p><p id="page-github-links"><span>Unless stated otherwise, the documentation on this site reflects the latest stable version of Flutter. Page last updated on 2024-12-12.</span> <a href="https://github.com/flutter/website/tree/main/src/content/packages-and-plugins/developing-packages.md" target="_blank" rel="noopener">View source</a> <span>or </span><a href="https://github.com/flutter/website/issues/new?template=1_page_issue.yml&&page-url=https://docs.flutter.dev/packages-and-plugins/developing-packages/&page-source=https://github.com/flutter/website/tree/main/src/content/packages-and-plugins/developing-packages.md" title="Report an issue with this page" target="_blank" rel="noopener">report an issue</a>.</p></article></main></div><footer id="site-footer"><div class="footer-section footer-main"><a class="brand" href="https://flutter.dev"><img src="/assets/images/branding/flutter/logo+text/horizontal/white.svg" alt="Flutter logo" width="164"></a><div class="footer-social-links"><a class="icon-button" href="https://medium.com/flutter" target="_blank" rel="noopener" title="Flutter's Medium blog"><svg><use href="/assets/images/social/medium.svg#medium"></use></svg> </a><a class="icon-button" href="https://youtube.com/@flutterdev" target="_blank" rel="noopener" title="Flutter's YouTube"><svg><use href="/assets/images/social/youtube.svg#youtube"></use></svg> </a><a class="icon-button" href="https://github.com/flutter" target="_blank" rel="noopener" title="Flutter's GitHub"><svg><use href="/assets/images/social/github.svg#github"></use></svg> </a><a class="icon-button" href="https://bsky.app/profile/flutter.dev" target="_blank" rel="noopener" title="Flutter's Bluesky"><svg><use href="/assets/images/social/bluesky.svg#bluesky"></use></svg> </a><a class="icon-button" href="https://twitter.com/FlutterDev" target="_blank" rel="noopener" title="Flutter's X (Twitter)"><svg><use href="/assets/images/social/x.svg#x"></use></svg></a></div></div><div class="footer-section footer-tray"><div class="footer-licenses">Except as otherwise noted, this site is licensed under a <a href="https://creativecommons.org/licenses/by/4.0/">Creative Commons Attribution 4.0 International License</a>, and code samples are licensed under the <a href="https://opensource.org/licenses/BSD-3-Clause">3-Clause BSD License</a>.</div><div class="footer-utility-links"><ul><li><a href="/tos" title="Terms of use">Terms</a></li><li><a href="/brand" title="Brand usage guidelines">Brand</a></li><li><a href="https://policies.google.com/privacy" target="_blank" rel="noopener" title="Privacy policy">Privacy</a></li><li><a href="/security" title="Security philosophy and practices">Security</a></li></ul></div></div></footer></div><script src="/assets/js/tabs.js?v=4"></script><script src="/assets/js/archive.js?v=4"></script><script src="/assets/js/main.js?v=4"></script></body></html>