TK Live View
No edit summary
No edit summary
 
(One intermediate revision by one other user not shown)
Line 1: Line 1:
<message>Write the content here to display this box</message>
<message>Write the content here to display this box</message>
   
   
The Turnkey Live View is for designing the web UI while the app is running. It is for making changes to the different interfaces of the application through the different ViewModels and view the results of the changes in real time. This is used for designing and testing the app's UI responsiveness and testing UI concepts.  
The Turnkey Live View enables you to design the web UI while your app is running. It makes changes to the different interfaces of the application through the different ViewModels and allows you to view the results of the changes in real time. It is useful for designing and testing the app's UI responsiveness and testing UI concepts.  


The Turnkey Live View is accessible through the '''Turnkey Live View Editor''' button. It is an embedded browser within the designer for editing the UI.  
The Turnkey Live View is accessible through the '''Turnkey Live View Editor''' button. It is an embedded browser within the designer for editing the UI.  
[[File:turnkey-live-editor-button-in-designer.png|alt=Turnkey Live Editor Button in the MDriven Designer|none|thumb|933x933px]]  
[[File:turnkey-live-editor-button-in-designer.png|alt=Turnkey Live Editor Button in the MDriven Designer|none|thumb|933x933px]]  


'''NOTE:''' The Turnkey application has to be running inorder to use the TurnKey Live View.  
'''NOTE:''' The Turnkey application has to be running in order to use the Turnkey Live View.  
 
==== Turnkey Live View Features: ====


=== Turnkey Live View Features: ===
* Server Setup
* Server Setup
* Live Edit
* Live Edit
Line 16: Line 15:


=== Server Setup ===
=== Server Setup ===
The Server Setup section is for starting the Turnkey application. You can either use the local Turnkey prototyper (default) or use MDriven Server setting to start the app.  
The Server Setup section starts the Turnkey application. You can either use the local Turnkey prototyper (default) or use the MDriven Server setting to start the app.  
[[File:turnkey-live-editor-server-setup-section.png|alt=Turnkey Live Editor ServerSetup Section|none|thumb|905x905px]]
[[File:turnkey-live-editor-server-setup-section.png|alt=Turnkey Live Editor ServerSetup Section|none|thumb|905x905px]]


Line 29: Line 28:
[[File:turnkey-live-editor-live-edit-section.png|alt=Turnkey Live Editor Live Edit Section|none|thumb|881x881px]]
[[File:turnkey-live-editor-live-edit-section.png|alt=Turnkey Live Editor Live Edit Section|none|thumb|881x881px]]


===== The ViewMode tree =====
===== The ViewModel tree =====
The ViewMode tree provides access to the ViewModel Editor interface of a ViewModel. It provides all the options and settings of the ViewModel editor. Addings columns, rearranging columns, adding Nestings, placing containers and so much more.
The ViewModel tree provides access to the ViewModel Editor interface of a ViewModel. It provides all the options and settings of the ViewModel Editor such as adding and rearranging columns, adding nestings, placing containers and more.


===== Advanced Edit =====
===== Advanced Edit =====
Advanced Edit section is for ViewModel and ViewModel column properties settings and constraint settings. This also another feature adopted from the ViewModel editor.
The Advanced Edit section is for ViewModel and ViewModel column properties settings and constraint settings. This is also another feature adopted from the ViewModel Editor.


===== The Web UI =====
===== The Web UI =====
This section shows you the  UI as it will be seen by users. Directing editing is available in this section for dragging and repositioning UI widgets,
This section shows you the  UI as it will be seen by users. Direct editing is available in this section for dragging and repositioning UI widgets:


* Turn on '''Edit''' to edit in Web UI
* Turn on '''Edit''' to edit in Web UI
* The '''Live update''' feature turned on is for viewing ViewModel changes in real time.
* Turning on the '''Live Update''' feature enables you to view ViewModel changes in real time.
[[File:additional-settings-of-live-edit.png|alt=Additional Settings of Live Edit in Turnkey Live View|none|thumb|912x912px]]
[[File:turnkey-live-editor-live-edit-section-additional-settings.png|alt=Additional Settings of Live Edit in Turnkey Live View|none|thumb|912x912px]]


