api.flutter.dev Open in urlscan Pro
2620:0:890::100  Public Scan

Form analysis
2 forms found in the DOM

<form class="search navbar-right" role="search">
  <div class="tt-wrapper"><input type="text" id="search-box" autocomplete="off" class="form-control typeahead tt-input" placeholder="Search API Docs" spellcheck="false">
    <div role="listbox" aria-expanded="false" class="tt-menu" style="display: none;">
      <div class="enter-search-message"></div>
      <div class="tt-search-results"></div>
    </div>
  </div>
</form>

<form class="search-sidebar" role="search">
  <div class="tt-wrapper"><input type="text" id="search-sidebar" autocomplete="off" class="form-control typeahead tt-input" placeholder="Search API Docs" spellcheck="false">
    <div role="listbox" aria-expanded="false" class="tt-menu" style="display: none;">
      <div class="enter-search-message"></div>
      <div class="tt-search-results"></div>
    </div>
  </div>
</form>

Text Content

menu
 1. Flutter SDK

Flutter

dark_mode light_mode


WELCOME TO THE FLUTTER API REFERENCE DOCUMENTATION!

Flutter is Google's SDK for crafting beautiful, fast user experiences for
mobile, web, and desktop from a single codebase. Flutter works with existing
code, is used by developers and organizations around the world, and is free and
open source.

This API reference covers all libraries that are exported by the Flutter SDK.


MORE DOCUMENTATION

This site hosts Flutter's API documentation. Other documentation can be found at
the following locations:

 * flutter.dev (main Flutter site)
 * Stable channel API Docs
 * Main channel API Docs
 * Engine Embedder API documentation:
   * Android Embedder
   * iOS Embedder
   * macOS Embedder
   * Linux Embedder
   * Windows Embedder
   * Web Embedder
 * Installation
 * Codelabs
 * Contributing to Flutter


OFFLINE DOCUMENTATION

In addition to the online sites above, Flutter's documentation can be downloaded
as an HTML documentation ZIP file for use when offline or when you have a poor
internet connection.

Warning: the offline documentation files are quite large, approximately 700 MB
to 900 MB.

Offline HTML documentation ZIP bundles:

 * Stable channel
 * Main channel

Or, you can add Flutter to the open-source Zeal app using the following XML
configurations. Follow the instructions in the application for adding a feed.

 * Stable channel Zeal XML configuration URL:
   api.flutter.dev/offline/flutter.xml
 * Main channel Zeal XML configuration URL:
   main-api.flutter.dev/offline/flutter.xml


IMPORTING A LIBRARY


FRAMEWORK LIBRARIES

Libraries in the "Libraries" section below (or in the left navigation) are part
of the core Flutter framework and are imported using
'package:flutter/<library>.dart', like so:

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



DART LIBRARIES

Libraries in the "Dart" section exist in the dart: namespace and are imported
using 'dart:<library>', like so:

import 'dart:async';
import 'dart:ui';


Except for 'dart:core', you must import a Dart library before you can use it.


SUPPORTING LIBRARIES

Libraries in other sections are supporting libraries that ship with Flutter.
They are organized by package and are imported using
'package:<package>/<library>.dart', like so:

import 'package:flutter_test/flutter_test.dart';
import 'package:file/local.dart';



PACKAGES ON PUB.DEV

Flutter has a rich ecosystem of packages that have been contributed by the
Flutter team and the broader open source community to a central repository.
Among the thousands of packages, you'll find support for Firebase, Google Fonts,
hardware services like Bluetooth and camera, new widgets and animations, and
integration with other popular web services. You can browse those packages at
pub.dev.


LIBRARIES

animation The Flutter animation system. cupertino Flutter widgets implementing
the current iOS design language. foundation Core Flutter framework primitives.
gestures The Flutter gesture recognizers. material Flutter widgets implementing
Material Design. painting The Flutter painting library. physics Simple
one-dimensional physics simulations, such as springs, friction, and gravity, for
use in user interface animations. rendering The Flutter rendering tree.
scheduler The Flutter Scheduler library. semantics The Flutter semantics
package. services Platform services exposed to Flutter apps. widgets The Flutter
widgets framework.


DART

dart:ui Built-in types and core primitives for a Flutter application.
dart:ui_web


CORE

