Important: This documentation covers Yarn 1 (Classic).
For Yarn 2+ docs and migration guide, see yarnpkg.com.

Package detail

@sutton-signwriting/font-ttf

a javascript package for node that generates SVG and PNG images for individual symbols, complete signs, and structured text. The package covers the entire set of the International SignWritnig Alphabet 2010 (ISWA 2010).

truetype, ttf, font, sutton, signwriting, sign language, script, browser

readme

@sutton-signwriting/font-ttf

Gitter version npm downloads

SignWriting

@sutton-signwriting/font-ttf is a javascript package for the browser that generates SVG and PNG images for individual symbols, complete signs, and structured text. The package covers the entire set of the International SignWritnig Alphabet 2010 (ISWA 2010) using TrueType Fonts.

This package supports both Formal SignWriting in ASCII (FSW) and SignWriting in Unicode (SWU) character sets, along with the style string. See draft-slevinski-formal-signwriting for detailed specification.

Author: https://SteveSlevinski.me
Channel: https://www.youtube.com/channel/UCXu4AXlG0rXFtk_5SzumDow
Sponsor: https://www.patreon.com/signwriting
Donate: https://donate.sutton-signwriting.io

Installation

Install TrueType Font

The TrueType Fonts can be installed on Windows, Mac, and Linux. For iOS, two mobile configurations are available. Installation is not possible on Android.

Install with NPM

    npm install @sutton-signwriting/font-ttf

Install with GIT

    # download package
    git clone https://github.com/sutton-signwriting/font-ttf.git

    # install dependencies
    cd font-ttf
    npm install
    sudo apt install node-typescript

    # create project documentation
    npm run docs

    # create project files
    npm run build

Usage

Using as a module

    // import entire library
    import * as ttf from '@sutton-signwriting/font-ttf'

    // import individual module
    import {font} from '@sutton-signwriting/font-ttf'

Using in the Browser

Local files

    // import entire library
    // available as ssw.ttf
    <script src="index.js"></script>

    // import individual module
    // available as ssw.ttf.font
    <script src="font/font.js"></script>

Unpkg

    // import entire library
    // available as ssw.ttf
    <script src="https://unpkg.com/@sutton-signwriting/font-ttf@1.5.2"></script>

    // import individual module
    // available as ssw.ttf.font
    <script src="https://unpkg.com/@sutton-signwriting/font-ttf@1.5.2/font/font.min.js"></script>

Configure font for VS Code

File >> Preferences >> Settings

Search for "font family". Append SuttonSignWritingOneD to the list of fonts. Restart VS Code.

License

MIT

SignWriting General Interest

changelog

Changelog

All notable changes to this project will be documented in this file.

The format is based on Keep a Changelog, and this project adheres to Semantic Versioning.

Unreleased

Todo

  • ...

[1.6.0] - 2024-12-08

Updated

  • sutton-signwriting/core to v2 to support the SignWriting null symbol

Added

  • symbol transformation "invert" which is a horizontal mirror for both FSW and SWU

Fixed

  • security issue

1.5.2 - 2023-10-21

Fixed

  • security issue

1.5.1 - 2023-10-01

Fixed

  • security issue

1.5.0 - 2023-03-11

Added

  • symbol transformations: mirror, rotate, flop, and scroll

Updated

  • tests and documentation

Fixed

  • symbol size for bad input

1.4.5 - 2023-02-11

Fixed

  • frequent canvas read warning

1.4.4 - 2023-01-09

Fixed

  • security issue

1.4.3 - 2022-11-07

Changed

  • donate link

1.4.2 - 2022-10-13

Changed

  • types to @sutton-signwritng/core types with optional properties

1.4.1 - 2022-09-25

Removed

  • types and exports from package.json

1.4.0 - 2022-09-24

Added

  • TypeScript definitions

Changed

  • imports to use modules rather than functions

Fixed

  • security issue

1.3.2 - 2022-04-23

Added

  • data types in documentation

Fixed

  • symbol normalization
  • symbol svg size
  • testing

1.3.1 - 2022-03-30

Fixed

  • SVG formatting
  • security dependency

1.3.0 - 2022-03-20

Added

  • SVG Body functions
  • Column SVG images
  • Column PNG images

Removed

  • Individual symbol resizing and offset inside of signs

1.2.1 - 2022-01-22

Changed

  • Delay DOM setup for server side rendering

1.2.0 - 2020-07-24

Changed

  • Updated font CDN to use jsdelivr.net

1.1.0 - 2020-02-19

Changed

  • Updated font CDN to use Unpkg

1.0.0 - 2019-12-09

Added

  • core modules of font, fsw and swu for individual symbols and complete signs
  • documentation for core modules