Documentation:MDriven Turnkey theming: Difference between revisions

MDriven Turnkey theming

Latest revision as of 13:47, 26 March 2024

MDriven Turnkey's theming process allows you to create your own theme for the Turnkey application. You can change your brand's primary colors, font sizes, contextual colors, navbar colors, etc.

MDriven Turnkey application uses SCSS to greatly simplify the source code for styling an application since it introduces variables and other logic that are missing from standard CSS. This was the reason for our decision to shift to the SCSS format on the source code for styling a Turnkey web app based on Material Design guidelines.

SCSS (Sass) is a text format that compiles into CSS.

How does this differ from "tkusercss"?

As we have described before, you may add your own styles to "Content/tkusercss.css". This article describes how to create a theme in a consistent SCSS-supported way that builds the very fabric of every aspect of the Turnkey app.

Where to start?

Use the prototype run - LocalTurnkeyPrototyper option to get your application running locally. You can choose any free port.

By doing this, you have access to the original SCSS files that control all the styling of the Turnkey web app. They are located in "application-root/Content/scss".

Use the Visual Studio Code editor to get context-sensitive help in updating the SCSS files to your liking.

Install the liveSassCompile plugin that can track your changes and turn the updated theme source code (SCSS) into CSS that the webserver uses.

By refreshing your local prototyping app, you'll get instant feedback on what the theme style change looks like.

When you save a changed SCSS as it is being watched by the sass compiler, it will compile into a new CSS theme file "theme-user.css". This new CSS is found here "application-root/Content/scss/theme-user.css".

The Turnkey application will recognise that there now is an "application-root/Content/scss/theme-user.css" and will use that instead of the default "application-root/Content/theme-default.css".

When you refresh your page, you will see that your modified theme is applied:

There are many possible changes you may want to experiment with:

Primary color
Contextual colors (danger, warning, success, and info)
Navigation bar color
Button's colors
Action's color
Font-size
Sizes of buttons and input components

You may want to copy the updated SCSS repository and keep it safe. It will be overwritten with default styles the next time you get the latest version of the Turnkey core. The edited SCSS is your source code for your styles; even if the CSS is enough, it will be easier for you to make changes in the SCSS files. There is no way to go back from a CSS you have to the original SCSS that created it.

Deploying the New Resulting CSS to the Server

Now that we have managed to change the local site, we want to apply the same changes to a server-side site in Azure. This is done by simply copying the resulting "Content/scss/theme-user.css" to your AssetsTK folder for the model - add the same folder levels so that you get "xxxx_AssetsTK/Content/scss/theme-user.css" or "xxxx_AssetsTK/Content/theme-user.css".

Upload your model to the server.

How do I get the standard back?

To get the standard back, you only need to delete the "application-root/Content/scss/theme-user.css" or "application-root/Content/theme-user.css" from the server. To delete files uploaded with AssetsTK refer to here.

Do you want the web page to reload automatically while changing styles?

Read here on how to make your turnkey reload automatically on script change or style change.

CSS Custom Properties

In the Turnkey application, you're able to change the styles of your application without compiling the source SASS code. We added the support of CSS Custom Properties to let you change the appearance of your application in a fast and easy way.

Use the tkusercss file to tweak the styling of your Turnkey app with the power of CSS Custom Properties (also known as CSS variables).

Create a "tkusercss.css" file according to this article in your model directory and place it in the "Content" folder.
Add your color values and other settings into the "tkusercss" file.
Upload your model with MDriven Designer and get all the changes online in your application instantly.

Structure of "tkusercss.css"

When you have created tkusercss.css, open it with your preferred text or code editor and add the following declaration.

:root { }

The :root selector in CSS matches the document's root element and is a place where you put your own values for custom properties (CSS variables).

The syntax of the CSS custom properties declaration:

--name-of-custom-property: value;

List of the Changeable Properties in the Turnkey Application

