Skip to content

KoenDeleij/Mvx.Plugin.Style

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 
 
 
 
 
 
 
 
 

Repository files navigation

MvvmCross Style Plugin

Alt Screenshot1 Alt Screenshot2

Whats new in 3.0.0

  • Mvvmcross 8.0.0 support

Initialization

iOS

Override the plugin configuration in your setup to set a fontsize factor. You could, depending on the device, change the overall size factor.

protected override IMvxPluginConfiguration GetPluginConfiguration(Type plugin) { 
	if (plugin == typeof(Mvx.Plugin.Style.Touch.Plugin)) {
		return new StyleConfiguration() {
			FontSizeFactor = sizeFactor
		};
	}
}

Android

Same as with iOS. You can optionally also add a different lineheight. In some cases older Android devices really lack space. This will help.

protected override IMvxPluginConfiguration GetPluginConfiguration(Type plugin) {
	if (plugin == typeof(Mvx.Plugin.Style.Droid.Plugin)) {
		return new StyleConfiguration() {
			FontSizeFactor = fontSizeFactor,
			LineHeightFactor = lineHeightFactor
		};
	}
}

If you want to use the MvxFont binding in layout files, you'll need to add these lines of code in the setup :

protected override MvvmCross.Binding.Droid.MvxAndroidBindingBuilder CreateBindingBuilder() 	{
	var bindingBuilder = new MvxAndroidStyleBindingBuilder();
	return bindingBuilder;
}

Cross

To add assets you can resolve the asset plugin :

public override void LoadPlugins(MvvmCross.Platform.Plugins.IMvxPluginManager pluginManager)
{
	base.LoadPlugins(pluginManager);
	var plugin = Mvx.Resolve<IAssetPlugin>();
	//add your fonts here. of course wouldn't actually add them here, but after the plugins are loaded you could.
}

To be able to bind directly in your views, you'll have to add the AssetProvider to your viewmodel :

[MvxInject]
public IAssetPlugin AssetProvider { get; set; }

Colors

Cross

Setup

var plugin = Mvx.Resolve<IAssetPlugin>();
plugin.AddColor(new MvxColor(0, 139, 178), "BlueDark")

iOS

Fixed color

bindingSet.Bind(View).For(v => v.BackgroundColor).To(vm => 	vm.AssetProvider).WithConversion("AssetColor", "BlueDark");

Bindable color

bindingSet.Bind(View).For(v => v.BackgroundColor).To(vm => 	vm.ColorName).WithConversion("AssetColor");

Android

Fixed color

<LinearLayout
	android:layout_width="match_parent"
	android:layout_height="match_parent"
    local:MvxBind="BackgroundColor AssetProvider,Converter=AssetColor,ConverterParameter=BlueDark" />

Bindable color

<LinearLayout
	android:layout_width="match_parent"
	android:layout_height="match_parent"
    local:MvxBind="BackgroundColor ColorName,Converter=AssetColor" />

Fonts

Features

This plugin allows you to add fonts. Each font contains the following properties :

