API Reference

Complete API documentation for all Flutter Beautify components, factory methods, and properties.

Using This Reference

All components follow a consistent pattern:

FB{ComponentName}.{factoryMethod}(
  // Required properties
  // Optional properties
)

---

Component Index

Form Components

• TextField
• Checkbox
• RadioButton
• Switch
• Slider

Button Components

• Button
• IconButton
• FAB
• ToggleButton

Layout Components

• Card
• BottomSheet
• Sidebar
• Breadcrumb
• Accordion

Navigation Components

• AppBar
• BottomNavigationBar
• Tabs
• Pagination
• Avatar

Progress & Loading

• LinearProgress
• CircularProgress
• Toast
• CircularLoader

Feedback & Status

• Dialog
• Snackbar
• Badge
• Tooltip

---

Common Property Types

Sizes

enum ButtonSize { small, medium, large }

Colors

All color properties accept Color objects from flutter/material.dart:

backgroundColor: Colors.blue
textColor: Color(0xFF123456)

Callbacks

typedef VoidCallback = void Function();
typedef ValueChanged<T> = void Function(T value);
typedef WidgetBuilder = Widget Function(BuildContext context);

Icons

Use IconData from Material Design Icons:

icon: Icons.save
icon: Icons.delete
icon: Icons.add_circle

---

Theming

All components respect the current BuildContext theme:

// Dark theme
ThemeData(
  brightness: Brightness.dark,
  primaryColor: Colors.blue,
)

// Light theme (default)
ThemeData(
  brightness: Brightness.light,
  primaryColor: Colors.blue,
)

---

Accessibility

Flutter Beautify components follow Material Design accessibility guidelines:

• ✅ Semantic labels for screen readers
• ✅ Adequate color contrast ratios
• ✅ Touch target sizes ≥ 48dp
• ✅ Keyboard navigation support

---

For detailed documentation of each component and its parameters, see Components.