dart:async Support for asynchronous programming, with classes such as Future and
Stream. dart:collection Classes and utilities that supplement the collection
support in dart:core. dart:convert Encoders and decoders for converting between
different data representations, including JSON and UTF-8. dart:core Built-in
types, collections, and other core functionality for every Dart program.
dart:developer Interact with developer tools such as the debugger and inspector.
dart:math Mathematical constants and functions, plus a random number generator.
dart:typed_data Lists that efficiently handle fixed sized data (for example,
unsigned 8 byte integers) and SIMD numeric types.


VM

dart:ffi Foreign Function Interface for interoperability with the C programming
language. dart:io File, socket, HTTP, and other I/O support for non-web
applications. dart:isolate Concurrent programming using isolates: independent
workers that are similar to threads but don't share memory, communicating only
via messages.


WEB

package:web open_in_new This package exposes browser APIs. It's intended to
replace dart:html and similar Dart SDK libraries. It will support access to
browser APIs from Dart code compiled to either JavaScript or WebAssembly.
dart:js_interop Interoperability, "interop" for short, with JavaScript and
browser APIs. dart:js_interop_unsafe Utility methods to manipulate JavaScript
objects dynamically.


WEB (LEGACY)

package:js open_in_new Use this package when you want to call JavaScript APIs
from Dart code, or vice versa. dart:html HTML elements and other resources for
web-based applications that need to interact with the browser and the DOM
(Document Object Model). dart:js Low-level support for interoperating with
JavaScript. dart:js_util Utility methods to manipulate package:js annotated
JavaScript interop objects in cases where the name to call is not known at
runtime.


PLATFORM_INTEGRATION

android Flutter platform integration APIs for Android. ios Flutter platform
integration APIs for iOS. linux Flutter platform integration APIs for Linux.
macos Flutter platform integration APIs for macOS. windows Flutter platform
integration APIs for Windows.


FLUTTER_TEST

flutter_test Testing library for flutter, built on top of package:test.


FLUTTER_DRIVER

flutter_driver Provides API to test Flutter applications that run on real
devices and emulators. driver_extension This library provides a Dart VM service
extension that is required for tests that use package:flutter_driver to drive
applications from a separate process, similar to Selenium (web), Espresso
(Android) and UI Automation (iOS).


FLUTTER


FLUTTER_LOCALIZATIONS

flutter_localizations Localizations for the Flutter library.


FLUTTER_WEB_PLUGINS

flutter_web_plugins The platform channels and plugin registry implementations
for the web implementations of Flutter plugins. url_strategy


LEAK_TRACKER_FLUTTER_TESTING

leak_tracker_flutter_testing


ASYNC

async Utilities that expand on the asynchronous features of the dart:async
library.


BOOLEAN_SELECTOR

boolean_selector


CHARACTERS

characters String operations based on characters (Unicode grapheme clusters).


CLOCK

clock


COLLECTION

collection algorithms Import collection.dart instead. equality Import
collection.dart instead. iterable_zip Import collection.dart instead.
priority_queue Import collection.dart instead. wrappers Import collection.dart
instead.


CRYPTO

crypto


FAKE_ASYNC

fake_async


FILE

chroot A file system that provides a view into another FileSystem via a path.
file Core interfaces containing the abstract FileSystem interface definition and
all associated types used by FileSystem. local A local file system
implementation. This relies on the use of dart:io and is thus not suitable for
use in the browser. memory An implementation of FileSystem that exists entirely
in memory with an internal representation loosely based on the Filesystem
Hierarchy Standard.


INTEGRATION_TEST

common integration_test integration_test_driver integration_test_driver_extended


INTL

date_symbol_data_custom API to allow setting Date/Time formatting in a custom
way. date_symbol_data_file This file should be imported, along with
date_format.dart in order to read locale data from files in the file system.
date_symbol_data_http_request This file should be imported, along with
date_format.dart in order to read locale data via http requests to a web
server.. date_symbol_data_local Date/time formatting symbols for all locales.
date_symbols date_time_patterns Date/time formatting symbols for a large subset
of locales. find_locale intl This library provides internationalization and
localization. This includes message formatting and replacement, date and number
formatting and parsing, and utilities for working with Bidirectional text.
intl_default intl_standalone This provides facilities for Internationalization
that are only available when running standalone. You should import only one of
this or intl_browser.dart. Right now the only thing provided here is finding the
operating system locale. locale This library provides access to the Locale
class. message_format MessageFormat prepares strings for display to users, with
optional arguments (variables/placeholders). The arguments can occur in any
order, which is necessary for translation into languages with different
grammars. It supports syntax to represent plurals and select options.
message_lookup_by_library Message/plural format library with locale support.
This can have different implementations based on the mechanism for finding the
localized versions of messages. This version expects them to be in a library
named e.g. 'messages_en_US'. The prefix is set in the "initializeMessages" call,
which must be made for a locale before any lookups can be done.
number_symbols_data Date/time formatting symbols for all locales. number_symbols