=== AssetsTK Synk===
=== AssetsTK Synk===
This section for AssetsTK folder configurations for the current running Model. When this section is expanded, the AssetsTK folder is automatically created if it does not exist.
This section of the AssetsTK folder shows configurations for the current running Model. When this section is expanded, the AssetsTK folder is automatically created if it does not exist.


This sections provides options for creating asset files for customizing the Turnkey application UI and merging mergeable models into the current running Model.
This section provides options to create asset files for customizing the Turnkey application UI and merging models into the current running Model.


===== The AssetsTK Synk features: =====
===== The AssetsTK Synk features: =====


* '''Refresh file tree:''' This is for refreshing the [[Documentation:AssetsTK|AssetsTK file]] tree to view all content currently in the folder.
* '''Refresh file tree:''' This is for refreshing the [[Documentation:AssetsTK|AssetsTK file]] tree to view all content currently in the folder.
* '''Ensure Content/tkuserCss.css:''' Creates the [[Documentation:Tkusercss|tkusercss file]] for creating personalized css that can be merged into the Turnkey applications
* '''Ensure Content/tkuserCss.css:''' Creates the [[Documentation:Tkusercss|tkusercss file]] for creating personalized CSS that can be merged into the Turnkey applications
* '''Ensure Content/theme-user.css:''' Creates the [[Documentation:MDriven Turnkey theming|theme-user css file]] for editing the default Turnkey theme properties.
* '''Ensure Content/theme-user.css:''' Creates the [[Documentation:MDriven Turnkey theming|theme-user css file]] for editing the default Turnkey theme properties.
* '''Ensure EXTScripts/appwideangularscriptincludes.html:''' Create the [[Documentation:AppWideAngularScriptIncludes|AppWideAngularScriptIncludes html file]] for loading scripts in the page rendering.
* '''Ensure EXTScripts/appwideangularscriptincludes.html:''' Create the [[Documentation:AppWideAngularScriptIncludes|AppWideAngularScriptIncludes html file]] for loading scripts in the page rendering.
* '''Ensure ViewAssets/<NameOfViewModel> (css.js):''' Creates ViewModel css and js files for overriding the UI.
* '''Ensure ViewAssets/<NameOfViewModel> (css.js):''' Creates ViewModel CSS and JS files for overriding the UI.
* '''Ensure Views/EXTOverridePages/<NameOfViewModel>.tagexpander.cshtml:''' Creates the current ViewModel [[Documentation:Fashion with tagexpander|tageexpander file]] for overriding the default Turnkey UI implementation.
* '''Ensure Views/EXTOverridePages/<NameOfViewModel>.tagexpander.cshtml:''' Creates the current ViewModel [[Documentation:Fashion with tagexpander|tageexpander file]] for overriding the default Turnkey UI implementation.
* '''Ensure EXTComponents/TemplateComponent (css,html,js):''' Creates the folder and files structure for creating an [[Documentation:EXT Components|Angular component]] to integrate in the Turnkey application.
* '''Ensure EXTComponents/TemplateComponent (css,html,js):''' Creates the folder and files structure for creating an [[Documentation:EXT Components|Angular component]] to integrate in the Turnkey application.
* '''(Re)Download Components from GitHub:''' Downloads the latest MDriven's mergeable models onto your local machine.
* '''(Re)Download Components from GitHub:''' Downloads the latest mergeable models onto your local machine.
* '''Components to choose from:''' This section provides MDriven mergeable Models available for merging into the current model. These include examples and patterns for integrating other MDriven functionality into the app. ''First '''Download Components from GitHub''' before using this feature.''
* '''Components to choose from:''' This section provides MDriven models available for merging into the current model. These include examples and patterns for integrating other MDriven functionality into the app. ''First '''Download Components from GitHub''' before using this feature.''
[[File:turnkey-live-editor-server-assetstk-synk-section.png|alt=Turnkey Live Editor Server AssetsTK Synk Section|none|thumb|866x866px]]
[[File:turnkey-live-editor-server-assetstk-synk-section.png|alt=Turnkey Live Editor Server AssetsTK Synk Section|none|thumb|866x866px]]


