Skyve User Guide
Welcome to the Skyve User Guide. Please use the index on the left to navigate, or begin a search.
Basic Skyve Concepts
Navigation
Navigation within Skyve applications may be slightly different to other web applications as it is designed to feel more like a desktop application rather than a website. Navigation will be explained in three broad categories here: menu, action panel and zoom.
Menu
The main application menu is broken into sections by Module, and then typically shows Documents which have been added to the menu. By default, clicking an item in the menu will navigate you to a list (table) of all records of that type.
Action Panel
Once a record is is opened, the application loads the detail view for that document. This then provides the action panel at the top of the view for interaction with the document. The action panel has the following buttons:
- OK - This performs a Save and Close action when clicked. This will save any changes and return you to the view you came from (e.g. the list of this document).
- Save - This saves any changes to the current view when clicked.
- Delete - This will delete the current document (and any child documents) when clicked and return you to the view you came from.
- Cancel - This will undo any changes which have been made and return you to the view you came from without saving.
If you have “zoomed” into a list within another document, your action panel buttons will change to provide two different options based on your context.
- Zoom Out - This will return you to the parent view of the record you are in. Any changes will be saved or cancelled based on the action you take at the parent level.
-
Remove - If you added a new record to a list on the parent document, this will delete the new record and return you to the parent view. An example of this is adding a role to a user in the admin module.
Zoom
Skyve applications use a zoom in / zoom out concept for navigation which allows complex interfaces to be broken into discrete sections. Each view has its own fields and validation rules, keeping the interfaces small and light.
By selecting an item from a list, we Zoom into that record. If that record’s view has another table, we can keep zooming in to access more details. We can then Cancel or Zoom Out to return to the level above until we get back to the top.
Switching Interfaces
Skyve applications feature two separate user interfaces, both with their own advantages depending on the use case. In the default (normal) mode, the interface is responsive and mobile and tablet friendly, with larger controls for touch and whitespace for legibility.
The alternate interface, power user mode, is great for desktop browsers where lots of data manipulation, reporting or exorting is required.
To switch interfaces, click the switch icon from the top right hand corner. In normal mode, this is accessed by clicking your username, and selecting the switch mode icon from the user menu.
In power user mode, the same switch icon is available from the toolbar at the top of the application.
Note: the switch mode button may not always be available depending on your application and if it suppports both interfaces.