Documentation:TK Live View: Difference between revisions

TK Live View

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.

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

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

@@ Line 1: / Line 1: @@
-Introducing a new feature ...
+<message>Write the content here to display this box</message>
+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.
-Growing slowly, the signing of the web UI and while the app is running and then this is more of the same we have taken it a bit further and consolidated some of the functions that I think one needs when fine-tuning the look and feel of a web application. I'm very happy about how this is turning out.
+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]]
-Whenever you do something like this and move the front here forward, you see a lot of possibilities and new things that you can add but we need to pace it and take things in order to make it usable.
+'''NOTE:''' The Turnkey application has to be running in order to use the Turnkey Live View.
-You're just gonna use the Standard model to show these things. What has happened from before is that we have a new icon here that Costs the turnkey live editor and this is the ViewModel editor so they resemble each other and it's a combination of the And the run button which we had from before where you prototype and start the system in either WPF or in the local turnkey prototypers so this is sort of a hybrid between the ViewModel editor where you actually changed the definition of the views and This where you actually run the application so if I push this one I And always get a corresponding ViewModel Connected to it. So this is because they share some of the logic so if you don't want to see it you don't need to look at it, but it's there and this is basically a Embedded browser then you And Value two Microsoft's embedded edge browser which is replacing the old Internet Explorer and Edge so What happened there was that they said that well there's no connection to the toy machine.
+=== Turnkey Live View Features: ===
+* Server Setup
+* Live Edit
+* AssetsTK Synk
+* Debug Information
-So what we want to do is to set up a server so this is something that is Looks very much as it did in the play button that we can check if we have a current turnkey Core installed we need one of those and that we can use so this is new and Particularly you launch has been asking for the ability to connect it to an MDriven service that so this is optional. You can either run it towards a local XML file or you can use the MDriven server and that will use the Settings from the cloud connection for data. If you choose that one this button lights up and you get to this one where you actually can. Set the server that you want to run against but for now I'm gonna use the XML.  So what I want to do is restart the turnkey core and This New text highlights in red when it's Discovered that the if there's a server running or the settings from before doesn't match the file that we actually Working on so I'm working on a file that's stored in the internet cache here. So sample model for associations and Restart the server and once that is done I and Can fold this tab again and then this one is Started with our application. So this is basically Just the application in the browser nothing to it so far but when we choose to Fold down this live edit tab we get the ViewModel tree and also some of the View of the settings that are interesting Per ViewModel column. So when I click something here Like this all things I can see that this is position that the position 0x and 0y and if I were to To change this to like 10 instead This would immediately jump and I don't have to Refresh anything and that's the beauty of us running within Harness like this because we can do the Push and refresh for you.
+=== 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.
+[[File:turnkey-live-editor-server-setup-section.png|alt=Turnkey Live Editor ServerSetup Section|none|thumb|905x905px]]
-=== Watch the video to learn more ===
+=== Live Edit===
-(Video)
+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
+[[File:turnkey-live-editor-live-edit-section.png|alt=Turnkey Live Editor Live Edit Section|none|thumb|881x881px]]
+===== 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.
+[[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===
+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 [[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/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 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 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 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.''
+[[File:turnkey-live-editor-server-assetstk-synk-section.png|alt=Turnkey Live Editor Server AssetsTK Synk Section|none|thumb|866x866px]]
+=== 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 ===
+<html>
+<div class="video">
+  <div class="video__wrapper">
+    <iframe src="https://www.youtube.com/embed/1eLE21j69Jo?si=zZgxayaarFvQ9LHv" title="YouTube video player" frameborder="0" allowfullscreen></iframe>
+  </div>
+</html>
+{{Edited|July|12|2024}}
+[[Category:MDriven Designer]]
+[[Category:TOC]]