Merge pull request #401 from cloudinary/feature/add-stroke-solid

Feature/add stroke solid

Author: strausr

__TESTS__/unit/values/TextStyle/TextStyle.test.ts

@@ -5,6 +5,8 @@ import {FontWeight} from "../../../../src/qualifiers/fontWeight";
 import {FontHinting} from "../../../../src/qualifiers/fontHinting";
 import {TextDecoration} from "../../../../src/qualifiers/textDecoration";
 import {TextAlignment} from "../../../../src/qualifiers/textAlignment";
+import {Stroke} from "../../../../src/qualifiers/textStroke";
+import {Color} from "../../../../src/qualifiers/color";
 
 describe('Text Style tests', () => {
   it('Create a new instance', () => {
@@ -35,6 +37,14 @@ describe('Text Style tests', () => {
     expect(res).toBe('arial_50_bold_italic_strikethrough_justify_stroke_letter_spacing_10_line_spacing_20_antialias_good_hinting_full');
   });
 
+  it('Create a new instance with stroke solid', () => {
+    const res = new TextStyle('arial', 50)
+      .stroke(Stroke.solid(2, Color.WHITE))
+      .toString();
+    expect(res).toBe('arial_50_stroke_bo_2px_solid_white');
+  });
+
+
   it('Ensure normal is not included in the URL(this is the default)', () => {
     const res = new TextStyle('arial', 50)
       .fontWeight(FontWeight.normal())

src/qualifiers.ts

@@ -31,11 +31,13 @@ import {StreamingProfile} from "./qualifiers/streamingProfile";
 import {TextAlignment} from "./qualifiers/textAlignment";
 import {TextDecoration} from "./qualifiers/textDecoration";
 import {GradientFade} from "./qualifiers/GradientFade";
+import {Stroke} from "./qualifiers/textStroke";
 
 
 const Qualifiers = {
   TextDecoration,
   TextAlignment,
+  Stroke,
   StreamingProfile,
   SimulateColorBlind,
   RotationMode,

src/qualifiers/textStroke.ts

@@ -0,0 +1,25 @@
+import {SystemColors} from "./color";
+import {ExpressionQualifier} from "./expression/ExpressionQualifier";
+/**
+ * @description Contains function to set the outline stroke.
+ * <b>Learn more</b>: {@link https://cloudinary.com/documentation/image_transformations#adding_text_overlays | Adding text overlays to images}
+ * <b>Learn more</b>: {@link https://cloudinary.com/documentation/video_manipulation_and_delivery#adding_text_captions | Adding text overlays to videos}
+ * @memberOf Qualifiers
+ * @namespace TextAlignment
+ * @see To be used with {@link Qualifiers.TextStyle|Text Style}
+ */
+
+
+/**
+ * @summary qualifier Adding a Border-like qualifier to the same action.
+ * @memberOf Qualifiers.Stroke
+ * @param {number|string|ExpressionQualifier} width The width in pixels.
+ * @param {number|string|SystemColors} color The color of the border.
+ */
+function solid(width: number | string | ExpressionQualifier, color: number | string | SystemColors): string{
+  return `bo_${width}px_solid_${color}`;
+}
+
+const Stroke = {solid};
+
+export {Stroke, solid};

src/qualifiers/textStyle.ts

@@ -23,6 +23,7 @@ class TextStyle {
   private _textDecoration: string;
   private _textAlignment: string;
   private _stroke: boolean;
+  private _strokeStyle: string;
   private _fontHinting: string;
 
   /**
@@ -127,7 +128,10 @@ class TextStyle {
   /**
    * @description Whether to include an outline stroke. Set the color and weight of the stroke
    */
-  stroke(): this {
+  stroke(textStroke?: string): this {
+    if(textStroke) {
+      this._strokeStyle = textStroke;
+    }
     this._stroke = true;
     return this;
   }
@@ -140,6 +144,7 @@ class TextStyle {
       this._textDecoration !== normalTextDecoration() && this._textDecoration,
       this._textAlignment,
       this._stroke && 'stroke',
+      this._strokeStyle,
       this._letterSpacing && `letter_spacing_${this._letterSpacing}`,
       this._lineSpacing && `line_spacing_${this._lineSpacing}`,
       this._fontAntialias && `antialias_${this._fontAntialias}`,