Installation

Include this configuration in your pubspec.yaml.

dependencies:
  catalog: ^0.0.1                                   # android   ios   linux   macos   web   windows

catalog:
  base: "lib"                                       # app src
  output: "ui/catalog"                              # catalog path -> /lib/ui/catalog/
  pageFile: "catalog_component.dart"                # catalog page file
  pageName: "CatalogComponent"                      # catalog page class
  pageRoute: "catalog"                              # catalog route -> /catalog
  runtimeConfigHolder: "assets/preview_config.json"
  suffix: "preview"                                 # file suffix for preview files -> my_widget.preview.dart

• base: The src path of your Flutter project. Default lib.
• output: The path where your catalog will be created or updated. In this example ui/catalog produces /lib/ui/catalog/.
• pageFile: The file name of your catalog page.
• pageName: The class name of your catalog page.
• pageRoute: The catalog's route.
• suffix: Suffix used for identify preview files.