LEAK_TRACKER

devtools_integration The library should be used by DevTools to analyse the
collected leaks. leak_tracker


LEAK_TRACKER_TESTING

leak_tracker_testing


MATCHER

expect matcher Support for specifying test expectations, such as for unit tests.


MATERIAL_COLOR_UTILITIES

blend/blend hct/cam16 utils/color_utils contrast/contrast
dynamiccolor/src/contrast_curve palettes/core_palette dislike/dislike_analyzer
dynamiccolor/dynamic_color scheme/dynamic_scheme hct/hct hct/src/hct_solver
material_color_utilities dynamiccolor/material_dynamic_colors utils/math_utils
quantize/src/point_provider quantize/src/point_provider_lab quantize/quantizer
quantize/quantizer_celebi quantize/quantizer_map quantize/quantizer_wsmeans
quantize/quantizer_wu scheme/scheme scheme/scheme_content
scheme/scheme_expressive scheme/scheme_fidelity scheme/scheme_fruit_salad
scheme/scheme_monochrome scheme/scheme_neutral scheme/scheme_rainbow
scheme/scheme_tonal_spot scheme/scheme_vibrant score/score utils/string_utils
temperature/temperature_cache palettes/tonal_palette
dynamiccolor/src/tone_delta_pair scheme/variant hct/viewing_conditions


META

meta Annotations that developers can use to express the intentions that
otherwise can't be deduced by statically analyzing the source code. dart2js
Constants for use in metadata annotations to provide hints to dart2js, which is
the compiler used by dart compile js. meta_meta Annotations that describe the
intended use of other annotations.


PATH

path A comprehensive, cross-platform path manipulation library.


PLATFORM

platform


PROCESS

process


SOURCE_SPAN

source_span


STACK_TRACE

stack_trace


STREAM_CHANNEL

isolate_channel stream_channel


STRING_SCANNER

string_scanner A library for parsing strings using a sequence of patterns.


SYNC_HTTP

sync_http


TERM_GLYPH

term_glyph


TEST_API

backend hooks hooks_testing test_api fake scaffolding


TYPED_DATA

typed_data Utilities and functionality related to the "dart:typed_data" library.
typed_buffers Growable typed-data lists.


VECTOR_MATH

hash vector_math A library containing different type of vector operations for
use in games, simulations, or rendering. vector_math_64 A library containing
different type of vector operations for use in games, simulations, or rendering.
vector_math_geometry A library containing geometry generators (like
CubeGenerator, SphereGenerator and CylinderGenerator) and filters
(BarycentricFilter, ColorFilter and InvertFilter). vector_math_lists A library
for working with lists of vectors in a memory efficient way.
vector_math_operations A library containing matrix operations
(Matrix44Operations) that can be performed on Float32List instances and SIMD
optimized operations (Matrix44SIMDOperations) that can be performed on
Float32x4List instances.


VM_SERVICE

utils vm_service vm_service_io


WEBDRIVER

support/async async_core async_html async_io core support/firefox_profile io
support/stdio_stepper sync_core sync_io
 1. Flutter package

