Wyatt UI Components

Wyatt UI Components for Flutter. This package defines all the components used in Wyatt Studio with their set of properties. But there is no implementation of the components. You have to create your own or check out Wyatt UI Kit package.

Usage

Configuration

First create all your custom components in domain/entities folder. For exemple :

├── domain
│ ├── entities
│ │ ├── custom_app_bar.dart
│ │ ├── custom_bottom_navigation_bar.dart
│ │ └── ...
│ └── ...
└── ...

Run flutter pub run build_runner build to generate your components.

Then, add your components to ComponentThemeData class. You can utilize multiple components of the same type, such as having multiple top app bars or distinct cards. However, it's necessary to distinguish them using identifiers. Extensions are provided to make your life easier. Note that it's not obligatory to assign an identifier to a component if there's only one of its kind. Here's an example:

class AppThemeComponent {
  static ComponentThemeData get components => ComponentThemeData.raw(
        topAppBars: const {
          'root': CustomRootAppBar(),
          'second': CustomSecondAppBar(),
        }.registry(),
        bottomNavigationBars: const CustomBottomNavigationBar().registry(),
        errors: const CustomErrorWidget().registry(),
        loaders: const CustomLoaderWidget().registry(),
      );
}

I've rephrased the sentence while maintaining the original meaning and intent.

Provider

In you main file, before calling router, call ComponentTheme widget and give your app as child. For example :

void main() {
  runApp(const MyApp());
}

class MyApp extends StatelessWidget {
  const MyApp({super.key});

  @override
  Widget build(BuildContext context) => ComponentTheme(
        componentThemeWidget: AppThemeComponent.components,
        child: MaterialApp(
          title: 'Wyatt Ui Layout Example',
          theme: ThemeData(
            primarySwatch: Colors.blue,
          ),
          home: const ..,
        ),
      );
}

Call

Then you're ready to call all your components from everywhere in your app using :

context.components,

For example :

  context.components.topAppBarComponent()(),

  appBar: context.components.topAppBarComponent().call(),

If you require specific settings or want to pass parameters to your component, simply provide them when you call your component.

  context.components.loaderComponent()(
    colors: const MultiColor.single(Colors.green),
  ),

And if you have only one parameter to modify, you can directly call it as shown below:

  context.components.loaderComponent().
    colors(const MultiColor.single(Colors.green)),

Default implementation

To use this package, you have to create your own implementation of the components. You can check out Wyatt UI Kit package for an example.

But default theme extensions (used in all implementations as fallback for styles) are available in lib/src/domain/theme_extensions folder.

Development

Common to this, and Wyatt UI Kit packages.

Add a new component :

Wyatt UI Components side

Create a new file in lib/src/domain/entities folder.
Add your component class.
Add your component class to ComponentThemeData abstract class.
Run flutter pub run build_runner build to generate your component proxy properties.

Wyatt UI Kit side

Create a new file in lib/src/components folder.
Add your component class, styles, (and logic if needed)
Run flutter pub run build_runner build to generate your component copy with method.
Add a theme extension to your component class in lib/src/domain/
Add your component class wyattComponentThemeData static property in lib/src/features/wyatt_component_theme_data.dart

5.1 KiB Raw Permalink Blame History