https://github.com/matteobortolazzo/HtmlLabelPlugin

Use this Xamarin.Forms plugin to display HTML content into a label.
https://github.com/matteobortolazzo/HtmlLabelPlugin

android forms html ios labels uwp xamarin xamarin-forms xamarin-plugin

Last synced: 3 months ago
JSON representation

Use this Xamarin.Forms plugin to display HTML content into a label.

• Host: GitHub
• URL: https://github.com/matteobortolazzo/HtmlLabelPlugin
• Owner: matteobortolazzo
• License: mit
• Created: 2017-05-29T08:46:25.000Z (over 7 years ago)
• Default Branch: master
• Last Pushed: 2022-12-30T07:30:38.000Z (almost 2 years ago)
• Last Synced: 2024-06-29T20:54:31.758Z (4 months ago)
• Topics: android, forms, html, ios, labels, uwp, xamarin, xamarin-forms, xamarin-plugin
• Language: C#
• Homepage:
• Size: 1.49 MB
• Stars: 137
• Watchers: 13
• Forks: 64
• Open Issues: 15
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE

Awesome Lists containing this project

• awesome-xamarin-forms - Xam.Plugin.HtmlLabel ★132

README

        
[![Build Status](https://dev.azure.com/matteobortolazzo/HtmlLabel/_apis/build/status/matteobortolazzo.HtmlLabelPlugin?branchName=master)](https://dev.azure.com/matteobortolazzo/HtmlLabel/_build/latest?definitionId=26&branchName=master)

[![Downloads](https://img.shields.io/nuget/dt/Xam.Plugin.HtmlLabel.svg)](https://www.nuget.org/packages/Xam.Plugin.HtmlLabel/)

# HTML Label Plugin for Xamarin.Forms

Use this Xamarin.Forms plugin to display HTML content into a label.

## Setup

* Available on [NuGet](https://www.nuget.org/packages/Xam.Plugin.HtmlLabel)

* Install it in every Xamarin.Forms project.

* **iOS**: AppDelegate.cs

    ```cs

    HtmlLabelRenderer.Initialize();

    global::Xamarin.Forms.Forms.Init();

    ```

* **Android**: MainActivity.cs

    ```cs

    HtmlLabelRenderer.Initialize();

    global::Xamarin.Forms.Forms.Init(this, bundle);

    ```

* **UWP**: App.xaml.cs

    ```cs

    var rendererAssemblies = new[] { typeof(HtmlLabelRenderer).GetTypeInfo().Assembly };

    Xamarin.Forms.Forms.Init(e, rendererAssemblies);

    HtmlLabelRenderer.Initialize();

    ```      

## How it works

On iOS and Android it uses the native HTML rendering capabilities of iOS's UILabel and Android's TextView. 

UWP's TextBlock cannot renders HTML so the library parses the HTML and uses Inlines to display: `, , 
, , , 
, , , 
 
, 
`.


FontAttributes, FontFamily, FontSize, TextColor, HorizontalTextAlignment are converted into inline CSS in a wrapping `
` for iOS and Android. UWP supports them natively.


## Custom styling

If you need to customize something in Android or iOS you can use inline CSS, for example: 

`...`

For underlined text use the <u> tag:

`Some underlined text`

**For links**: remember to add the schema (http:// https:// tel:// mailto:// ext...)

**WARNING**: not all styles are supported by each platform!

## Supported Properties

* Text

* FontAttributes

* FontFamily

* FontSize

* TextColor

* HorizontalTextAlignment

* LineHeight (iOS, UWP)

* UnderlineText

* LinkColor

* BrowserLaunchOptions

* AndroidLegacyMode

## Events

Navigating

Navigated

## Usage XAML

```xaml

xmlns:htmlLabel="clr-namespace:LabelHtml.Forms.Plugin.Abstractions;assembly=HtmlLabel.Forms.Plugin"

```

## Usage C#

```csharp

var label = new HtmlLabel();

label.Text = "..htmlstring.."

```

## Links

It is possible to customize *links*: 

* Color

* Underline

* Browser options

[*Browser options*](https://docs.microsoft.com/en-us/xamarin/essentials/open-browser) are applied with the following schemas: *http*, *https*, *mailto*, *tel*, *sms* and *geo*.

**WARNING**: This project uses [Xamarin.Essentials](https://docs.microsoft.com/en-us/xamarin/essentials/) to provide native *Email*, *Phone Dial*, *SMS* and *Maps* support. Please check the [getting started](https://docs.microsoft.com/en-us/xamarin/essentials/get-started) page.

**iOS WARNING**: Changing the style of iOS links is not supported by *iOS* intentionally and this plugin use a workaround. From *Apple*:

> To promote consistency, the intended behavior is for ranges that represent links (specified via NSLinkAttributeName) to be drawn using the default link appearance.

**UWP WARNING**: The minimum target for UWP is *17763*. If set to an older version, it won't find the assembly.

## Android's Legacy Mode

Settings the property `AndroidLegacyMode` to *True* the renderer separates block-level elements with blank lines.

## Limitations

* XF Label's TextType="HTML" disables this implementation.

* Adding *GestureRecognizers* will disabled links.

* List of Android's supported tags [here](https://developer.android.com/guide/topics/resources/string-resource.html#FormattingAndStyling).

### Contributions

Contributions are welcome!

### License

Under MIT, see LICENSE file.