搜索插件、代码仓与 APP 分类

插件详情v1.0.0

lumen_ui

Lumen UI 是一个用于 Flutter 的 CLI 工具,可按需生成模块化 UI 组件,以保持应用程序轻量化且易于维护。

AndroidiOSmacOSWindowsLinux
近 30 天下载
24
喜欢数
2
Pub 分数
130

安装插件

flutter pub add lumen_ui

插件介绍

基于插件公开信息、社区数据与项目使用情况整理的选型参考。

Lumen UI 是一个用于 Flutter 的 CLI 工具,可自动创建模块化、可重用的 UI 组件。它通过按需生成结构良好的小部件,帮助开发者保持应用轻量化和可扩展性。该工具与 Flutter 项目无缝集成,支持多个平台,确保在 Android、iOS、macOS、Windows 和 Linux 上实现一致的 UI。通过促进模块化,Lumen UI 提升了代码组织性,并减少了 UI 开发中的冗余。

适合场景

  • 快速UI原型设计
  • 保持设计系统的统一性
  • 减少样板代码
  • 扩展大型Flutter应用
  • 自动化组件创建

主要特点

  • CLI 驱动的组件生成
  • 模块化且可重用的部件模板
  • 跨平台支持
  • 轻量输出
  • 与 Flutter pub 包系统集成

适合对象

  • Flutter 团队优先考虑可维护性
  • 开发设计密集型应用的开发者
  • 需要快速UI迭代的项目
  • 使用组件化架构的团队
  • 专注于前端的Flutter开发者

使用建议

  • 需要熟悉 CLI 工作流
  • 生成后可能需要自定义
  • 依赖稳定的 Flutter 环境
  • 最适合在结构化的项目设置中使用
  • 不是运行时库,而是一个开发工具

原始 README

以下为关联源码仓库的 README 原文快照,最新内容请访问源码仓库。

Lumen UI

A CLI-based Flutter package for generating modular, customizable UI components on demand.

Motivation

Flutter developers often struggle with bloated UI component libraries that increase app size and affect performance. Lumen UI CLI solves this by providing a command-line tool that generates only the components you need, with full customization options.

Features

  • Modular UI component generation
  • Customizable component templates
  • Theme and style configuration options
  • Material Design and Cupertino guideline compliance
  • Inline documentation for generated components

Full Documentation

For complete knowledge about the package, please visit the official documentation website:

Lumen UI Documentation

Installation

Follow these steps to set up your Flutter project and integrate Lumen UI:

1. Create a New Flutter Project

Using Flutter CLI
 flutter create my_app
 cd my_app
Using VS Code
  1. Press Ctrl+Shift+P (Windows/Linux) or Cmd+Shift+P (macOS)
  2. Type "Flutter: New Project"
  3. Select "Application"
  4. Choose project directory
  5. Name your project
Using Android Studio
  1. Click "New Flutter Project" from welcome screen
  2. Select Flutter project type
  3. Configure project settings
  4. Click "Finish"

📚 New to Flutter? Check out the official Flutter documentation for detailed setup instructions.

2. Add Lumen UI to Your Project

Add this line to your pubspec.yaml under dependencies:

dev_dependencies:
  flutter_test:
    sdk: flutter
  lumen_ui: 0.0.1 # Add Lumen UI package

3. Install Dependencies

Run this command in your project directory:

flutter pub get

4. Verify Installation

Run this command to verify the installation:

flutter pub list

You should see lumen_ui: 1.0.0 in the list of installed packages.


🎉 Congratulations! You're now ready to use Lumen UI in your Flutter project.

Continue to the Usage section to learn how to implement Lumen UI components.

Usage

dart run lumen_ui [options]
Options
Option Alias Description Required
--type -t Type of component to generate Yes
--name -n Name of the component Yes
--output -o Output directory (defaults to lib/ui) No
--help -h Show help information No
--version -v Show version information No
--verbose - Enable verbose logging No
Component Types
  • button: Button components
  • dummy: Dummy components for testing
Component Naming Rules
  • Must start with a letter
  • Can contain letters, numbers, and underscores
  • Cannot contain spaces or special characters

Examples

List all supported types and their related UIs:

dart run lumen_ui --list

List all supported component types:

dart run lumen_ui --list-types

List related UIs for a specific component type:

dart run lumen_ui --list-uis button

Generate a primary button:

dart run lumen_ui -t button -u primarybutton -n primary

Generate with custom output directory:

dart run lumen_ui -t button -u iconbutton -n iconbtn -o lib/components 

Output Structure

Components are generated in the following structure:

lib/ui/
  ├── buttons/
  │   └── primary_button
        └── primary_button.dart
  └── styles/
      └── color.dart
      └── styles.dart

Error Handling

Common error messages and solutions:

  • Both --type, --ui and --name are required: Ensure both -t, -u and -n options are provided
  • Invalid component name: Follow the component naming rules
  • Error parsing arguments: Check the command syntax
  • Invalid argument format: Verify option values are correct

Additional Commands

Show help:

dart run lumen_ui --help

Show version:

dart run lumen_ui --version

Architecture

The project follows a Layered Architecture pattern with:

  • HMI Layer: Command-line interface
  • Service Layer: Component generation and template services
  • Application Layer: Core business logic
  • Communication Layer: File system operations

Technology Stack

  • Dart SDK (>=2.18.0)
  • Flutter SDK (>=3.0.0)
  • Development Tools: VS Code, Android Studio
  • CLI Framework: args/cli_util

Contributing

  1. Fork the repository
  2. Create your feature branch
  3. Commit your changes
  4. Push to the branch
  5. Create a Pull Request

Requirements

  • Processor: Intel Core i5 or equivalent
  • RAM: 8GB minimum (16GB recommended)
  • Storage: 500GB SSD
  • Operating Systems: Windows, macOS, or Linux

License

MIT License

Authors

所属分类

依赖

依赖清单 4 项

源码仓库

使用此插件的项目

暂无相关数据。