Search packages, repositories and app categories

GitHub repositoryRannie/flui

flui

A powerful UI framework for Google Flutter.

flui project cover
Stars
1.5K
Forks
134
Last push (UTC)
May 18, 2023
Project status
Active

Original README

English project snapshot. Visit GitHub for the latest content.

English | 简体中文


FLUI

A powerful UI framework for Google Flutter Demo apk

pub package CI Status Documentation GitHub stars GitHub forks GitHub license

Features

  • A set of high-quality Flutter widgets out of the box
  • Comprehensive usage examples and documentation
  • Fine-grained non-stylized widgets for different types of applications
  • Supports Dark Mode and RTL
  • Dynamic rendering module -- Dynamic

Compatibility

FLUI has good compatibility on multiple clients, and the framework will be developed based on Flutter Stable Channel.

Currently supports v1.17.0 .

Getting Started

Setup
dependencies:
  flui: 0.9.2

Then run flutter pub get to download the dependencies.

Usage

After the dependency installed, you can directly import the widget.

import 'package:flui/flui.dart';

// in somewhere
FLAppBarTitle(
    title: 'AppBar',
    subtitle: '(subtitle)',
    layout: FLAppBarTitleLayout.vertical,
    showLoading: true
)

Widgets

Dynamic

dynamic-post

FLUI-Dynamic is a dynamic rendering module that supports rendering widgets based on json strings or objects of a specified type. For more introduction and usage, please see Dynamic

Widget buildDynamicWidget() {
    return FLDyContainer(
       jsonObject: $JSON_STRING_OR_OBJECT,
       placeholder: CircularProgressIndicator(
         strokeWidth: 3.0,
         valueColor: AlwaysStoppedAnimation(Theme.of(context).accentColor),
       ),
    );
}

Contributing

Principles:

  • Branches that submit new widgets should be named 'feature-' + widget name. Fixing issues need to be prefixed with 'bugfix-'
  • The submitted widgets need to be general. If the widget is rare or not sure whether it needs to be added to FLUI, you can raise a issue which starts with [feature] for discussion
  • The API design of the new widget is as standard and readable as possible, following the naming and usage rules of Flutter's official widgets.
  • Please comment above properties and methods how to use it so that I can add to the documentation and examples.
  • Commit messages: prefix with feat | fix | docs | style | refactor | perf | test | workflow | ci | chore | types:.

License

MIT License

Hanran GitHub avatar
GitHub author

Hanran ↗

Developer

LanguagesDartRubyObjective-CShellJava

Categories

Packages published by this repository

Dependencies used

Dependency list 6 items

Rankings

How do I choose a repository?

Start with your use case, compare repository activity, and check the original project before adopting it.

  1. Search by repository name, owner or description, then narrow the results by topic.
  2. Compare stars, forks and recent pushes. Stars show community interest, not a guarantee of quality.
  3. Read the README, license and issues on GitHub before using a project.

Sources and maintenance

“A repository is the most basic element of GitHub.”

GitHub Docs — About repositories ↗