Documentation:Turnkey Styling

Getting started

MDriven Turnkey Style system based on the BEM methodology. BEM stands for Block, Element, Modifier and it is a convention on how to structure CSS rules. Read more here.

Out of the box you will receive the following UI elements:

• Static text
• Image
• Text field
• Checkbox
• Select (Combobox)
• Date picker
• Data-table
• Button
• File upload
• Link
• Textarea
• Number field
• Float field

Layout

MDriven Turnkey uses CSS Grid to create the application layout.

What is modifier-classes?

Modifier-classes allow you to customise MDriven Turnkey's components.

To use modifier-classes put them into the "Style ref" field in the ViewModel Editor.

Style ref in ViewModel editor

Text elements

Context colors

From the box you're able to use five default contextual colours in MDriven Turnkey. You have an ability to modify them with help of CSS custom properties.

• danger
• warning
• success
• info

Chip

With help of the modifier-classes you can style your static text as chip component from Google Material design.

Example	Modifier-class
	chip
	chip danger
	chip warning
	chip success
	chip info

Info block

Coming soon...

Input controls

Helper text

Helper text conveys additional guidance about the input control, such as how it will be used. Helper text will only take up a single line below the input control and will be persistently visible.

To add helper text to input control create <ViewModelColumn>_HelperText column in ViewModel editor where <ViewModelColumn> is a name of column with input.

Placeholder

<ViewModelColumn>_Placeholder

Input controls are rendered differently depending on the value type.

Text types

For inputs intended as type text, this type can be overridden with something else. Use the tagged value texttype on the column in the viewmodel.

• password
• email
• tel
• url
• search

How these input types renders depends on the browser used.

For further reference, look at https://developer.mozilla.org/en-US/docs/Web/HTML/Element/input/password

Buttons

Data-bind action's presentation name

Add <ActionColumn>_Presentation column in ViewModel to be able dynamically change a presentation text of action.

Default buttons

Example	Modifier-class
	danger
	warning
	success
	info

Outlined buttons

Example	Modifier-class
	outlined
	outlined danger
	outlined warning
	outlined success
	outlined info

Text buttons

Example	Modifier-class
	flat
	flat danger
	flat warning
	flat success
	flat info

Shaped buttons

Example	Modifier-class
	shaped
	shaped danger
	shaped warning
	shaped success
	shaped info

Buttons with icons

You have ability to add an icon to your button. To do that add the Tagged Value "Icon" to your ViewModelColumn which contains action. The value of Tagged Value should be the icon name. We use Material Design icons as the default icons for MDriven Turnkey application. Find the different icons on the following website Icons - Material Design.

Go to Icons – Material Design and choose the icon which you want to add to your button.

Choose icon on Material Design Icons website

After you've chosen the icon which you want to add to your button click on the left bottom corner to expand icon description. There you will be able to copy name of the icon to the value of Tagged Value.

Copy icon name to the value of TaggedValue "Icon"

Add the name of chosen icon into the TaggedValue value.

Also, you can choose the position of icon with help of TaggedValue – "IconPosiotion". (There are two available options: before or after. By default – before).

Example	Description
	Default presentation of button with leading icon
	Presentation of button with icon after the button text
	Icon button without button text
	Icon button with addition of modifier-class "fab"

Checkbox and Switch

Checkbox is the default presentation of the boolean attribute in your model.

Example	Description
	Default checkbox presentation
	Checkbox checked presentation

Switch is a different way how you can present your boolean attribute in MDriven Turnkey. To change presentation of boolean attribute from the default checkbox to switch set the TaggedValue "Switch" to your ViewModelColumn.

Exmaple	Description
	Default swtich presentation
	Switch selected presentation

Groupbox

You can style the groupbox on your page as material design card. Add the modifier-class "card" in Style ref to the ViewModelColumn with groupbox.

Example	Modifier-class	Description	Tagged value
	card	Groupbox styled as material design card.	-
	-	Groupbox without header styled as material design card.	HideHeading = True

Typography

With help of the modifier-classes you can style the text data in your Turnkey application as headings. The available modifier-classes are listed in the table below.

Exmaple	Modifier-class
	h1
	h2
	h3
	h4
	h5
	h6

DataIsLink

In the MDriven Turnkey you can represent your data string as a hyperlink. To make it you should set TaggedValue "DataIsLink" on your ViewModelColumn with data which you want to present in Turnkey as hyperlink. The text of the link will be ViewModelColumn's name.

If you want to change the text of hyperlink or set it dynamically you need to add another ViewModelColumn into your ViewModel and name it as <NameOfColumnWithHyperlink>_LinkText .