=== Debug Information ===
=== Debug Information ===
The Debugger UI provides access to the Model using the '''Server Setup''' settings used to start the Turnkey application. This section adopts all the functionality of the Model debugger to check for errors, creating, reading and updating Model data including testing ViewModels.     
The Debugger UI provides access to the model using the '''Server Setup''' settings used to start the Turnkey application. This section adopts all the functionality of the Model debugger to check for errors, creating, reading and updating Model data including testing ViewModels.     


=== Watch the video to learn more. ===
=== Watch this video to learn more ===
<html>
<html>
<div class="video">
<div class="video">

Latest revision as of 06:18, 27 August 2024


The Turnkey Live View enables you to design the web UI while your app is running. It makes changes to the different interfaces of the application through the different ViewModels and allows you to view the results of the changes in real time. It is useful for designing and testing the app's UI responsiveness and testing UI concepts.

The Turnkey Live View is accessible through the Turnkey Live View Editor button. It is an embedded browser within the designer for editing the UI.

Turnkey Live Editor Button in the MDriven Designer

NOTE: The Turnkey application has to be running in order to use the Turnkey Live View.

Turnkey Live View Features:

  • Server Setup
  • Live Edit
  • AssetsTK Synk
  • Debug Information

Server Setup

The Server Setup section starts the Turnkey application. You can either use the local Turnkey prototyper (default) or use the MDriven Server setting to start the app.

Turnkey Live Editor ServerSetup Section

Live Edit

The Live Edit section is where the actual fine tuning of the UI is done in real time, either from the ViewModel tree or the the actual generated UI.

For editing and designing, Live Edit has three sections:

  • The ViewModel tree
  • The Web UI
  • Advanced Edit
Turnkey Live Editor Live Edit Section
The ViewModel tree

The ViewModel tree provides access to the ViewModel Editor interface of a ViewModel. It provides all the options and settings of the ViewModel Editor such as adding and rearranging columns, adding nestings, placing containers and more.

Advanced Edit

The Advanced Edit section is for ViewModel and ViewModel column properties settings and constraint settings. This is also another feature adopted from the ViewModel Editor.

The Web UI

This section shows you the UI as it will be seen by users. Direct editing is available in this section for dragging and repositioning UI widgets:

  • Turn on Edit to edit in Web UI
  • Turning on the Live Update feature enables you to view ViewModel changes in real time.
Additional Settings of Live Edit in Turnkey Live View

AssetsTK Synk

This section of the AssetsTK folder shows configurations for the current running Model. When this section is expanded, the AssetsTK folder is automatically created if it does not exist.

This section provides options to create asset files for customizing the Turnkey application UI and merging models into the current running Model.

The AssetsTK Synk features:
  • Refresh file tree: This is for refreshing the AssetsTK file tree to view all content currently in the folder.
  • Ensure Content/tkuserCss.css: Creates the tkusercss file for creating personalized CSS that can be merged into the Turnkey applications
  • Ensure Content/theme-user.css: Creates the theme-user css file for editing the default Turnkey theme properties.
  • Ensure EXTScripts/appwideangularscriptincludes.html: Create the AppWideAngularScriptIncludes html file for loading scripts in the page rendering.
  • Ensure ViewAssets/<NameOfViewModel> (css.js): Creates ViewModel CSS and JS files for overriding the UI.
  • Ensure Views/EXTOverridePages/<NameOfViewModel>.tagexpander.cshtml: Creates the current ViewModel tageexpander file for overriding the default Turnkey UI implementation.
  • Ensure EXTComponents/TemplateComponent (css,html,js): Creates the folder and files structure for creating an Angular component to integrate in the Turnkey application.
  • (Re)Download Components from GitHub: Downloads the latest mergeable models onto your local machine.
  • Components to choose from: This section provides MDriven models available for merging into the current model. These include examples and patterns for integrating other MDriven functionality into the app. First Download Components from GitHub before using this feature.
Turnkey Live Editor Server AssetsTK Synk Section

Debug Information

The Debugger UI provides access to the model using the Server Setup settings used to start the Turnkey application. This section adopts all the functionality of the Model debugger to check for errors, creating, reading and updating Model data including testing ViewModels.

Watch this video to learn more

This page was edited 24 days ago on 08/27/2024. What links here