docs(ui_layout-bloc_layouts): add readmes
continuous-integration/drone/push Build is failing

This commit was merged in pull request #167.
This commit is contained in:
2023-02-28 17:50:16 +01:00
parent 7c97417233
commit 358debf2fa
2 changed files with 77 additions and 14 deletions
+41 -7
View File
@@ -1,5 +1,5 @@
<!--
* Copyright (C) 2022 WYATT GROUP
* Copyright (C) 2023 WYATT GROUP
* Please see the AUTHORS file for details.
* This program is free software: you can redistribute it and/or modify
@@ -25,11 +25,45 @@
<img src="https://img.shields.io/badge/SDK-Flutter-blue?style=flat-square" alt="SDK: Flutter" />
</p>
Wyatt Ui Layout for Flutter
Wyatt UI Layout is a Flutter package that provides pre-built layouts to make the development of graphical user interfaces (GUIs) easier. There are two types of layouts provided by this package: structural and content layouts.
## Features.
### Structural Layouts
- Layouts :
- App Bar Layout
- Bottom Navigation Bar Layout
- Frame Layout (wrapp both appbar & bottom bar)
Structural layouts are used to structure the GUI, and there are currently four layouts provided by this package:
- #### TopAppBarLayout
This layout is used to create a GUI with a classic app bar and a body.
- #### TopNavigationBarLayout
This layout is used to create a GUI with an app bar that includes navigation options and a body.
- #### BottomNavigationBarLayout
This layout is used to create a GUI with a bottom bar that includes navigation options and a body.
- #### FrameLayout
This layout is used to create a GUI that includes a classic app bar, a bottom navigation bar, and a body.
### Content Layouts
Content layouts are used to display dynamic data and content within the GUI. Currently, there is only one content layout provided by this package:
- #### GridLayout
This layout is used to display data and content in a grid layout.
### Installation
To use Wyatt UI Layout in your Flutter project, add the following dependency to your pubspec.yaml file:
```yaml
wyatt_ui_layout:
git:
url: https://git.wyatt-studio.fr/Wyatt-FOSS/wyatt-packages
path: packages/wyatt_ui_layout
```
That's it! You're now ready to use Wyatt UI Layout in your project.