--base-font-size (Pixels)
--base-bg-color (RGB format)
--base-border-radius (Pixels)
--navbar-height (Pixels)
--navbar-bg-color (RGB format)
--navbar-brand-color (RGB format)
--navbar-link-color (RGB format)
--sidebar-bg-color (RGB format)
--primary-color (RGB format)
--primary-color-dark (RGB format)
--text-on-primary (RGB format)
--danger-color (RGB format)
--danger-color-dark (RGB format)
--text-on-danger (RGB format)
--warning-color (RGB format)
--warning-color-dark (RGB format)
--text-on-warning (RGB format)
--success-color (RGB format)
--success-color-dark (RGB format)
--text-on-success (RGB format)
--save-action-bg-color (RGB format)
--save-action-bg-color-dark (RGB format)
--save-action-text-color (RGB format)
--cancel-action-bg-color (RGB format)
--cancel-action-bg-color-dark (RGB format)
--cancel-action-text-color (RGB format)
--redo-action-bg-color (RGB format)
--redo-action-bg-color-dark (RGB format)
--redo-action-text-color (RGB format)
--undo-action-bg-color (RGB format)
--undo-action-bg-color-dark (RGB format)
--undo-action-text-color (RGB format)
--data-table-header-bg-color (RGB format)
--data-table-header-text-color (RGB format)
--data-table-header-height (Pixels)
--data-table-body-bg-color (RGB format)
--data-table-body-text-color (RGB format)
--data-table-row-height (Pixels)

Notice! All color properties should be inserted in the RGB format. For example: --primary-color: 245, 156, 26;

Turnkey Themes

We made you a couple of precompiled themes for your MDriven Turnkey application. To apply the following themes, download the zip archive below and extract it. You will receive a "theme-user.css" file which you should put into the "Content" folder in the AssetsTK, then upload your model with MDriven Designer.

Also, see the new functionality: Theme as data.

Compact Theme

The compact theme for MDriven Turnkey will make your components smaller and allow you to fit more information on the app's pages.

Download: File:Compact theme.zip

This page was edited 43 days ago on 03/26/2024. What links here

