txt2svg

Tool for creating svg from text with chosen fonts and svg-styles.

---

Usage

npm i --save-dev txt2svg

Guide

const generateSVG = require('txt2svg');
/*
...some code
*/
generateSVG(fontsRoot, output, dictionary, svgParams, isOneStyleForSubDir);

generateSVG function has 4 necessary arguments and 1 unnecessary:

• fontsRoot - is path to directory with fonts. Fonts should be placed in this directory.

  const fontsPath = path.resolve(__dirname, './fonts');

• output - is config of your output.

  const localesOutput = {
    root: path.resolve(__dirname, './output/locales'),
    subDirs: ['en', 'ru', 'ge', 'fr', 'it']
  };

  • output.root - is root path to your output directory (may not exist).

  • output.subDirs - is array of sub-directories in the root directory (may not exist). Need for cycling by locales or by styles-type.

• dictionary - is config for your dictionary. You can configure dictionary like output passing root and subDirs arguments - in this case phrase collections (jsons) should exist in the root dictionary with subDirs naming (useful for creating txt-svg for different locales).

  const dictionary = {
  root: path.resolve(__dirname, './dictionary'),
  subDirs: ['en', 'ru', 'ge', 'fr', 'it']
  };

  Also, you can pass here an collection of dictionaries with string-subDirs keys:

  const dictionary = {
      en: {
        phrase1: 'Hello there',
        phrase2: 'General Kenobi',    
      },
      ru: {
        phrase1: 'Ну привет',
        phrase2: 'Генерал Кеноби',    
      },
  };

  Or you can pass one dictionary (there is no cycle by locales in this case):

  const dictionary = {
    phrase1: 'Hello there',
    phrase2: 'General Kenobi',
  };
  // also possible (in this case value === name of future svg)
  const dictionary1 = ['Hello there', 'General Kenobi'];
  const dictionary2 = ['1', '2', '3'];

• svgParams - this is config for your svg. In example bellow you can see all options that you can pass.

  const svgParams = {
    phrase1: {
      font: "riffic-bold.ttf",
      width : 590, // unnecessary param
      height : 590, // unnecessary param
      lineSpacing: 10, // unnecessary param
      paddingX: 5, // unnecessary param
      paddingY: 5, // unnecessary param
      alignX: 'center', // unnecessary param
      alignY: 'top', // unnecessary param
      styles: {
        "stroke-width": "4px",
        "stroke": "#321a1e",
        "fill": "red",
        // order of filters is important,
        // always use innerShadow first
        "filter": {
          // only one inner shadow can be aplied 
          "innerShadow": {
            "dy": 15,
            "dx": 15,
            "stdDeviation": "15",
            "color": "green",
            "opacity": "1"
          },
          // array of outer shadow
          "outerShadows": [
            { "dx": "0", "dy": "2", "stdDeviation": "1", "flood-color": "#000000", "flood-opacity": "0.4" },
            { "dx": "5", "dy": "0", "stdDeviation": "4", "flood-color": "red", "flood-opacity": "1" },
            { "dx": "0", "dy": "15", "stdDeviation": "10", "flood-color": "blue", "flood-opacity": "0.8" }
          ]
          // also you can specify others filters as objects
        },
        // linearGradient will overwrite "fill" option
        "linearGradient": {
          "x1": "0%",
          "y1": "0%",
          "x2": "0%",
          "y2": "100%",
          "offsets": {
            "0%": {
              "stop-color": "#facc22"
            },
            "100%": {
              "stop-color": "#f83600"
            }
          }
        }
      }
    }
  };

Examples

Run "scriptForRun.js" to try by yourself!

Example code