diff --git a/packages/wyatt_ui_kit/README.md b/packages/wyatt_ui_kit/README.md index 86e4538b..5f2c54c7 100644 --- a/packages/wyatt_ui_kit/README.md +++ b/packages/wyatt_ui_kit/README.md @@ -25,6 +25,21 @@ UIKit and Design System used in Wyatt Studio. +## Theme negociation + +When building a component, most of its attributes can be 'null'. +The `build()` method then starts to negotiate the theme in the tree to obtain the most consistent style possible. + +Explanation: + +When you build a component `Button({double? radius})`. +You have several possibilities: +1) Pass the "radius" into the constructor, `Button(radius: 12)`. +2) Set up a theme extension `ButtonThemeExtension(radius: 15)`. +3) Let `wyatt_ui_kit` "negotiate" and try to find a suitable style in the flutter theme. If this negotiation phase fails, then the style is simply not applied. + +If, for example, you don't use option 1, then the radius will be 15. If you use neither option 1 nor option 2 then the radius will be 4 as this is the [official Material Design value](https://m2.material.io/design/shape/about-shape.html#shape-customization-tool). + ## Features TODO: List what your package can do. Maybe include images, gifs, or videos.