OpenParable
Skip to content
← Back to skills

Shadcn Flutter

Design
shadcn-flutter

Shadcn Flutter is an Agent Skill for design published in the sunarya-thito/shadcn_flutter repository on GitHub: a SKILL.md instruction file an AI agent can load to do this task.

A comprehensive UI ecosystem for Flutter built on the shadcn/ui design system.

View on GitHub ↗
QUICK START

How to use this skill

Bring this guide into your coding agent with a prompt tailored to the tool you use.

  1. Open your project in Codex.
  2. Copy and paste the prompt below.
  3. Review files and risks before approving any action.
Prompt to paste
Inspect the Agent Skill at https://github.com/sunarya-thito/shadcn_flutter/blob/HEAD/packages/shadcn_flutter/skills/shadcn-flutter/SKILL.md and all supporting files. Report provenance, permissions, scripts, dependencies, and security risks. Propose an exact installation into .agents/skills/shadcn-flutter, but wait for my approval before writing files or running scripts.

Copying this prompt does not install or run the skill. Review third-party files before use.

Shadcn Flutter

A cohesive UI ecosystem for Flutter—components, theming, and tooling—ready to ditch Material and Cupertino. Built with modern design tokens and high-quality widgets across mobile, web, and desktop.

Getting Started

To set up a fresh Flutter application with Shadcn Flutter:

  1. Add the dependency:

    flutter pub add shadcn_flutter
    
  2. Configure your main.dart:

    import 'package:shadcn_flutter/shadcn_flutter.dart';
    
    void main() {
      runApp(
        ShadcnApp(
          title: 'My App',
          theme: ThemeData(
            colorScheme: ColorSchemes.darkSlate,
            radius: 0.5,
          ),
          home: const MyHomePage(),
        ),
      );
    }
    
    class MyHomePage extends StatelessWidget {
      const MyHomePage({super.key});
    
      @override
      Widget build(BuildContext context) {
        return const Scaffold(
          child: Center(
            child: Text('Hello World!').h1(),
          ),
        );
      }
    }
    

Guides

Learn the core concepts and design system fundamentals.

NameDescriptionPath
IntroductionOverview of the ecosystem, features, and FAQ.guides/introduction.md
InstallationStep-by-step setup for stable and experimental versions.guides/installation.md
ThemingCustomizing tokens like radius, density, and scaling.guides/theming.md
ColorsUsing the Tailwind-based color palette and ColorShades.guides/colors.md
TypographySemantic text styles and widget extensions.guides/typography.md
LayoutSpacing, gaps, and responsive layout helpers.guides/layout.md
IconsAccessing the 10,000+ bundled icons (Lucide, Radix, etc).guides/icons.md
InteropUsing Material and Cupertino widgets incrementally.guides/interop.md
State ManagementGuide to the built-in Data and Model state system.guides/state_management.md
Web PreloaderCustomizing the loading experience for web apps.guides/web_preloader.md

Components

Shadcn Flutter features over 100+ high-quality components. Below are the core categories.

Animation

ComponentPath
Number Tickercomponents/animation/number_ticker.md

Control

ComponentPath
Buttoncomponents/control/button.md

Disclosure

Display

Feedback

Form

Layout

Navigation

Overlay

Utility

[!TIP] This is a curated list. For the full list of all 100+ components, check the components directory.

Interactive Usage Tips

  1. Wait for Interaction: When using Popover or Dialog, prefer using the provided controllers for programmatic access.
  2. Lean on Extensions: Use .h1(), .p(), .iconSmall() etc., instead of manually configuring TextStyle or size.
  3. Density Matters: Use DensityContainer or theme.density to ensure spacing is consistent across platform-specific densities.