@@ Line 1: / Line 1: @@
-[https://sass-lang.com/documentation/syntax SCSS] or SASS, as it sometimes is called, is a text format that compiles into css.
+MDriven Turnkey's theming process allows you to create your own theme for the Turnkey application. You can change your brand's primary colors, font sizes, contextual colors, navbar colors, etc.
-Using scss can greatly simplify the source code for styling a site since it introduces variables and other logic that is missing from standard css.
+MDriven Turnkey application uses SCSS to greatly simplify the source code for styling an application since it introduces variables and other logic that are missing from standard CSS. This was the reason for our decision to shift to the SCSS format on the source code for styling a Turnkey web app based on [https://material.io/design/ Material Design guidelines].
-As you can imagine things like text font size may be needed in many places across the site and we usually want such a thing consistent - but if there is no variable to reuse we would be forced to have a copy of the desired value in many css rules. A Variable definition greatly simplifies this and allows us to maintain it in only one place.
+[https://sass-lang.com/ SCSS] (Sass) is a text format that compiles into CSS.
-This is the reason for us shifting to scss-format on the source code for styling a turnkey web app based on [https://material.io/design/ material design styles].
+==== How does this differ from "tkusercss"? ====
+As we have described before, you may add your own styles to "[[Tkusercss|Content/tkusercss.css]]". This article describes how to create a theme in a consistent SCSS-supported way that builds the very fabric of every aspect of the Turnkey app.
-This switch also benefits you when you want to give your turnkey site a personal touch.
+==== Where to start? ====
+Use the prototype run - LocalTurnkeyPrototyper option to get your application running locally. You can choose any free port.
+[[File:LocalTurnkeyPrototyper.jpg|none|thumb|795x795px]]
+[[File:Started Local Turnkey Prototyper.jpg|none|thumb|1074x1074px]]
+By doing this, you have access to the original SCSS files that control all the styling of the Turnkey web app. They are located in "'''''application-root/Content/scss'''''".
+[[File:SCSS in Turnkey Local Core.png|none|thumb|738x738px]]
+Use the Visual Studio Code editor to get context-sensitive help in updating the SCSS files to your liking.
+[[File:2019-06-16 10h16 53.png|none|thumb|1002x1002px]]
+Install the liveSassCompile plugin that can track your changes and turn the updated theme source code (SCSS) into CSS that the webserver uses.
+[[File:2019-06-16 10h33 40.png|none|thumb|852x852px]]
-==== How does this differ from tkusercss? ====
+By refreshing your local prototyping app, you'll get instant feedback on what the theme style change looks like. [[File:VS Code and Turnkey Core.jpg|none|thumb|1001x1001px]]
-As we have described before you may add your own styles to [[Tkusercss|Content/tkusercss.css]] - this article describes how you change the existing styles in a consistent scss supported way that build the very fabric of every aspect of the turnkey site.
+When you save a changed SCSS as it is being watched by the sass compiler, it will compile into a new CSS theme file "theme-user.css". This new CSS is found here "'''''application-root/Content/scss/theme-user.css'''''".
+[[File:Compiled theme file.png|none|thumb|476x476px]]
+The Turnkey application will recognise that there now is an ''"'''application-root/Content/scss/theme-user.css'''"'' and will use that instead of the default ''"'''application-root/Content/theme-default.css'''"''.
-==== Where to start ====
+When you refresh your page, you will see that your modified theme is applied:
-Scss and css are web de facto standards - and you may use any tool that does the job. This article describes one of many possible ways to tweak the styles of a turnkey site.
+[[File:Changed theme settings.png|alt=x|none|thumb|1048x1048px]]
+There are many possible changes you may want to experiment with:
+* Primary color
+* Contextual colors (danger, warning, success, and info)
+* Navigation bar color
+* Button's colors
+* Action's color
+* Font-size
+* Sizes of buttons and input components
+You may want to copy the updated SCSS repository and keep it safe. It will be overwritten with default styles the next time you get the latest version of the Turnkey core. The edited SCSS is your source code for your styles; even if the CSS is enough, it will be easier for you to make changes in the SCSS files. There is no way to go back from a CSS you have to the original SCSS that created it.
+[[File:2019-06-16 10h51 36.png|none|thumb|380x380px]]
-Use the prototype run - LocalTurnkeyPrototyper option to get your site running locally. You can choose any free port.
+==== Deploying the New Resulting CSS to the Server ====
-[[File:2019-06-16 10h02 23.png|none|thumb|433x433px]]
+Now that we have managed to change the local site, we want to apply the same changes to a server-side site in Azure. This is done by simply copying the resulting "'''''Content/scss/theme-user.css'''''" to your [[Theme and style|AssetsTK folder]] for the model - add the same folder levels so that you get "'''''xxxx_AssetsTK/Content/scss/theme-user.css'''''" or "'''''xxxx_AssetsTK/Content/theme-user.css'''''".
-[[File:2019-06-16 10h09 54.png|none|thumb|1074x1074px]]
+[[File:Deploy to the server.jpg|alt=|none|thumb|1069x1069px]]
+Upload your model to the server.
+[[File:Check file upload.jpg|none|thumb|725x725px]]
-By doing this you have access the original scss files that control all the styling of the web app. They are located in application-root/content/scss.
+==== How do I get the standard back? ====
-[[File:SCSS in Turnkey Local Core.png|none|thumb|738x738px]]
+To get the standard back, you only need to delete the "'''''application-root/Content/scss/theme-user.css'''''" or "'''''application-root/Content/theme-user.css'''''" from the server. To [[Theme and style|delete files uploaded with AssetsTK refer to here]].
-You can use the Visual Studio Code editor to get context sensitive help in updating the scss files to your liking.
-[[File:2019-06-16 10h16 53.png|none|thumb|1002x1002px]]
+==== Do you want the web page to reload automatically while changing styles? ====
+Read here on how to make your [[turnkey reload automatically on script change or style change]].
+=== CSS Custom Properties ===
+In the Turnkey application, you're able to change the styles of your application without compiling the source SASS code. We added the support of CSS Custom Properties to let you change the appearance of your application in a fast and easy way.
+Use the [[Tkusercss|'''tkusercss''']] file to tweak the styling of your Turnkey app with the power of CSS Custom Properties (also known as CSS variables).
+* Create a "tkusercss.css" file according to [[Tkusercss|'''this article''']] in your model directory and place it in the "Content" folder.
+* Add your color values and other settings into the "tkusercss" file.
+* Upload your model with MDriven Designer and get all the changes online in your application instantly.
+==== Structure of "tkusercss.css" ====
+When you have created tkusercss.css, open it with your preferred text or code editor and add the following declaration.
+ :root { }
+The <code>''':root'''</code> selector in CSS matches the document's root element and is a place where you put your own values for custom properties (CSS variables).
+The syntax of  the CSS custom properties declaration:
+ --name-of-custom-property: value;
+==== List of the Changeable Properties in the Turnkey Application ====
+* --base-font-size ''(Pixels)''
+* --base-bg-color ''(RGB format)''
+* --base-border-radius ''(Pixels)''
+* --navbar-height ''(Pixels)''
+* --navbar-bg-color ''(RGB format)''
+* --navbar-brand-color ''(RGB format)''
+* --navbar-link-color ''(RGB format)''
+* --sidebar-bg-color ''(RGB format)''
+* --primary-color ''(RGB format)''
+* --primary-color-dark ''(RGB format)''
+* --text-on-primary ''(RGB format)''
+* --danger-color ''(RGB format)''
+* --danger-color-dark ''(RGB format)''
+* --text-on-danger ''(RGB format)''
+* --warning-color ''(RGB format)''
+* --warning-color-dark ''(RGB format)''
+* --text-on-warning ''(RGB format)''
+* --success-color ''(RGB format)''
+* --success-color-dark ''(RGB format)''
+* --text-on-success ''(RGB format)''
+* --save-action-bg-color ''(RGB format)''
+* --save-action-bg-color-dark ''(RGB format)''
+* --save-action-text-color ''(RGB format)''
+* --cancel-action-bg-color ''(RGB format)''
+* --cancel-action-bg-color-dark ''(RGB format)''
+* --cancel-action-text-color ''(RGB format)''
+* --redo-action-bg-color ''(RGB format)''
+* --redo-action-bg-color-dark ''(RGB format)''
+* --redo-action-text-color ''(RGB format)''
+* --undo-action-bg-color ''(RGB format)''
+* --undo-action-bg-color-dark ''(RGB format)''
+* --undo-action-text-color ''(RGB format)''
+* --data-table-header-bg-color (RGB format)
+* --data-table-header-text-color (RGB format)
+* --data-table-header-height (Pixels)
+* --data-table-body-bg-color (RGB format)
+* --data-table-body-text-color (RGB format)
+* --data-table-row-height (Pixels)
+'''Notice!''' All color properties should be inserted in the RGB format. For example: '''--primary-color: 245, 156, 26;'''
-You can install the liveSassCompile plugin that can track your changes and turn the updated source code (scss) into css that the the webserver actually use.
+=== Turnkey Themes ===
-[[File:2019-06-16 10h33 40.png|none|thumb|852x852px]]
+We made you a couple of precompiled themes for your MDriven Turnkey application. To apply the following themes, download the zip archive below and extract it. You will receive a "theme-user.css" file which you should put into the "Content" folder in the [[AssetsTK]], then upload your model with [https://mdriven.net/designer MDriven Designer].
-By refreshing your local prototyping site you get instant feedback on what the style change looks like.
+Also, see the new functionality: [[Theme as data]].
-[[File:2019-06-16 10h37 49.png|none|thumb|1001x1001px]]
-When you save a changed scss as it is being watched by the sass compiler, it will compile into a new css. This new css is found here /Content/scss/app.css.
-[[File:2019-06-16 10h50 10.png|none|thumb|359x359px]]
-The turnkey application will recognise that there now is a /Content/scss/app.css and will use that instead of the standard /Content/site.css.
+==== MDriven Dark Theme ====
+[[File:Mdriven dark theme.png|none|thumb|649x649px]]
+[[File:Mdriven-dark-theme-preview-2.png|none|thumb|651x651px]]'''Download:''' [[File:MDriven Dark theme.zip|none|thumb|MDriven dark theme]]
-When you refresh your page you will see the new style applied:
+==== Vivid Blue Theme ====
-[[File:2019-06-16 10h39 00.png|alt=x|none|thumb|1048x1048px]]
+[[File:Vivid blue theme preview.png|thumb|651x651px|none]]
+[[File:Vivid blue theme preview 2.png|thumb|651x651px|none]]'''Download:'''[[File:Vivid blue theme.zip|alt=Vivid blue theme for MDriven Turnkey|thumb|Vivid blue theme|none]]
-There are many possible changes that you may want to experiment with. Maybe font size?
+==== Lime Green Theme ====
-[[File:2019-06-16 10h48 13.png|none|thumb|1049x1049px]]
+[[File:Lime green theme preview.png|none|thumb|653x653px]]
+[[File:Lime green theme preview 2.png|none|thumb|655x655px]]'''Download:'''[[File:Lime green theme.zip|alt=Lime green theme|none|thumb|Lime green theme]]
-You may want to copy the updated scss repository and keep it safe - it will be overwritten with default styles the next time you get the latest version of turnkey core. The edited scss is your source code for your styles - even if the css is enough it will be easier for you making changes in the scss files. There is no way to go back from a css you have to the original scss that created it.
+==== Dark Blue Theme ====
-[[File:2019-06-16 10h51 36.png|none|thumb|380x380px]]
+[[File:Dark blue theme preview.png|alt=Dark blue theme preview|none|thumb|663x663px]]
+[[File:Dark blue theme preview 2.png|alt=Dark blue theme preview 2|none|thumb|665x665px]]'''Download:'''[[File:Dark blue theme.zip|none|thumb]]
-==== Deploying the new resulting css to the server ====
+==== Dark Red Theme ====
-Now that we have managed to change the local site we want to apply the same changes to a server side site in azure. This is done by simply copying the resulting content/scss/app.css to your [[Theme and style|AssetsTK folder]] for the model - add the same folder levels so that you get xxxx_AssetsTK/Content/scss/app.css.
+[[File:Dark red- heme preview 1.png|none|thumb|679x679px]]
-[[File:2019-06-16 11h00 42.png|alt=x|none|thumb|945x945px]]
+[[File:Dark-red-theme-preview-2.png|none|thumb|678x678px]]
-Upload your model
+'''Download:'''
-[[File:2019-06-16 11h06 24.png|none|thumb|590x590px]]
+[[File:Dark red theme.zip|none|thumb|Dark red theme]]
-Upload your model and watch the result on the server application
+==== Compact Theme ====
-[[File:2019-06-16 11h10 31.png|none|thumb|830x830px]]
+The compact theme for MDriven Turnkey will make your components smaller and allow you to fit more information on the app's pages.
-==== How do I get the standard back? ====
+'''Download:'''
-To get the standard back you only need to delete the /Content/scss/app.css from the server. To [[Theme and style|delete files uploaded with AssetsTK refer to here]].
+[[File:Compact theme.zip|none|thumb|Compact theme]]
+[[Category:MDriven Turnkey]]
+{{Edited|July|12|2024}}
-==== Do you want the web page to reload automatically while changing styles? ====
+[[Category:TOC]]
-Read here on how to make your [[turnkey reload automatically on script change or style change]].