To help you get started, we've collected the most common ways that meaw is being used within popular public projects.

susisu / atom-markdown-table-editor / lib / table.js View on Github

function length(str, eawOptions) {
  let len = 0;
  for (const char of str) {
    if (eawOptions.alwaysWideChars.has(char)) {
      len += 2;
      continue;
    }
    if (eawOptions.alwaysNarrowChars.has(char)) {
      len += 1;
      continue;
    }
    switch (getEAW(char)) {
    case 'F':
    case 'W':
      len += 2;
      break;
    case 'A':
      len += eawOptions.ambiguousAsWide ? 2 : 1;
      break;
    default:
      len += 1;
    }
  }
  return len;
}

View more ways to use meaw

meaw

Utilities for Unicode East Asian Width (EAW).

Installation

# npm
npm i --save meaw
# yarn
yarn add meaw
# pnpm
pnpm add meaw

Usage

getEAW()

Gets the EAW property of a character.

import { getEAW } from "meaw";

// Narrow
assert(getEAW("A") === "Na");
// Wide
assert(getEAW("あ") === "W");
assert(getEAW("安") === "W");
assert(getEAW("🍣") === "W");
// Fullwidth
assert(getEAW("Ａ") === "F");
// Halfwidth
assert(getEAW("ｱ") === "H");
// Ambiguous
assert(getEAW("∀") === "A");
assert(getEAW("→") === "A");
assert(getEAW("Ω") === "A");
assert(getEAW("Я") === "A");
// Neutral
assert(getEAW("ℵ") === "N");

// character position (in code unit) can be specified
assert(getEAW("ℵAあＡｱ∀", 2) === "W");

computeWidth()

Deprecated. To calculate the visual width of a string, it is recommended to split the string into graphemes (using Intl.Segmenter or libraries like graphemer) and then calculate the widths of them.

Computes an approximate width of a string based on the EAW properties of the characters. By default, characters with property Wide (W) or Fullwidth (F) are treated as wide (= 2) and others are as narrow (= 1).

import { computeWidth } from "meaw";

assert(computeWidth("Aあ🍣Ω") === 6);
// character width for each EAW property can be customized
assert(computeWidth("Aあ🍣Ω", { "A": 2 }) === 7);

Development

Setup

git clone https://github.com/susisu/meaw.git
cd meaw
pnpm i

Scripts

License

MIT License

Author

Susisu (GitHub, Twitter)