Skip to content

Flutter widgets that support TailwindCSS options and configurations via code generation

License

Notifications You must be signed in to change notification settings

SquintInc/breeze_ui

Repository files navigation

TODO: Put a short description of the package here that helps potential users know whether this package might be useful for them.

Features

List of supported TailwindCSS options

The following tables lists all the TailwindCSS options (from the sidebar on https://tailwindcss.com/docs/configuration) and whether they have an equivalent representation in Flutter via breeze_ui.

Layout
Option Supported Notes
Aspect Ratio
Container
Columns
Break After
Break Before
Break Inside
Box Decoration Break
Box Sizing
Display
Floats
Clear
Isolation
Object Fit
Object Position
Overflow ✅ ℹ️ Some Tw widgets support a scrollable boolean flag which allows its child contents to be scrollable. This is similar to overflow-auto for a specific axis when enabled.
Overscroll Behavior
Position
Top / Right / Bottom / Left
Visibility
Z-Index
Flexbox & Grid
Option Supported Notes
Flex Basis
Flex Direction
Flex Wrap
Flex
Flex Grow
Flex Shrink
Order
Grid Template Columns
Grid Column Start / End
Grid Template Rows
Grid Row Start / End
Grid Auto Flow
Grid Auto Columns
Grid Auto Rows
Gap supported by TwRow and TwColumn
Justify Content
Justify Items
Justify Self
Align Content
Align Items
Align Self
Place Content
Place Items
Place Self
Spacing
Option Supported Notes
Padding
Margin
Space Between this option on the web is a shortcut for modifying all child margins (see explanation), hence this effect is not worth replicating in Flutter - it's best to use Gap instead
Sizing
Option Supported Notes
Width min-content, max-content, and fit-content not supported
Min-Width min-content, max-content, and fit-content not supported
Max-Width min-content, max-content, and fit-content not supported
Height min-content, max-content, and fit-content not supported
Min-Height min-content, max-content, and fit-content not supported
Max-Height min-content, max-content, and fit-content not supported
Typography
Option Supported Notes
Font Family use Flutter idiomatic ways of setting font family instead
Font Size
Font Smoothing
Font Style ✅ ℹ️ use dart:ui's FontStyle
Font Weight
Font Variant Numeric
Letter Spacing
Line Clamp ✅ ℹ️ use maxLines property where applicable in Flutter
Line Height
List Style Image consider creating a native Flutter widget to set the style of a "list marker"
List Style Position consider creating a native Flutter widget to set the style of a "list marker"
List Style Type consider creating a native Flutter widget to set the style of a "list marker"
Text Align ✅ ℹ️ use dart:ui's TextAlign
Text Color
Text Decoration ✅ ℹ️ use dart:ui's TextDecoration
Text Decoration Color
Text Decoration Style ✅ ℹ️ use dart:ui's TextDecorationStyle
Text Decoration Thickness
Text Underline Offset
Text Transform modify the supplied string values instead when passing them into Flutter widgets
Text Overflow ✅ ℹ️ use TextOverflow as part of the overflow property in text widget constructors
Text Indent
Vertical Align use Flutter widgets' native alignment properties
Whitespace modify the supplied string values instead when passing them into Flutter widgets
Word Break use Flutter softWrap property on Text related widgets, and other Flutter idiomatic practices (e.g. Wrap, and Expanded / Flexible)
Hyphens
Content this option is a web shortcut for controlling the content of the before and after pseudo-elements; consider creating native Flutter widgets instead
Backgrounds
Option Supported Notes
Background Attachment
Background Clip
Background Color
Background Origin
Background Position
Background Repeat
Background Size
Background Image
Gradient Color Stops
Borders
Option Supported Notes
Border Radius does not support border-start-* and border-end-* logical properties
Border Width does not support border-inline-start-* and border-inline-end-* logical properties
Border Color currently does not support setting individual border side colors
Border Style
Divide Width
Divide Color
Divide Style
Outline Width
Outline Color
Outline Style
Outline Offset
Ring Width
Ring Color
Ring Offset Width
Ring Offset Color
Effects
Option Supported Notes
Box Shadow inner / inset box shadows are not supported and will be parsed as a none shadow
Box Shadow Color
Opacity
Mix Blend Mode
Background Blend Mode
Filters
Option Supported Notes
Blur
Brightness
Contrast
Drop Shadow
Grayscale
Hue Rotate
Invert
Saturate
Sepia
Backdrop Blur
Backdrop Brightness
Backdrop Contrast
Backdrop Grayscale
Backdrop Hue Rotate
Backdrop Invert
Backdrop Opacity
Backdrop Saturate
Backdrop Sepia
Tables
Option Supported Notes
Border Collapse
Border Spacing
Table Layout
Caption Side
Transitions & Animation
Option Supported Notes
Transition Property
Transition Duration
Transition Timing Function
Transition Delay
Animation
Transforms
Option Supported Notes
Scale
Rotate
Translate
Skew
Transform Origin
Interactivity
Option Supported Notes
Accent Color
Appearance
Cursor
Caret Color
Pointer Events
Resize
Scroll Behavior
Scroll Margin
Scroll Padding
Scroll Snap Align
Scroll Snap Stop
Scroll Snap Type
Touch Action
User Select
Will Change
SVG
Option Supported Notes
Fill
Stroke
Stroke Width
Accessibility
Option Supported Notes
Screen Readers

Getting started

TODO: List prerequisites and provide or point to information on how to start using the package.

Usage

TODO: Include short and useful examples for package users. Add longer examples to /example folder.

const like = 'sample';

Additional information

TODO: Tell users more about the package: where to find more information, how to contribute to the package, how to file issues, what response they can expect from the package authors, and more.

About

Flutter widgets that support TailwindCSS options and configurations via code generation

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published