パッケージ、リポジトリ、アプリカテゴリを検索

パッケージ詳細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を実現します。モジュール性を推進することで、コードの整理を向上させ、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 件

ソースリポジトリ

このパッケージを使用しているプロジェクト

データはまだありません。