# Documentation

# Container

Property Type Related class or constant Remark
uniqueId String unique id
unitName String widget name "Container"
child Object child model
children Object child model list
flex String flex Property
positioned Object FLDyUnitPositioned positioned model
align Object FLDyUnitAlign align model
width double Container.width
height double Container.height
color String Container.color
padding Object FLDyUnitEdgeInsets Container.padding
margin Object FLDyUnitEdgeInsets Container.margin
decoration Object FLDyUnitBoxDecoration Container.decoration
foregroundDecoration Object FLDyUnitBoxDecoration Container.foregroundDecoration
constraints Object FLDyUnitBoxConstraints Container.constraints

# SafeArea

Property Type Related class or constant Remark
uniqueId String unique id
unitName String widget name "SafeArea"
child Object child model
children Object child model list
align Object FLDyUnitAlign align model
left bool SafeArea.left
top bool SafeArea.top
right bool SafeArea.right
bottom bool SafeArea.bottom
minimum Object FLDyUnitEdgeInsets SafeArea.minimum
maintainBottomViewPadding bool SafeArea.maintainBottomViewPadding

# Stack

Property Type Related class or constant Remark
uniqueId String unique id
unitName String widget name "Stack"
positioned Object FLDyUnitPositioned positioned model
children Object child model list
alignment String Alignment Stack.alignment
textDirection String TextDirection Stack.textDirection
fit String StackFit Stack.fit
overflow String Overflow Stack.overflow

# ListView

Property Type Related class or constant Remark
uniqueId String unique id
unitName String widget name "ListView"
positioned Object FLDyUnitPositioned positioned model
children Object child model list
scrollDirection String Axis ListView.scrollDirection
reverse bool ListView.reverse
primary bool ListView.primary
scrollPhysics Object FLDyUnitScrollPhysics ListView.scrollPhysics
shrinkWrap bool ListView.shrinkWrap
padding Object FLDyUnitEdgeInsets ListView.padding
itemExtent double ListView.itemExtent
addAutomaticKeepAlives bool ListView.addAutomaticKeepAlives
addRepaintBoundaries bool ListView.addRepaintBoundaries
addSemanticIndexes double ListView.addSemanticIndexes
cacheExtent double ListView.cacheExtent
semanticChildCount int ListView.semanticChildCount
separatedDivider Object FLDyUnitDivider divider model

# ListTile

Property Type Related class or constant Remark
uniqueId String unique id
unitName String widget name "ListTile"
positioned Object FLDyUnitPositioned positioned model
leading Object ListTile.leading
title Object ListTile.title
subtitle Object ListTile.subtitle
trailing Object ListTile.trailing
isThreeLine bool ListTile.isThreeLine
dense bool ListTile.dense
contentPadding Object FLDyUnitEdgeInsets ListTile.contentPadding
enabled bool ListTile.enabled
selected bool ListTile.selected

# InkWell

Property Type Related class or constant Remark
uniqueId String unique id
unitName String widget name "InkWell"
child Object child model
children Object child model list
flex String flex Property
positioned Object FLDyUnitPositioned positioned model
align Object FLDyUnitAlign align model
onTap Object FLDyAction tap handler
onDoubleTap Object FLDyAction 双击事件
onLongPress Object FLDyAction long press handler
focusColor String InkWell.focusColor
hoverColor String InkWell.hoverColor
highlightColor String InkWell.highlightColor
splashColor String InkWell.splashColor

# SizedBox

Property Type Related class or constant Remark
uniqueId String unique id
unitName String widget name "SizedBox"
width double SizedBox.width
height double SizedBox.height

# Text

Property Type Related class or constant Remark
uniqueId String unique id
unitName String widget name "Text"
positioned Object FLDyUnitPositioned positioned model
text String Text.data
textStyle Object FLDyUnitTextStyle Text.textStyle
textAlign String TextAlign Text.textAlign
textDirection String TextDirection Text.textDirection
softWrap bool Text.softWrap
textOverflow String TextOverflow Text.textOverflow
textScaleFactor double Text.textScaleFactor
maxLines int Text.maxLines
semanticsLabel String Text.semanticsLabel
textWidthBasis String TextWidthBasis Text.textWidthBasis

# RichText

Property Type Related class or constant Remark
uniqueId String unique id
unitName String widget name "RichText"
positioned Object FLDyUnitPositioned positioned model
text Object TextSpan 内联文本
textAlign String TextAlign RichText.textAlign
textDirection String TextDirection RichText.textDirection
softWrap bool RichText.softWrap
textOverflow String TextOverflow RichText.textOverflow
textScaleFactor double RichText.textScaleFactor
maxLines int RichText.maxLines
semanticsLabel String RichText.semanticsLabel
textWidthBasis String TextWidthBasis RichText.textWidthBasis

