Skip to content
btwldPublic

About

A Flutter component library that combines headless UI behavior with Mix's powerful styling system, giving you complete freedom to build and customize components that match your design system perfectly.

Resources

Stars

24 stars

Watchers

0 watching

Forks

Repository files navigation

Remix banner

Remix

pub.dev CI BSD 3-Clause License

Flutter components with Naked UI behavior and Mix styling.

Website · Documentation · Naked UI documentation · Mix documentation

Core concepts

  • Naked UI owns interaction: focus, keyboard input, interaction state and accessibility.
  • Mix owns styling: specs, stylers, tokens, variants and animation.
  • Remix composes both: use Remix* with your own styles, or install a preset.
  • Presets are editable app source: choose one per app. Vanilla is neutral; Fortal has its own visual language; HeroUI follows HeroUI web 3.2.6. The CLI installs items and their dependencies.
  • The app owns its UI and host: themes, recipes, state and navigation. Supply an Overlay, Navigator or toast scope where the component needs it.
  • Registries are pinned: remix.yaml records a GitHub commit. Updating that pin and adopting changed source are separate actions.
  • Author once, generate and check: private registry_source produces the registries; apps generate adapters. Runtime packages, registry content and the CLI release independently.

Start with a component

Remix is a 1.0.0 prerelease. Pin it, because an unversioned install resolves the older stable 0.x line, which these docs do not describe.

flutter pub add remix:^1.0.0-rc.6
import 'package:flutter/widgets.dart';
import 'package:remix/remix.dart';

Widget saveButton(VoidCallback save) => RemixButton(
  label: 'Save',
  onPressed: save,
  style: ButtonStyler()
      .color(const Color(0xFF2196F3))
      .padding(.horizontal(16))
      .borderRadius(.circular(8))
      .labelColor(const Color(0xFFFFFFFF)),
);

Or install editable theme and component source:

dart pub global activate remix_cli '^1.0.0-rc.2'
remix init --preset vanilla
remix add button

Install the CLI once globally. The constraint includes the 1.0 release candidate; remix.yaml pins the registry revision used by each project. Add Pub's bin directory to PATH if needed; Pub prints the instructions. For a CLI pinned in the app's lockfile, use flutter pub add dev:remix_cli:^1.0.0-rc.2 instead and prefix each command with dart run remix_cli:, for example dart run remix_cli:remix init.

Place the installed theme above your Navigator in the host's builder before using its widgets. See setup and host requirements.

Agent skills

Copy the app UI and design-system authoring skills into a project that has run remix init. The copies come from the commit the project pins, so they describe the Remix the project installs:

remix skills install

A registry author without a remix.yaml can still install the skills from main with npx skills add btwld/remix.

To have a coding agent do the whole setup, paste the Start with AI prompt.

About

A Flutter component library that combines headless UI behavior with Mix's powerful styling system, giving you complete freedom to build and customize components that match your design system perfectly.

Resources

Stars

24 stars

Watchers

0 watching

Forks

Releases

Packages

Used by

Contributors

Languages