Page Switcher View

A brick to create the directory structure and boilerplate to implement a feature leveraging the page-switcher-view pattern.

For more information on this pattern check out this blog.

Note: This brick uses Super Initializers for view widgets. Therefore, make sure you're using dart 2.17 on your end.

💻 How to use

mason make page_switcher_view --app_name "cool app" --feature_name whatever

🎲 Variables

✅ Outputs

Directory Structure

├── whatever
│   ├── bloc
│   │   ├── whatever_bloc.dart
│   │   ├── whatever_event.dart
│   │   └── whatever_state.dart
│   ├── view
|   |   ├── view.dart
│   │   ├── whatever_page.dart
│   │   ├── whatever_switcher.dart
│   │   └── whatever_view.dart
│   ├── widgets
│   │   └── widgets.dart
│   └── whatever.dart
└── ...

Files Content

whatever_bloc.dart

import 'dart:async';

import 'package:bloc/bloc.dart';
import 'package:equatable/equatable.dart';

part 'whatever_event.dart';
part 'whatever_state.dart';

class WhateverBloc extends Bloc<WhateverEvent, WhateverState> {
  WhateverBloc() : super(const WhateverState()) {
    on<WhateverDataRequested>(_dataRequested);
  }

  FutureOr<void> _dataRequested(
    WhateverDataRequested event,
    Emitter<WhateverState> emit,
  ) async {
    emit(state.copyWith(status: WhateverStatus.loading));
    try {
      // TODO(you): INITIAL ASYNC CALL
      emit(state.copyWith(status: WhateverStatus.success));
    } catch (error, stackTrace) {
      addError(error, stackTrace);
      emit(state.copyWith(status: WhateverStatus.error));
    }
  }
}

whatever_event.dart

part of 'whatever_bloc.dart';

abstract class WhateverEvent extends Equatable {
  const WhateverEvent();

  @override
  List<Object> get props => [];
}

class WhateverDataRequested extends WhateverEvent {}

whatever_state.dart

part of 'whatever_bloc.dart';

enum WhateverStatus { initial, loading, success, error }

class WhateverState extends Equatable {
  const WhateverState({this.status = WhateverStatus.initial});

  final WhateverStatus status;

  @override
  List<Object> get props => [status];

  WhateverState copyWith({
    WhateverStatus? status,
  }) {
    return WhateverState(
      status: status ?? this.status,
    );
  }
}

view.dart

export 'whatever_page.dart';
export 'whatever_switcher.dart';
export 'whatever_view.dart';

whatever_page.dart

import 'package:flutter/material.dart';
import 'package:flutter_bloc/flutter_bloc.dart';
import 'package:cool_app/whatever/whatever.dart';

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

  static String path = 'whatever';

  @override
  Widget build(BuildContext context) {
    return Scaffold(
      body: BlocProvider(
        create: (context) => WhateverBloc()..add(WhateverDataRequested()),
        child: const WhateverSwitcher(),
      ),
    );
  }
}

whatever_switcher.dart

import 'package:flutter/material.dart';
import 'package:flutter_bloc/flutter_bloc.dart';
import 'package:cool_app/whatever/whatever.dart';

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

  @override
  Widget build(BuildContext context) {
    final status = context.select(
      (WhateverBloc bloc) => bloc.state.status,
    );
    switch (status) {
      case WhateverStatus.initial:
      case WhateverStatus.loading:
        // TODO(you): CREATE CUSTOM LOADING VIEW
        return const Center(child: CircularProgressIndicator());
      case WhateverStatus.success:
        return const WhateverView();
      case WhateverStatus.error:
        // TODO(you): CREATE CUSTOM ERROR VIEW
        return Center(
          child: Column(
            mainAxisAlignment: MainAxisAlignment.center,
            children: [
              const Text('Something went wrong.'),
              const SizedBox(height: 16),
              ElevatedButton(
                onPressed: () {
                  context.read<WhateverBloc>().add(WhateverDataRequested());
                },
                child: const Text('Try again'),
              ),
            ],
          ),
        );
    }
  }
}

whatever_success.dart

import 'package:flutter/material.dart';

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

  @override
  Widget build(BuildContext context) {
    return Center(
      child: Text('Success'),
    );
  }
}

widgets.dart

export 'bloc/whatever_bloc.dart';
export 'view/view.dart';
export 'widgets/widgets.dart';

Setup 🧑‍💻

Ensure you have the mason_cli installed.

# 🎯 Activate from https://pub.dev
dart pub global activate mason_cli

# 🍺 Or install from https://brew.sh
brew tap felangel/mason
brew install mason

Installation ☁️

# Install locally
mason add page_switcher_view

# Install globally
mason add -g page_switcher_view

Usage 🚀

mason make page_switcher_view

Variables ✨

Hooks 🪝

• ❌   Pre-Gen
• ❌   Post-Gen

Environment 🌎

mason: "any"

1.0.0

• Initial stable release

MIT License

Copyright (c) 2022 Alejandro Ferrero

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.