Skip to main content

Feedroom List Screen

Introduction​

The Feedroom List Screen (LMFeedRoomListScreen) serves as an interface for displaying a list of feedrooms. It supports customization for the app bar, feedroom tiles, and various states like empty views or loading indicators through builders.

1. LMFeedRoomListScreen Widget​

File Location:
feedroom_list_screen.dart

Class Declaration​

class LMFeedRoomListScreen extends StatefulWidget {
  /// Builder for individual feedroom tiles.
  final Widget Function()? feedroomTileBuilder;

  /// Builder for customizing the app bar.
  final LMFeedAppBarBuilder? appBarBuilder;

  /// Builder for the empty state view.
  final LMFeedContextWidgetBuilder? noItemsFoundIndicatorBuilder;

  /// Builder for the first-page loader when no items are present.
  final LMFeedContextWidgetBuilder? firstPageProgressIndicatorBuilder;

  /// Builder for the pagination loader when more items are being loaded.
  final LMFeedContextWidgetBuilder? newPageProgressIndicatorBuilder;

  /// Builder for the view when no more items are available.
  final LMFeedContextWidgetBuilder? noMoreItemsIndicatorBuilder;

  /// Builder for the error view displayed while loading a new page.
  final LMFeedContextWidgetBuilder? newPageErrorIndicatorBuilder;

  /// A screen widget for displaying a list of feedrooms.
  const LMFeedRoomListScreen({
    Key? key,
    this.feedroomTileBuilder,
    this.appBarBuilder,
    this.noItemsFoundIndicatorBuilder,
    this.firstPageProgressIndicatorBuilder,
    this.newPageProgressIndicatorBuilder,
    this.noMoreItemsIndicatorBuilder,
    this.newPageErrorIndicatorBuilder,
  }) : super(key: key);

  @override
  State<LMFeedRoomListScreen> createState() => _LMFeedRoomListScreenState();
}

Key Parameters​

  1. feedroomTileBuilder (Widget Function()?): Builder for individual feedroom tiles.
  2. appBarBuilder (LMFeedAppBarBuilder?): Builder for customizing the app bar.
  3. noItemsFoundIndicatorBuilder (LMFeedContextWidgetBuilder?): Builder for the empty state view.
  4. firstPageProgressIndicatorBuilder (LMFeedContextWidgetBuilder?): Builder for the first-page loader when no items are present.
  5. newPageProgressIndicatorBuilder (LMFeedContextWidgetBuilder?): Builder for the pagination loader when more items are being loaded.

For the complete source code, refer to the GitHub link.

2. LMFeedRoomListBuilderDelegate​

File Location:
builder.dart

Class Declaration​

class LMFeedRoomListBuilderDelegate extends LMFeedWidgetBuilderDelegate {
  const LMFeedRoomListBuilderDelegate();
}

The LMFeedRoomListBuilderDelegate allows developers to customize the feedroom tiles, empty states, and loaders specifically for the feedroom list screen.

Methods in LMFeedRoomListBuilderDelegate​

  1. feedroomTileBuilder
    Definition: Builds the widget for feedroom tiles in the feedroom list screen.
    Purpose: Customizes the style and layout of feedroom tiles.

    Usage Example:

    @override
    Widget feedroomTileBuilder(BuildContext context) {
      // Return a custom widget for displaying feedroom tiles
      return CustomFeedroomTile();
    }

  2. emptyStateWidget
    Definition: Builds the widget for the empty state in the feedroom list screen.
    Purpose: Customizes the appearance and behavior of the empty state.

    Usage Example:

    @override
    Widget emptyStateWidget(BuildContext context) {
      // Return a custom widget for the empty state
      return CustomEmptyStateWidget();
    }

  3. loaderWidget
    Definition: Builds the loader widget for the feedroom list screen.
    Purpose: Provides a way to customize the loader.

    Usage Example:

    @override
    Widget loaderWidget(BuildContext context) {
      // Return a custom loader widget
      return CustomLoader();
    }

Remaining Methods​

Explore the complete list of methods here.

3. LMFeedRoomListSetting​

File Location:
settings.dart

class LMFeedRoomListSetting {
  const LMFeedRoomListSetting();
}
  • Purpose: Provides configuration settings for the Feedroom List Screen. No additional fields or methods are currently defined.

4. LMFeedRoomListStyle​

File Location:
style.dart

class LMFeedRoomListStyle {
  const LMFeedRoomListStyle();
}
  • Purpose: Defines styling options for the Feedroom List Screen. No fields or methods are currently defined.

5. LMFeedRoomListConfig​

File Location:
config.dart

Class Declaration​

class LMFeedRoomListConfig {
  final LMFeedRoomListBuilderDelegate builder;
  final LMFeedRoomListSetting setting;
  final LMFeedRoomListStyle style;

  const LMFeedRoomListConfig({
    this.builder = const LMFeedRoomListBuilderDelegate(),
    this.setting = const LMFeedRoomListSetting(),
    this.style = const LMFeedRoomListStyle(),
  });
}

Usage Example: Injecting Custom Configuration​

  1. Create a Custom Builder:

    class CustomFeedroomListBuilder extends LMFeedRoomListBuilderDelegate {
      @override
      Widget feedroomTileBuilder(BuildContext context) {
        return Text('Custom Feedroom Tile');
      }
    }

  2. Pass Custom Style or Setting along with Builder:

    final customStyle = LMFeedRoomListStyle();
    final customSetting = LMFeedRoomListSetting();

  3. Inject the Custom Builder, Style, or Setting into the Config:

    final feedroomListConfig = LMFeedRoomListConfig(
      builder: CustomFeedroomListBuilder(),
      setting: customSetting,
      style: customStyle,
    );

  4. Initialize with Custom Config:

    LMFeedCore.instance.initialize(
      config: LMFeedConfig(
        feedroomListConfig: feedroomListConfig,
      ),
    );

6. Summary​

The Feedroom List Screen provides a user interface for displaying a list of feedrooms. Developers can customize components like tiles, app bars, and empty states using the LMFeedRoomListBuilderDelegate. Configuration options are encapsulated in LMFeedRoomListConfig, enabling seamless integration and customization tailored to specific design and functional requirements.