# TextSpan

Property Type Related class or constant Remark
uniqueId String unique id
children Object child model list
text String TextSpan.text
textStyle Object FLDyUnitTextStyle TextSpan.textStyle
gesture String FLDyGestureRecognizer TextSpan.gesture
semanticsLabel String TextSpan.semanticsLabel

# Image

Property Type Related class or constant Remark
uniqueId String unique id
unitName String widget name "Image"
flex String flex Property
positioned Object FLDyUnitPositioned positioned model
imageProvider Object ImageProvider Image.imageProvider
loading Object Image.loadingBuilder
width double Image.width
height double Image.height
color String Image.color
fit String BoxFit Image.fit
alignment String Alignment Image.alignment
imageRepeat String ImageRepeat Image.imageRepeat
semanticLabel String Image.semanticLabel
excludeFromSemantics bool Image.excludeFromSemantics

# Icon

Property Type Related class or constant Remark
uniqueId String unique id
unitName String widget name "Icon"
positioned Object FLDyUnitPositioned positioned model
icon Object FLDyUnitIconData Icon.iconData
size double Icon.size
color String Icon.size
semanticLabel String Icon.size
textDirection String TextDirection Icon.size

# RaisedButton

Property Type Related class or constant Remark
uniqueId String unique id
unitName String widget name "RaisedButton"
child Object child model
children Object child model list
flex String flex Property
positioned Object FLDyUnitPositioned positioned model
align Object FLDyUnitAlign align model
onPressed Object FLDyAction tap handler
onLongPress Object FLDyAction long press handler
textColor String RaisedButton.textColor
color String RaisedButton.color
padding Object FLDyUnitEdgeInsets RaisedButton.padding

# FlatButton

Property Type Related class or constant Remark
uniqueId String unique id
unitName String widget name "Container"
child Object child model
children Object child model list
flex String flex Property
positioned Object FLDyUnitPositioned positioned model
align Object FLDyUnitAlign align model
onPressed Object FLDyAction tap handler
onLongPress Object FLDyAction long press handler
textColor String FlatButton.textColor
color String FlatButton.color
padding Object FLDyUnitEdgeInsets FlatButton.padding









# Style Classes

# FLDyUnitIconData

IconData

Property Type Remark
codePoint int
fontFamily String
fontPackage String
matchTextDirection bool

# FLDyUnitTextStyle

TextStyle

Property Type Remark
themeStyle String
inherit bool
color String
backgroundColor String
fontFamily String
fontSize double
fontWeight String FontWeight
fontStyle String FontStyle
letterSpacing double
wordSpacing double
textBaseline String TextBaseline
height double
textDecorations List<String> TextDecoration
decorationColor String
decorationStyle String TextDecorationStyle
decorationThickness double

# FLDyUnitDivider

Divider

Property Type Remark
height double
thickness double
indent double
endIndent double
color String

# FLDyUnitScrollPhysics

ScrollPhysics

Property Type Remark
type String ScrollPhysics

# FLDyUnitEdgeInsets

EdgeInsets

Property Type Remark
top double
left double
bottom double
right double
all double EdgeInsets.all()

# FLDyUnitImageProvider

ImageProvider

Property Type Remark
type String "assets", "network"
url String
assetName String
scale double

# FLDyUnitDecorationImage

DecorationImage

Property Type Remark
imageProvider FLDyUnitImageProvider
fit String BoxFit
alignment String Alignment
imageRepeat String ImageRepeat

# FLDyUnitBoxConstraints

BoxConstraints

Property Type Remark
minWidth double
maxWidth double
minHeight double
maxHeight double

# FLDyUnitBoxDecoration

BoxDecoration

Property Type Remark
color String
image FLDyUnitDecorationImage
border FLDyUnitBorder
borderRadius FLDyUnitBorderRadius
boxShadow List<FLDyUnitBoxShadow>
shape String BoxShape

# FLDyUnitBoxShadow

BoxShadow

Property Type Remark
color String
offset FLDyUnitOffset
blurRadius double
spreadRadius double

# FLDyUnitOffset

Offset

Property Type Remark
dx double
dy double

# FLDyUnitBorderRadius

BorderRadius

Property Type Remark
radius double BorderRadius.circular(radius)

# FLDyUnitBorder

Border

Property Type Remark
color String
width double
style String BorderStyle

# FLDyUnitAlign

Row, Column, Center

Property Type Remark
type String "Row", "Column", "Center", "Align"
mainAxisSize String MainAxisSize
mainAxisAlignment String MainAxisAlignment
crossAxisAlignment String CrossAxisAlignment
alignment String Alignment
widthFactor double
heightFactor double