FLUTTER PACKAGE

 1.   Libraries
 2.   animation
 3.   cupertino
 4.   foundation
 5.   gestures
 6.   material
 7.   painting
 8.   physics
 9.   rendering
 10.  scheduler
 11.  semantics
 12.  services
 13.  widgets
 14.  Dart
 15.  dart:ui
 16.  dart:ui_web
 17.  Core
 18.  dart:async
 19.  dart:collection
 20.  dart:convert
 21.  dart:core
 22.  dart:developer
 23.  dart:math
 24.  dart:typed_data
 25.  VM
 26.  dart:ffi
 27.  dart:io
 28.  dart:isolate
 29.  Web
 30.  package:web open_in_new
 31.  dart:js_interop
 32.  dart:js_interop_unsafe
 33.  Web (Legacy)
 34.  package:js open_in_new
 35.  dart:html
 36.  dart:js
 37.  dart:js_util
 38.  platform_integration
 39.  android
 40.  ios
 41.  linux
 42.  macos
 43.  windows
 44.  flutter_test
 45.  flutter_test
 46.  flutter_driver
 47.  flutter_driver
 48.  driver_extension
 49.  Flutter
 50.  flutter_localizations
 51.  flutter_localizations
 52.  flutter_web_plugins
 53.  flutter_web_plugins
 54.  url_strategy
 55.  leak_tracker_flutter_testing
 56.  leak_tracker_flutter_testing
 57.  async
 58.  async
 59.  boolean_selector
 60.  boolean_selector
 61.  characters
 62.  characters
 63.  clock
 64.  clock
 65.  collection
 66.  collection
 67.  algorithms
 68.  equality
 69.  iterable_zip
 70.  priority_queue
 71.  wrappers
 72.  crypto
 73.  crypto
 74.  fake_async
 75.  fake_async
 76.  file
 77.  chroot
 78.  file
 79.  local
 80.  memory
 81.  integration_test
 82.  common
 83.  integration_test
 84.  integration_test_driver
 85.  integration_test_driver_extended
 86.  intl
 87.  date_symbol_data_custom
 88.  date_symbol_data_file
 89.  date_symbol_data_http_request
 90.  date_symbol_data_local
 91.  date_symbols
 92.  date_time_patterns
 93.  find_locale
 94.  intl
 95.  intl_default
 96.  intl_standalone
 97.  locale
 98.  message_format
 99.  message_lookup_by_library
 100. number_symbols_data
 101. number_symbols
 102. leak_tracker
 103. devtools_integration
 104. leak_tracker
 105. leak_tracker_testing
 106. leak_tracker_testing
 107. matcher
 108. expect
 109. matcher
 110. material_color_utilities
 111. blend/blend
 112. hct/cam16
 113. utils/color_utils
 114. contrast/contrast
 115. dynamiccolor/src/contrast_curve
 116. palettes/core_palette
 117. dislike/dislike_analyzer
 118. dynamiccolor/dynamic_color
 119. scheme/dynamic_scheme
 120. hct/hct
 121. hct/src/hct_solver
 122. material_color_utilities
 123. dynamiccolor/material_dynamic_colors
 124. utils/math_utils
 125. quantize/src/point_provider
 126. quantize/src/point_provider_lab
 127. quantize/quantizer
 128. quantize/quantizer_celebi
 129. quantize/quantizer_map
 130. quantize/quantizer_wsmeans
 131. quantize/quantizer_wu
 132. scheme/scheme
 133. scheme/scheme_content
 134. scheme/scheme_expressive
 135. scheme/scheme_fidelity
 136. scheme/scheme_fruit_salad
 137. scheme/scheme_monochrome
 138. scheme/scheme_neutral
 139. scheme/scheme_rainbow
 140. scheme/scheme_tonal_spot
 141. scheme/scheme_vibrant
 142. score/score
 143. utils/string_utils
 144. temperature/temperature_cache
 145. palettes/tonal_palette
 146. dynamiccolor/src/tone_delta_pair
 147. scheme/variant
 148. hct/viewing_conditions
 149. meta
 150. meta
 151. dart2js
 152. meta_meta
 153. path
 154. path
 155. platform
 156. platform
 157. process
 158. process
 159. source_span
 160. source_span
 161. stack_trace
 162. stack_trace
 163. stream_channel
 164. isolate_channel
 165. stream_channel
 166. string_scanner
 167. string_scanner
 168. sync_http
 169. sync_http
 170. term_glyph
 171. term_glyph
 172. test_api
 173. backend
 174. hooks
 175. hooks_testing
 176. test_api
 177. fake
 178. scaffolding
 179. typed_data
 180. typed_data
 181. typed_buffers
 182. vector_math
 183. hash
 184. vector_math
 185. vector_math_64
 186. vector_math_geometry
 187. vector_math_lists
 188. vector_math_operations
 189. vm_service
 190. utils
 191. vm_service
 192. vm_service_io
 193. webdriver
 194. support/async
 195. async_core
 196. async_html
 197. async_io
 198. core
 199. support/firefox_profile
 200. io
 201. support/stdio_stepper
 202. sync_core
 203. sync_io


Flutter 3.22.1 • 2024-05-22 12:39 • a14f74ff3a • stable