Installation

How to install flutterwind in your app.

Flutterwind is designed to work seamlessly across all Flutter-supported platforms, ensuring a consistent styling experience no matter where your app runs.

Using the package

Install the FLutterwind

Terminal

flutter pub add flutterwind_core

Alternatively, you can add the dependency to your pubspec.yaml file

dependencies:
  flutterwind_core: latest_version

Now you can execute the following command to install the dependencies:

flutter pub get

Initialize Flutterwind

Terminal

flutter pub run flutterwind init

tailwind.config.yaml file will be created on root of your project for Flutterwind. It's where you can customize your design system, specify your color palette, fonts, breakpoints, and more.

Setup Flutterwind Config

Navigate to Entrypoint

Import the package in your main.dart file.

main.dart

import 'package:flutterwind_core/flutterwind.dart';

Now you can override the default code and wrap it with Flutterwind widget.

main.dart

void main() {
  runApp(
    FlutterWind(
      child: MyApp(),
    ),
  );
}

Well done! Now you can start using Flutterwind in your project.

Edit this page

Goals & Non Goals

Flutterwind Styling Scope & Limitations.

Configuration System

A configuration system similar to Tailwind CSS, allowing you to customize the default values and behavior of the framework.

On This Page

Using the package

Star on GitHub Create Issues Edit this page