# FLDyUnitPositioned

Positioned

Property Type Remark
left double
top double
right double
bottom double
width double
height double









# Constants

# MainAxisSize

  • min
  • max

# MainAxisAlignment

  • start
  • end
  • center
  • spaceBetween
  • spaceAround
  • spaceEvenly

# CrossAxisAlignment

  • start
  • end
  • center
  • stretch
  • baseline

# BoxFit

  • fill
  • contain
  • cover
  • contain
  • fitWidth
  • contain
  • fitHeight
  • none
  • scaleDown

# Alignment

  • topLeft
  • topCenter
  • topRight
  • centerLeft
  • center
  • centerRight
  • bottomLeft
  • bottomCenter
  • bottomRight

# ImageRepeat

  • repeat
  • repeatX
  • repeatY
  • noRepeat

# BorderStyle

  • none
  • solid

# BoxShape

  • rectangle
  • circle

# Axis

  • horizontal
  • vertical

# ScrollPhysics

  • Bouncing
  • Clamping
  • AlwaysScrollable
  • NeverScrollable

# FontWeight

  • normal
  • bold

# FontStyle

  • normal
  • italic

# TextBaseline

  • alphabetic
  • ideographic

# TextDecoration

  • none
  • underline
  • overline
  • lineThrough

# TextDecorationStyle

  • solid
  • double
  • dotted
  • dashed
  • wavy

# TextAlign

  • left
  • right
  • center
  • justify
  • start
  • end

# TextDirection

  • ltr
  • rtl

# TextOverflow

  • clip
  • fade
  • ellipsis
  • visible

# TextWidthBasis

  • parent
  • longestLine

# StackFit

  • loose
  • expand
  • passthrough

# Overflow

  • visible
  • clip

# AlignmentDirectional

  • topStart
  • topCenter
  • topEnd
  • centerStart
  • center
  • centerEnd
  • bottomStart
  • bottomCenter
  • bottomEnd









# Actions

# FLDyAction

Property Type Remark
actionType String "builtin", "custom"
action String behavior description, which can be built-in mode or custom behavior
args List<String> arguments

# FLDyGestureRecognizer

Property Type Remark
onTap FLDyAction tap handler
onLongPress FLDyAction long press handler

# FLDyActionDispatch

FLDyActionDispatch is a singleton that provides functions such as registration and dispatch for custom behaviors.

Methods:

  • dispatcher: retrieve singleton
  • registerActionHandler: register custom action handler
  • removeActionHandler: remove custom action handler









# Builtin Patterns

  • @navigator.pushNamed: Invoking the Navigator.pushNamed method and the first parameter of FLDyAction.args is passed to the method as name
  • @navigator.pop: Invoking the Navigator.pop method

# flui

  • @flui.textToast: Invoking FLToast.text method, and the first parameter of FLDyAction.args is passed to the method as text
  • @flui.successToast: Invoking FLToast.success method, and the first parameter of FLDyAction.args is passed to the method as text
  • @flui.errorToast: Invoking FLToast.error method, and the first parameter of FLDyAction.args is passed to the method as text
  • @flui.infoToast: Invoking FLToast.info method, and the first parameter of FLDyAction.args is passed to the method as text

# theme

When using a Color string, you can get the current theme color with @ theme.

  • @theme.primaryColor
  • @theme.primaryColorLight
  • @theme.primaryColorDark
  • @theme.accentColor
  • @theme.canvasColor
  • @theme.scaffoldBackgroundColor
  • @theme.bottomAppBarColor
  • @theme.cardColor
  • @theme.dividerColor
  • @theme.focusColor
  • @theme.hoverColor
  • @theme.highlightColor
  • @theme.splashColor
  • @theme.selectedRowColor
  • @theme.unselectedWidgetColor
  • @theme.disabledColor
  • @theme.buttonColor
  • @theme.secondaryHeaderColor
  • @theme.textSelectionColor
  • @theme.textSelectionHandleColor
  • @theme.backgroundColor
  • @theme.dialogBackgroundColor
  • @theme.indicatorColor
  • @theme.hintColor
  • @theme.errorColor
  • @theme.toggleableActiveColor

# textTheme

FLDyUnitTextStyle Type can use @textTheme to get the text theme style.

  • @textTheme.display4
  • @textTheme.display3
  • @textTheme.display2
  • @textTheme.display1
  • @textTheme.headline
  • @textTheme.title
  • @textTheme.subhead
  • @textTheme.body2
  • @textTheme.body1
  • @textTheme.caption
  • @textTheme.button
  • @textTheme.subtitle
  • @textTheme.overline