term_glyph 1.0.0

This library contains getters for useful Unicode glyphs as well as plain ASCII alternatives. It's intended to be used in command-line applications that may run on Windows and libraries that may be used by those applications.

We recommend that you import this library with the prefix "glyph". For example:

import 'package:term_glyph/term_glyph.dart' as glyph;

/// Formats [items] into a bulleted list, with one item per line.
String bulletedList(List<String> items) =>
    items.map((item) => "${glyph.bullet} $item").join("\n");

ASCII Mode

The default Windows cmd.exe shell is unable to display Unicode characters, so this package is able to transparently switch its glyphs to ASCII alternatives by setting the ascii attribute. When this attribute is true, all glyphs use ASCII characters instead. It currently defaults to false, although in the future it may default to true for applications running on the Dart VM on Windows. For example:

import 'dart:io';

import 'package:term_glyph/term_glyph.dart' as glyph;

void main() {
  glyph.ascii = Platform.isWindows;

  // Prints "Unicode => ASCII" on Windows, "Unicode ━▶ ASCII" everywhere else.
  print("Unicode ${glyph.rightArrow} ASCII");
}

All ASCII glyphs are guaranteed to be the same number of characters as the corresponding Unicode glyphs, so that they line up properly when printed on a terminal. The specific ASCII text for a given Unicode glyph may change over time; this is not considered a breaking change.

1.0.0

  • Initial version.

1. Depend on it

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

dependencies:
  term_glyph: "^1.0.0"

2. Install it

You can install packages from the command line:

$ pub get

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

3. Import it

Now in your Dart code, you can use:

import 'package:term_glyph/term_glyph.dart';
Version Uploaded Documentation Archive
1.0.0 Jan 6, 2017 Go to the documentation of term_glyph 1.0.0 Download term_glyph 1.0.0 archive

About

Useful glyphs and Windows-safe equivalents.

Author

Email misc@dartlang.org Dart Team

Homepage

github.com/dart-lang/term_glyph

Documentation

www.dartdocs.org/documentation/term_glyph/1.0.0/

Source code (hyperlinked)

www.crossdart.info/p/term_glyph/1.0.0/

Uploader

nweiz@google.com

Published

Jan 6, 2017

Share