html_unescape #

A Dart library for unescaping HTML-encoded strings.

Supports:

Named Character References ( )
- 2099 of them
Decimal Character References (á)
Hexadecimal Character References (ã)

The idea is that while you seldom need encoding to such a level (most of the time, all you need to escape is <, >, /, & and "), you do want to make sure that you cover the whole spectrum when decoding from HTML-escaped strings.

Inspired by Java's unbescape library.

Usage #

A simple usage example:

import 'package:html_unescape/html_unescape.dart';

main() {
  var unescape = new HtmlUnescape();
  var text = unescape.convert("&lt;strong&#62;This &quot;escaped&quot; string");
  print(text);
}

You can also use the converter to transform a stream. For example, the code below will transform a POSIX stdin into an HTML-unencoded stdout.

await stdin
    .transform(new Utf8Decoder())
    .transform(new HtmlUnescape())
    .transform(new Utf8Encoder())
    .pipe(stdout);

Full versus small #

If you're sure you will only encounter the most common escaped characters, you can import 'package:html_unescape/html_unescape_basic.dart' instead of the full version. This will decrease code size and increase performance. The only difference is in the size of the Named Character Reference dictionary. The full set includes the likes of &DownLeftRightVector; or &UpArrowBar; while the small set only includes the first 255 charcodes.

Issues #

Please use GitHub tracker. Don't hesitate to create pull requests, too.

Changelog #

1.0.1 #

Upgrade to Dart 2

1.0.0 #

Bump to 1.0. The package has baked for 2 years now.

0.1.5 #

Remove deprecated dependency on ChunkedConverter (author: @andresaraujo)
Loosen dev dependency on path

older #

(No records. Please see commit history.)

example/example.dart

// Copyright (c) 2018, Filip Hracek. All rights reserved. Use of this source
// code is governed by a BSD-style license that can be found in the LICENSE
// file.

import 'package:html_unescape/html_unescape.dart';

void main() {
  var unescape = new HtmlUnescape();
  print(unescape.convert("&lt;strong&#62;This &quot;escaped&quot; string "
      "will be printed normally.</strong>"));
}

Use this package as a library

1. Depend on it

Add this to your package's pubspec.yaml file:


dependencies:
  html_unescape: ^1.0.1+2

2. Install it

You can install packages from the command line:

with pub:


$ pub get

with Flutter:


$ flutter pub get

Alternatively, your editor might support pub get or flutter pub get. Check the docs for your editor to learn more.

3. Import it

Now in your Dart code, you can use:


import 'package:html_unescape/html_unescape.dart';

Version	Uploaded	Documentation	Archive
1.0.1+2	Jul 26, 2018
1.0.1+1	Jul 23, 2018
1.0.1	Jul 23, 2018
1.0.0	May 18, 2018
0.1.5	May 30, 2017
0.1.4	May 25, 2016
0.1.3	May 25, 2016
0.1.2	May 25, 2016
0.1.1	May 25, 2016
0.1.0	May 25, 2016

All 11 versions...

Popularity: Describes how popular the package is relative to other packages. [more]	93
Health: Code health derived from static analysis. [more]	100
Maintenance: Reflects how tidy and up-to-date the package is. [more]	100
Overall: Weighted score of the above. [more]	96

Learn more about scoring.

We analyzed this package on May 22, 2019, and provided a score, details, and suggestions below. Analysis was completed with status completed using:

Dart: 2.3.1
pana: 0.12.16

Platforms

Detected platforms: Flutter, web, other

No platform restriction found in primary library package:html_unescape/html_unescape.dart.

Health suggestions

Fix lib/src/base.dart. (-0.50 points)

Analysis of lib/src/base.dart reported 1 hint:

line 29 col 9: Use contains instead of indexOf

Dependencies

Package	Constraint	Resolved	Available
Direct dependencies
Dart SDK	>=1.23.0 <3.0.0
Dev dependencies
path	>=1.3.9 <2.0.0
test	>=0.12.0 <2.0.0

Dart pub

html_unescape 1.0.1+2