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

brightness_4 brightness_5


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

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_interop A library
for JS interop. Includes a JS type hierarchy to facilitate sound interop with
JS. The JS type hierarchy is modeled after the actual type hierarchy in JS, and
not the Dart type hierarchy. dart:js_interop_unsafe Utility methods to
manipulate JS objects dynamically. 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. 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_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. 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.  dart:html
 31.  dart:js
 32.  dart:js_interop
 33.  dart:js_interop_unsafe
 34.  dart:js_util
 35.  platform_integration
 36.  android
 37.  ios
 38.  linux
 39.  macos
 40.  windows
 41.  flutter_test
 42.  flutter_test
 43.  flutter_driver
 44.  flutter_driver
 45.  driver_extension
 46.  Flutter
 47.  flutter_localizations
 48.  flutter_localizations
 49.  flutter_web_plugins
 50.  flutter_web_plugins
 51.  url_strategy
 52.  leak_tracker_flutter_testing
 53.  leak_tracker_flutter_testing
 54.  async
 55.  async
 56.  boolean_selector
 57.  boolean_selector
 58.  characters
 59.  characters
 60.  clock
 61.  clock
 62.  collection
 63.  collection
 64.  algorithms
 65.  equality
 66.  iterable_zip
 67.  priority_queue
 68.  wrappers
 69.  crypto
 70.  crypto
 71.  fake_async
 72.  fake_async
 73.  file
 74.  chroot
 75.  file
 76.  local
 77.  memory
 78.  integration_test
 79.  common
 80.  integration_test
 81.  integration_test_driver
 82.  integration_test_driver_extended
 83.  intl
 84.  date_symbol_data_custom
 85.  date_symbol_data_file
 86.  date_symbol_data_http_request
 87.  date_symbol_data_local
 88.  date_symbols
 89.  date_time_patterns
 90.  intl
 91.  intl_standalone
 92.  locale
 93.  message_format
 94.  message_lookup_by_library
 95.  number_symbols_data
 96.  number_symbols
 97.  leak_tracker
 98.  devtools_integration
 99.  leak_tracker
 100. leak_tracker_testing
 101. leak_tracker_testing
 102. matcher
 103. expect
 104. matcher
 105. material_color_utilities
 106. blend/blend
 107. hct/cam16
 108. utils/color_utils
 109. contrast/contrast
 110. dynamiccolor/src/contrast_curve
 111. palettes/core_palette
 112. dislike/dislike_analyzer
 113. dynamiccolor/dynamic_color
 114. scheme/dynamic_scheme
 115. hct/hct
 116. hct/src/hct_solver
 117. material_color_utilities
 118. dynamiccolor/material_dynamic_colors
 119. utils/math_utils
 120. quantize/src/point_provider
 121. quantize/src/point_provider_lab
 122. quantize/quantizer
 123. quantize/quantizer_celebi
 124. quantize/quantizer_map
 125. quantize/quantizer_wsmeans
 126. quantize/quantizer_wu
 127. scheme/scheme
 128. scheme/scheme_content
 129. scheme/scheme_expressive
 130. scheme/scheme_fidelity
 131. scheme/scheme_fruit_salad
 132. scheme/scheme_monochrome
 133. scheme/scheme_neutral
 134. scheme/scheme_rainbow
 135. scheme/scheme_tonal_spot
 136. scheme/scheme_vibrant
 137. score/score
 138. utils/string_utils
 139. temperature/temperature_cache
 140. palettes/tonal_palette
 141. dynamiccolor/src/tone_delta_pair
 142. scheme/variant
 143. hct/viewing_conditions
 144. meta
 145. meta
 146. dart2js
 147. meta_meta
 148. path
 149. path
 150. platform
 151. platform
 152. process
 153. process
 154. source_span
 155. source_span
 156. stack_trace
 157. stack_trace
 158. stream_channel
 159. isolate_channel
 160. stream_channel
 161. string_scanner
 162. string_scanner
 163. sync_http
 164. sync_http
 165. term_glyph
 166. term_glyph
 167. test_api
 168. backend
 169. hooks
 170. hooks_testing
 171. test_api
 172. fake
 173. scaffolding
 174. typed_data
 175. typed_data
 176. typed_buffers
 177. vector_math
 178. hash
 179. vector_math
 180. vector_math_64
 181. vector_math_geometry
 182. vector_math_lists
 183. vector_math_operations
 184. vm_service
 185. utils
 186. vm_service
 187. vm_service_io
 188. webdriver
 189. support/async
 190. async_core
 191. async_html
 192. async_io
 193. core
 194. support/firefox_profile
 195. io
 196. support/stdio_stepper
 197. sync_core
 198. sync_io


Flutter 3.19.3 • 2024-03-07 16:06 • ba39319843 • stable