@gisce/ooui 1.0.0-alpha.4 → 1.0.0-alpha.6

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@gisce/ooui",
-  "version": "1.0.0-alpha.4",
+  "version": "1.0.0-alpha.6",
   "engines": {
     "node": "20.5.0"
   },

package/src/Field.ts

@@ -1,5 +1,5 @@
 import Widget from "./Widget";
-import { replaceEntities } from "./helpers/attributeParser";
+import { replaceEntities, isTrue } from "./helpers/attributeParser";
 
 class Field extends Widget {
   /**
@@ -69,6 +69,18 @@ class Field extends Widget {
     this._tooltip = value;
   }
 
+  /**
+   * Tooltip inline
+   */
+  _tooltipInline: boolean = false;
+  get tooltipInline(): boolean {
+    return this._tooltipInline;
+  }
+
+  set tooltipInline(value: boolean) {
+    this._tooltipInline = value;
+  }
+
   /**
    * Activated (default is true)
    */
@@ -152,6 +164,10 @@ class Field extends Widget {
       if (props.selection) {
         this._selectionValues = new Map(props.selection);
       }
+
+      if (props.help_inline) {
+        this.tooltipInline = isTrue(props.help_inline);
+      }
     }
   }
 

package/src/Widget.ts

@@ -12,14 +12,14 @@ abstract class Widget {
   }
 
   /**
-   * Determines if widget is read only (default is false)
+   * Determines if widget is read only (default is undefined)
    */
-  _readOnly: boolean;
-  get readOnly(): boolean {
+  _readOnly: boolean | undefined;
+  get readOnly(): boolean | undefined {
     return this._readOnly;
   }
 
-  set readOnly(value: boolean) {
+  set readOnly(value: boolean | undefined) {
     this._readOnly = value;
   }
 
@@ -106,20 +106,25 @@ abstract class Widget {
 
   constructor(props?: any) {
     this._colspan = Widget._defaultColspan;
-    this._readOnly = false;
     this._invisible = false;
 
     if (props) {
       if (props.colspan) {
         this._colspan = +props.colspan;
       }
-      if (props.readonly) {
+      if (props.readonly !== undefined) {
         if (
           props.readonly === "1" ||
           props.readonly === 1 ||
           props.readonly === true
         ) {
           this._readOnly = true;
+        } else if (
+          props.readonly === "0" ||
+          props.readonly === 0 ||
+          props.readonly === false
+        ) {
+          this._readOnly = false;
         }
       }
       if (props.invisible) {

package/src/helpers/attributeParser.ts

@@ -1,5 +1,10 @@
 import { decode } from "html-entities";
 
+export const isTrue = (value: string | boolean | number = false) => {
+  value = JSON.parse(value.toString().toLowerCase());
+  return +value > 0;
+};
+
 const evaluateCondition = ({
   entry,
   values,

package/src/spec/Form.spec.ts

@@ -335,29 +335,54 @@ describe("A Form", () => {
     }
   });
 
-  it("should be able to parse a field with tooltip", () => {
-    const fields = {
-      char1: {
-        size: 128,
-        string: "Name",
-        type: "char",
-        help: "tooltip string",
-      },
-    };
-    const xmlViewForm = `<?xml version="1.0"?>
-    <form string="Form1">
-        <group name="group">
-            <field colspan="1" name="char1" />
-        </group>
-    </form>`;
-    const form = new Form(fields);
-    form.parse(xmlViewForm);
+  describe("If field has a help message", () => {
+    it("should be able to parse a field with tooltip", () => {
+      const fields = {
+        char1: {
+          size: 128,
+          string: "Name",
+          type: "char",
+          help: "tooltip string",
+        },
+      };
+      const xmlViewForm = `<?xml version="1.0"?>
+      <form string="Form1">
+          <group name="group">
+              <field colspan="1" name="char1" />
+          </group>
+      </form>`;
+      const form = new Form(fields);
+      form.parse(xmlViewForm);
 
-    const field = form.findById("char1") as Char;
-    expect(field).not.toBeNull();
-    expect(field.tooltip).toBe("tooltip string");
-  });
+      const field = form.findById("char1") as Char;
+      expect(field).not.toBeNull();
+      expect(field.tooltip).toBe("tooltip string");
+      expect(field.tooltipInline).toBeFalsy();
+    });
+    it("should be inline if attribute help_inline is set", () => {
+      const fields = {
+        char1: {
+          size: 128,
+          string: "Name",
+          type: "char",
+          help: "tooltip string",
+        },
+      };
+      const xmlViewForm = `<?xml version="1.0"?>
+      <form string="Form1">
+          <group name="group">
+              <field colspan="1" name="char1" help_inline="1"/>
+          </group>
+      </form>`;
+      const form = new Form(fields);
+      form.parse(xmlViewForm);
 
+      const field = form.findById("char1") as Char;
+      expect(field).not.toBeNull();
+      expect(field.tooltip).toBe("tooltip string");
+      expect(field.tooltipInline).toBeTruthy();
+    });
+  });
   it("should properly parse a password field", () => {
     const arch =
       '<form><group><field name="password" password="True" readonly="0"/></group></form>';

package/src/spec/Widget.spec.ts

@@ -21,12 +21,6 @@ describe("A Widget", () => {
     expect(widget.colspan).toBe(3);
   });
 
-  it("should be readOnly false by default", () => {
-    const widget = new WidgetImpl();
-
-    expect(widget.readOnly).toBe(false);
-  });
-
   it("colspan should be of type Number", () => {
     const widget = new WidgetImpl();
 

package/src/spec/attributeParser.spec.ts

@@ -1,5 +1,5 @@
 import { it, expect, describe } from "vitest";
-import { evaluateAttributes } from "../helpers/attributeParser";
+import { evaluateAttributes, isTrue } from "../helpers/attributeParser";
 
 const fields = {
   force_potencia_adscrita: {
@@ -212,4 +212,39 @@ describe("An Attribute Parser", () => {
       expect(evaluatedAttrs.invisible).toBeTruthy();
     });
   });
+  describe("isTrue method", () => {
+    it("should return true when value is 'True'", () => {
+      expect(isTrue("True")).toBeTruthy();
+    });
+    it("should return true when value is 'true'", () => {
+      expect(isTrue("true")).toBeTruthy();
+    });
+    it("should return true when value is true", () => {
+      expect(isTrue(true)).toBeTruthy();
+    });
+    it("should return true when value is '1'", () => {
+      expect(isTrue("1")).toBeTruthy();
+    });
+    it("should return true when value is 1", () => {
+      expect(isTrue(1)).toBeTruthy();
+    });
+    it("should return false when value is 'False'", () => {
+      expect(isTrue("False")).toBeFalsy();
+    });
+    it("should return false when value is 'false'", () => {
+      expect(isTrue("false")).toBeFalsy();
+    });
+    it("should return false when value is false", () => {
+      expect(isTrue(false)).toBeFalsy();
+    });
+    it("should return false when value is '0'", () => {
+      expect(isTrue("0")).toBeFalsy();
+    });
+    it("should return false when value is 0", () => {
+      expect(isTrue(0)).toBeFalsy();
+    });
+    it("should return false when value is undefined", () => {
+      expect(isTrue(undefined)).toBeFalsy();
+    });
+  });
 });