Skip to content
On this page

Description

Supporting text that explains a field or control.

Description in FluttyUIDescription in FluttyUI dark theme

Import

import 'package:flutter/widgets.dart';
import 'package:fluttyui/fluttyui.dart' as ui;

Usage

const ui.Description(
  child: Text('We will use this address for account updates.'),
)

API Reference

The declarations below match the current FluttyUI source. Types are shown without the optional ui. import prefix.

Description

const Description({
  super.key,
  this.size,
  required this.child,
  this.color,
  this.fontSize,
  this.fontWeight,
  this.textAlign = TextAlign.start,
  this.maxLines,
  this.overflow = TextOverflow.clip,
});
ParameterTypeRequiredDefault
keyKey?Nonull
sizeComponentSize?Nonull
childWidgetYes—
colorColor?Nonull
fontSizedouble?Nonull
fontWeightFontWeight?Nonull
textAlignTextAlignNoTextAlign.start
maxLinesint?Nonull
overflowTextOverflowNoTextOverflow.clip

Application Setup

Place components under FluttyApp to provide theme, navigation, localization, and overlay defaults. Use theme tokens for shared appearance settings.

Source

lib/src/widgets/forms/description/description.dart

This reference is generated from the Description declaration in the FluttyUI core checkout. The component catalog lists the other available building blocks.

DartFlutter

Get started with FluttyUI