Myzel394/Alibi
1
0
Fork 0
mirror of https://github.com/Myzel394/Alibi.git synced 2025-06-18 23:05:26 +02:00
Code Issues Packages Projects Releases Wiki Activity

chore(docs): Add documentation for ui folder

Browse Source 
Signed-off-by: Myzel394 <50424412+Myzel394@users.noreply.github.com>
This commit is contained in:
Myzel394 2024-02-23 22:51:31 +01:00
parent f426cfe287
commit ba50d48f23
No known key found for this signature in database
GPG Key ID: DEC4AAB876F73185
1 changed files with 14 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

14
app/src/main/java/app/myzel394/alibi/ui/README.md Normal file
View File

@ -0,0 +1,14 @@
# ui
This folder contains all user interfaces. The folder is structured as follows:
* `components`: contains all reusable components
* `atoms`, `molecules`, `organisms`, `pages`: contains components that are generic and can be
reused in different contexts
* `<name>Screen/{atoms,molecules,organisms,pages}`: contains components that are specific to a
screen
* `screens`: contains all screens. Screens are composed of components from the `components` folder
* `models`: contains view models used by the screens
* `utils`: contains general utility functions
The root Kotlin files are used for the general setup of the UI.