BaseFont

  • Name, String (Used for reference when binding)
  • FontFilename, String (the full filename of the font, like "Arial.ttf")
  • FontPlatformName, String (this is mainly for iOS. iOS doesn't refer to fonts with the actual file name but by a tag. You can find it's name in the FontBook under PostScript Name)
  • FontPlatformSize, float (Automatically set based on the FontSizeFactor per platform. You don't have to set this)
  • Size, int (Size of the font)

For buttons and more advanced styling you can use the Font class

Font

  • SelectedColor, MvxColor (Font color shown when a button is set to selected. Selected property for iOS, state_selected for Android)
  • DisabledColor, MvxColor (Font color shown when a button is disabled. Enabled false for iOS, state_enabled false for Android)
  • LineHeight, int (Only available for labels and textviews. For iOS you'll need to use the AttributedText converter)
  • LineHeightMultiplier, float Usefull for multiplying the space between lines in comparison to other Textviews
  • Alignment, TextAlignment (Left/Center/Right/Justified). Note, justified is not supported for Android, and will default to 'Left'. If you leave the UILabel alignment to neutral for iOS, it will override with the font allignment. If you specify an alignment the text alignment from the font will be ignored.

IOSFont/AndroidFont

In case you want to use fonts specifically for iOS or Android, use the IOSFont or AndroidFont. This can be particullary handy if you want modified multipliers or different fonts because of rendering issues.

Cross

Setup

You can add fonts like this:

plugin.AddFont(new Font() { Name = "H1", 	FontFilename = "Awesome-font.ttf", FontPlatformName = "Awesome", Size = 16,Color = plugin.GetColor("BlueDark")});

Setup Tags

You can also add tags to the font. When you have a paragraph like so :

This is a piece of text

And want to hightlight 'piece' with a different font, you can configure fonts like so.

Define the tags you want the font to listen to :
List<FontTag> tags = new List<FontTag>();
tags(new FontTag(FontItalic, "b"));
Add the fonts :

Add the font, and add the tags to the font you want to use as highlight.

plugin.AddFont(new Font() { Name = "H1", 	FontFilename = "font.ttf", FontPlatformName = "fontname", Size = 16,Color = plugin.GetColor("DefaultColor")});
plugin.AddFont(new IOSFont() { Name = "H1_Highlight", 	FontFilename = "font.ttf", FontPlatformName = "fontname", Size = 16,Color = plugin.GetColor("DefaultColor")},tags);	

Your paragraph should look like this :

This is a <b>piece</b> of text
Duplicate fonts
Fonts.CopyFont<TRefFont,TFont>(TRefFont font,string fontId)

Example :

var regularFontAndroid = Font.CopyFont<iOSFont,AndroidFont>(regularFontiOS, "Regular");

To easily modify the fonts you can use setters :

var regularFontAndroid = (AndroidFont)Font.CopyFont<iOSFont,AndroidFont>(regularFontiOS, "Regular").SetLineHeight(20.0f);
Links

To support clickable links in your content use :

new FontTag(FontItalic, "a",FontTagAction.Link)

Text could look like :

This is a <a href="www.google.com">google</a> of text
This is a <a href=www.google.com>google</a> of text
This is a <a href='www.google.com'>google</a> of text
This is a <a>www.google.com</a> of text

For iOS this is only supported vor UITextViews. Remember to turn off editable and turn on selectable. You don't have to set the detectors.

LineHeight/Multiplier

If you want 2 fonts to allign, you could do the following :

plugin.AddFont(new Font() { Name = "H1", FontFilename = "f.ttf", FontPlatformName = "f", Size = 20});
plugin.AddFont(new Font() { Name = "H2", FontFilename = "f2.ttf", FontPlatformName = "f2", Size = 10,LineHeightMultiplier=2.0f});

iOS

Setup

To be able to access your custom fonts, add the font files to Resources/Fonts. You'll also have to add an entry to your Info.plist. Add an Array call 'UIAppFonts'. For each font, add 1 string entry to the array with the path to your font (in this case it will be "Fonts/Awesome-font.otf"

For all fonts you'll have to fill the FontPlatformName property. iOS doesn't refer to fonts with the actual file name but by a tag. You can find it's name in the FontBook under PostScript Name.

UIViewController

To bind a font only, you can use :

this.BindFont(Button, "H1");
this.BindFont(Label, "H1");

It's available for UIButton, UILabel and UITextField

When you're using the BindFont binding, it will not setup your line height and allignment. In order to do this use :

bindingSet.Bind(Label).For(v => v.AttributedText).To(vm => vm.Label).WithConversion("AttributedFontText", "H1");

You can also mark part of the text bold by adding * * in the bound string. The plugin will look for a boldfont within the referenced font. For example:

"This is *bold* text"

"This is" will be the regular font, "bold" will be set in the bold font (set in the Font object).

In case you're using Babel MvvmCross resource loader you can use :

this.BindLanguageFont(Label, "LanguageKey", "H1");

UITableViewCell

For UITableViewCells you can only use :

bindingSet.Bind(Label).For(v => v.AttributedText).To(vm => vm.Label).WithConversion("AttributedFontText", "H1");

Override colors

In some cases you would want to override the color of a default font. The color is the only property that can be overriden. In case you want to override the color you can add a color name to the binding

View

this.BindFont(Label, "H1","BlueDark");
this.BindLanguageFontColor(Label, "LanguageKey", "H1","BlueDark");
this.BindLanguageFont(Label, "LanguageKey", "H1:BlueDark");

Cells

set.Bind(Label).For(v => v.AttributedText).To(vm => vm.Text).WithConversion("AttributedFontText", "H1:BlueDark");

Bindable

It's also possible to bind the textcolor name. You'll have to add an extra binding for the textcolor only :

set.Bind(Label).For(v=>v.TextColor).To(vm=>vm.ColorName).WithConversion("AssetColor");

Android

Setup

To be able to access your custom fonts. Add them in your Droid project under Assets/Fonts.

Activity

To bind a font you can use :

<Button
	android:layout_width="wrap_content"
	android:layout_height="wrap_content"
	local:MvxFont="Font H1" />

You can combine this with the MvxLang binding. It's available for TextView, EditText and Button.

Cells

To bind a font within a cell you can use :

<TextView
	android:layout_width="wrap_content"
	android:layout_height="wrap_content"
	android:layout_gravity="center_vertical"
	local:MvxBind="Font ,Converter=FontResource,ConverterParameter=H1" />
	
<TextView
	android:layout_width="wrap_content"
	android:layout_height="wrap_content"
	android:layout_gravity="center_vertical"
	local:MvxBind="Font Empty,Converter=FontResource,ConverterParameter=H1" />

Note that there is no actual property the font binds to. You can bind nothing, or use the Empty property you'll get implementing the IStylable interface. If you bind a color name it will override the font's color (see override colors)

Override colors

In some cases you would want to override the color of a default font. The color is the only property that can be overriden. In case you want to override the color you can add a ':ColorName' to the font name:

Views

This works for the MvxFont tag:

<TextView
	android:layout_width="wrap_content"
	android:layout_height="wrap_content"
	local:MvxFont="Font H1:BlueDark" />

Cells

<TextView
	android:layout_width="wrap_content"
	android:layout_height="wrap_content"
	local:MvxBind="Font ,Converter=FontResource,ConverterParameter=H1:BlueDark" />

Bindable

In case you want to bind the color you can use the color name as bindable property (note: not ideal, might replace this with an object to set properties).

<TextView
	android:layout_width="wrap_content"
	android:layout_height="wrap_content"
	local:MvxBind="Font ColorName,Converter=FontResource,ConverterParameter=H1" />

NUGET

https://www.nuget.org/packages/Mvx.Plugin.Style/

Next

  • Support for Sketch font exports.
  • Support for online exports of fonts (designers can upload definitions, and the app will change runtime).

About

Font and color plugin for Mvvmcross

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages