RanchiMall/standard-ui
3
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Update README.md

Browse Source
This commit is contained in:
tripathyr 2021-12-27 16:14:15 +05:30 committed by GitHub
parent 16005b4eba
commit d48bdec1d0
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 5 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

5
README.md
View File

@ -6,6 +6,11 @@ Suppose you want to start a web project. Instead of doing the UI from scratch, y
### How to use Standard UI ### How to use Standard UI
There are several pre-built layouts in **layouts** folder. Pick any one of them that's more suitable for your particular project. There are several pre-built layouts in **layouts** folder. Pick any one of them that's more suitable for your particular project.
## Layouts Available
###Box Layout also known as bottom-navbar layout
This layout comes with a sidebar of menu items on the desktop size screen which converts into the bottom navbar on mobile. It should be used when there are less than 5 main pages in the app for quick access on small screen
#### What's included in layouts by default? #### What's included in layouts by default?
- Components ( sm-button, sm-input, sm-notifications, sm-popup, theme-toggle and optional components specific to respective layout ) - Components ( sm-button, sm-input, sm-notifications, sm-popup, theme-toggle and optional components specific to respective layout )
- Main_UI.js - A JS library that includes utility functions and some common functionality. - Main_UI.js - A JS library that includes utility functions and some common functionality.