btrz-liquid-templates 1.6.0 → 1.7.0

package/docs/index.md

@@ -148,7 +148,7 @@ Small condensed fonts
 
 * ## lineSpacing
 
-Line spacing to 1/6 of an inch
+Line spacing to 1/9 of an inch
 
 ```liquid
 {% raw%} {% lineSpacing %} {% endraw %}
@@ -156,12 +156,39 @@ Line spacing to 1/6 of an inch
 
 * ## lineSpacing2
 
-Line spacing to 1/9 of an inch
+Line spacing to 1/6 of an inch
 
 ```liquid
 {% raw%} {% lineSpacing2 %} {% endraw %}
 ```
 
+* ## lineSpacingX
+
+Sets the line spacing to n/216 inch
+
+```liquid
+{% raw%} {% lineSpacingX value %} {% endraw %}
+```
+
+#### Parameters
+
+| name | range | required | default |
+|------|------------|----------|---------|
+| pos | 0 <= value <= 255 | Y |  |
+
+* value: Number of vertical dots to insert between lines. For example, a value of 24 sets the line spacing to 1/9 inch.
+
+#### Common Values (for reference) 9-Pin ESC/P
+
+| Value | Inches | Description           |
+| ----- | ------ | --------------------- |
+| 6     | 1/36   | Very tight spacing    |
+| 12    | 1/18   | Tight spacing         |
+| 24    | 1/9    | Standard compact text |
+| 36    | 1/6    | Default line spacing  |
+| 48    | 2/9    | Loose spacing         |
+| 72    | 1/3    | Very loose spacing    |
+
 * ## escNewLine
 
 New line

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "btrz-liquid-templates",
-  "version": "1.6.0",
+  "version": "1.7.0",
   "description": "Extension and helpers for liquid templates to deal with our data and other things we need to encapsulate",
   "main": "src/index.js",
   "scripts": {

package/src/escp.js

@@ -30,6 +30,29 @@ function lineSpacing2(engine) {
   });
 }
 
+function lineSpacingX(engine) {
+  this.registerTag("lineSpacingX", {
+    parse: function(tagToken, remainTokens) {
+      try {
+        const args = (tagToken.args || "").split(" ");
+        this.spacingValue = args[0] || 0;
+      } catch (err) {
+        this.spacingValue = args[0] || 0;
+      }
+    },
+    render: async function(ctx) {
+      try {
+        const spacing = this.spacingValue < 0 ? 0 : this.spacingValue > 255 ? 255 : this.spacingValue;
+        const value = String.fromCharCode(spacing);
+        const escLineSpacingX = "\x1B\x33" + value;
+        return escLineSpacingX;
+      } catch (e) {
+        return "PNA";
+      }
+    }
+  });
+}
+
 function fontSelection(engine) {
   this.registerTag("fontSelection", {
     parse: function(tagToken, remainTokens) {
@@ -144,6 +167,7 @@ module.exports = {
   escInitQzTray,
   lineSpacing,
   lineSpacing2,
+  lineSpacingX,
   fontSelection,
   escBold,
   escCancelBold,

package/src/index.js

@@ -17,6 +17,7 @@ const {
   escInitQzTray,
   lineSpacing,
   lineSpacing2,
+  lineSpacingX,
   fontSelection,
   escBold,
   escCancelBold,
@@ -98,6 +99,7 @@ module.exports = {
     engine.plugin(escInitQzTray);
     engine.plugin(lineSpacing);
     engine.plugin(lineSpacing2);
+    engine.plugin(lineSpacingX);
     engine.plugin(fontSelection);
     engine.plugin(escBold);
     engine.plugin(escCancelBold);