Getting Started with Alphasow UI
Welcome to Alphasow UI - a comprehensive Flutter package providing reusable UI components with consistent theming and platform adaptation.
What is Alphasow UI?β
Alphasow UI is a Flutter package that offers:
- π¨ Consistent Theming - Centralized theme system with dark/light mode support
- π± Platform Adaptive - Automatic Material/Cupertino styling based on platform
- π Banner System - Built-in notification overlay system
- π§© Comprehensive Components - Buttons, inputs, alerts, loaders, menus, and more
- π Accessibility - Built-in accessibility support across all components
What you'll needβ
- Flutter SDK version 3.16.0 or above
- Dart SDK version 3.5.3 or above
Installationβ
Add Alphasow UI to your Flutter project by adding it to your pubspec.yaml file:
dependencies:
alphasow_ui: ^1.25.0
Then run:
flutter pub get
Quick Startβ
1. Wrap your app with AlphasowUiAppβ
To enable all Alphasow UI features, wrap your application with AlphasowUiApp:
import 'package:alphasow_ui/alphasow_ui.dart';
import 'package:flutter/material.dart';
void main() {
runApp(const MyApp());
}
class MyApp extends StatelessWidget {
const MyApp({super.key});
@override
Widget build(BuildContext context) {
return AlphasowUiApp(
title: 'My App',
home: const HomePage(),
);
}
}
2. Start using componentsβ
Now you can use any Alphasow UI component in your app:
class HomePage extends StatelessWidget {
const HomePage({super.key});
@override
Widget build(BuildContext context) {
return AsScaffold(
appBar: AsAppBar(
title: const Text('Welcome to Alphasow UI'),
),
body: Padding(
padding: const EdgeInsets.all(16.0),
child: Column(
crossAxisAlignment: CrossAxisAlignment.stretch,
children: [
// Primary Button
AsButton(
onPressed: () {
context.showBanner(
message: 'Hello from Alphasow UI!',
type: AlertType.success,
);
},
child: const Text('Show Success Banner'),
),
const SizedBox(height: 16),
// Text Field
const AsTextField(
labelText: 'Enter your name',
hintText: 'John Doe',
),
const SizedBox(height: 16),
// Loading Spinner
const AsLoadingSpinner(),
],
),
),
);
}
}
3. Platform Adaptationβ
Alphasow UI automatically adapts to your platform:
- iOS/macOS: Uses Cupertino styling
- Android/Web: Uses Material Design styling
No additional configuration needed - it works out of the box!
Next Stepsβ
- π Explore Components - Learn about all available components
- π Live Demo - See components in action
Need Help?β
- π Browse the component documentation
- π Report issues on GitHub
- π‘ Check out our contributing guide