mirror of
https://github.com/Karaka-Management/oms-Navigation.git
synced 2026-02-12 14:58:41 +00:00
More introductions
This commit is contained in:
parent
3997e64d54
commit
9878d1c83c
27
Docs/introduction.md
Normal file
27
Docs/introduction.md
Normal file
|
|
@ -0,0 +1,27 @@
|
||||||
|
# Introduction
|
||||||
|
|
||||||
|
The **Navigation** module is one of the essential core modules that is always installed. This module handles navigation elements for the application and all modules that implement a navigation.
|
||||||
|
|
||||||
|
## Target Group
|
||||||
|
|
||||||
|
The target group for this module is everyone, since every application should have this module.
|
||||||
|
|
||||||
|
# Setup
|
||||||
|
|
||||||
|
This module doesn't have any additional setup requirements since it is installed during the application install process.
|
||||||
|
|
||||||
|
The module can be installed through the integrated module downloader and installer or by uploading the module into the `Modules/` directory and executing the installation through the module installer.
|
||||||
|
|
||||||
|
# Features
|
||||||
|
|
||||||
|
Creating differnt navigation systems. The supported features are:
|
||||||
|
|
||||||
|
* Icons
|
||||||
|
* Target (e.g. _blank, _self, etc)
|
||||||
|
* Categories/Groups
|
||||||
|
* Hierarchy
|
||||||
|
* Type (e.g. top navigation, side navigation etc.)
|
||||||
|
* Data-Bind for special behavior
|
||||||
|
* Custom templates
|
||||||
|
* State storage (active categories, scroll position, active hierarchy)
|
||||||
|
* Permissions on customers/groups
|
||||||
|
|
@ -1,3 +0,0 @@
|
||||||
## Installation
|
|
||||||
|
|
||||||
The order of link elements inside the `Navigation.install.json` file needs to be unique. In case the order is not unique it's possible that the link order can vary from page to page.
|
|
||||||
11
docs/info.md
11
docs/info.md
|
|
@ -1,11 +0,0 @@
|
||||||
# Navigation levels
|
|
||||||
|
|
||||||
0. None
|
|
||||||
1. Top bar
|
|
||||||
2. Side bar
|
|
||||||
3. Content bar
|
|
||||||
4. Content Side
|
|
||||||
5. Tabs
|
|
||||||
6. Dashboard
|
|
||||||
7. Content Footer
|
|
||||||
8. Footer
|
|
||||||
Loading…
Reference in New Issue
Block a user