Skip to content

SimonErich/obers_ui

Repository files navigation

obers_ui

CI License: MIT

A comprehensive Flutter UI kit with design tokens, responsive utilities, and accessible components.

Installation

Add obers_ui to your pubspec.yaml:

dependencies:
  obers_ui:
    git:
      url: https://github.com/simonerich/obers_ui.git

Or for local development:

dependencies:
  obers_ui:
    path: ../obers_ui

Quick Start

import 'package:flutter/material.dart';
import 'package:obers_ui/obers_ui.dart';

void main() {
  runApp(
    MaterialApp(
      // Register the obers_ui theme extension
      theme: ThemeData.light().copyWith(
        extensions: const [
          // OiTheme(data: OiThemeData.light()),
        ],
      ),
      darkTheme: ThemeData.dark().copyWith(
        extensions: const [
          // OiTheme(data: OiThemeData.dark()),
        ],
      ),
      home: const MyApp(),
    ),
  );
}

Components

Category Widgets
Theme OiTheme, OiColors, OiTypography, OiSpacing, OiRadius, OiShadows, OiDurations, OiBreakpoints
Components OiButton, OiCard, OiText, OiInput, OiCheckbox, OiDivider, OiSpacer, OiSurface, OiIconButton
Widgets OiAvatar, OiBadge, OiToggle, OiModal, OiHoverCard, OiEmptyState, OiLoadingState, OiErrorState
Layouts OiAppShell, OiResponsiveBuilder, OiResponsiveWidget

Widget Prefix

All obers_ui widgets use the Oi prefix to avoid naming conflicts with Flutter's built-in widgets.

Example

Run the example app to see all components in action:

cd example
flutter run

Documentation

Generate API documentation:

dart doc

The generated docs will be in doc/api/.

Contributing

See CONTRIBUTING.md for development setup and guidelines.

License

MIT License - see LICENSE for details.

About

No description, website, or topics provided.

Resources

License

Contributing

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors

Languages