Synchronet v3.19b-Win32 (install) has been released (Jan-2022).

You can donate to the Synchronet project using PayPal.

Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Both sides previous revisionPrevious revision
Next revisionBoth sides next revision
custom:javascript:lib:ddlightbarmenu.js [2023/04/06 13:02] – Mentioned the fact that DDLightbarMenu can now work in non-lightbar mode if the user's terminal doesn't support ANSI (and has a property, allowANSI, that can be set false if you want to force it to do so). Added a link to DDMsgReader.js at the bottom for Nightfoxcustom:javascript:lib:ddlightbarmenu.js [2023/06/30 09:36] – Additional notes about SetBorderChars(); changed the control char in the attributes from \1 to \x01 Nightfox
Line 78: Line 78:
 | selectedItemColor          | The color to use for selected items (current default is blue on white).  This can be either a string (with Synchronet color/attribute codes for the item text) or an array with objects specifying color/attribute codes for different parts of an item's text string displayed on the menu.  See the "Item color arrays" section below for more information. | | selectedItemColor          | The color to use for selected items (current default is blue on white).  This can be either a string (with Synchronet color/attribute codes for the item text) or an array with objects specifying color/attribute codes for different parts of an item's text string displayed on the menu.  See the "Item color arrays" section below for more information. |
 | unselectableItemColor      | The color to use for unselectable items (current default is bright blue). This can be either a string (with Synchronet color/attribute codes for the item text) or an array with objects specifying color/attribute codes for different parts of an item's text string displayed on the menu. If this is an empty string, then color codes can be embedded in the item text to color the (unselectable) item. | | unselectableItemColor      | The color to use for unselectable items (current default is bright blue). This can be either a string (with Synchronet color/attribute codes for the item text) or an array with objects specifying color/attribute codes for different parts of an item's text string displayed on the menu. If this is an empty string, then color codes can be embedded in the item text to color the (unselectable) item. |
-| itemTextCharHighlightColor | The color of a highlighted non-space character in an item text (specified by having a & in the item text).  It's important not to specify a "\1n" in here in case the item text should have a background color. |+| itemTextCharHighlightColor | The color of a highlighted non-space character in an item text (specified by having a & in the item text).  It's important not to specify a "\x01n" in here in case the item text should have a background color. |
 | borderColor                | The color for the borders (if borders are enabled) | | borderColor                | The color for the borders (if borders are enabled) |
 | scrollbarScrollBlockColor  | The color for the scrollbar blocks | | scrollbarScrollBlockColor  | The color for the scrollbar blocks |
Line 113: Line 113:
   var val = lbMenu.GetVal();   var val = lbMenu.GetVal();
   // Output the chosen menu item   // Output the chosen menu item
-  console.print("\1n\r\n");+  console.print("\x01n\r\n");
   console.print("Value:" + val + ":, type: " + typeof(val) + "\r\n");   console.print("Value:" + val + ":, type: " + typeof(val) + "\r\n");
   console.pause();   console.pause();
      
   // Changing the normal item color to green & selected item color to bright green:   // Changing the normal item color to green & selected item color to bright green:
-  lbMenu.colors.itemColor = "\1n\1g"; +  lbMenu.colors.itemColor = "\x01n\x01g"; 
-  lbMenu.colors.selectedItemColor = "\1n\1h\1g";+  lbMenu.colors.selectedItemColor = "\x01n\x01h\x01g";
      
   // Disabling the navigation wrap behavior:   // Disabling the navigation wrap behavior:
Line 156: Line 156:
   lbMenu.borderChars.upperLeft = "\xDA"; // Single-line upper-left character   lbMenu.borderChars.upperLeft = "\xDA"; // Single-line upper-left character
 To set/change any of the border characters, you can also call the SetBorderChars() function and pass an object containing any or all of the above properties to set the border characters in the object.  For example (assuming lbMenu is the menu object): To set/change any of the border characters, you can also call the SetBorderChars() function and pass an object containing any or all of the above properties to set the border characters in the object.  For example (assuming lbMenu is the menu object):
 +  lbMenu.SetBorderChars({
 +    left: "|",
 +    right: "|",
 +    top: "-",
 +    bottom: "-",
 +    upperLeft: "/",
 +    upperRight: "\",
 +    lowerLeft: "\",
 +    lowerRight: "/"
 +  });
 +
 +Not all border characters need to be specified.  For instance, perhaps you've set some border characters already and only want to change some of them:
   lbMenu.SetBorderChars({   lbMenu.SetBorderChars({
     left: "|",     left: "|",
Line 166: Line 178:
 To change the colors, you can directly change the properties of the color object within the DDLightbarMenu, or you can call the SetColors() function to set any or all of the color properties in the colors object in the DDLightbarMenu object.  For example (assuming lbMenu is the menu object): To change the colors, you can directly change the properties of the color object within the DDLightbarMenu, or you can call the SetColors() function to set any or all of the color properties in the colors object in the DDLightbarMenu object.  For example (assuming lbMenu is the menu object):
   lbMenu.SetColors({   lbMenu.SetColors({
-    itemColor: "\1b", +    itemColor: "\x01b", 
-    selectedItemColor: "\1r\1" + "7" // Red with a grey background - This uses 2 strings concatenated because "\17" would be interpreted incorrectly.+    selectedItemColor: "\x01r\x01" + "7" // Red with a grey background - This uses 2 strings concatenated because "\x017" would be interpreted incorrectly.
   });   });
  
Line 178: Line 190:
 For the last item, the 'end' property can be -1, 0, or greater than the length of the item to apply the color/attribute codes to the rest of the string.\\ For the last item, the 'end' property can be -1, 0, or greater than the length of the item to apply the color/attribute codes to the rest of the string.\\
 For example, for a menu with items that are simply titled "Item 1" and so on, this specifies indexes to color the item text with "Item" and the number colored separately:\\ For example, for a menu with items that are simply titled "Item 1" and so on, this specifies indexes to color the item text with "Item" and the number colored separately:\\
-  lbMenu.colors.itemColor = [{start: 0, end: 5, attrs: "\1h\1g\1" + "4"}, {start: 5, end: 0, attrs: "\1h\1y\1" + "4"}]; +  lbMenu.colors.itemColor = [{start: 0, end: 5, attrs: "\x01h\x01g\x01" + "4"}, {start: 5, end: 0, attrs: "\x01h\x01y\x01" + "4"}]; 
-  lbMenu.colors.selectedItemColor = [{start: 0, end: 5, attrs: "\1r\1" + "7"}, {start: 5, end: 0, attrs: "\1b\1" + "7"}];+  lbMenu.colors.selectedItemColor = [{start: 0, end: 5, attrs: "\x01r\x01" + "7"}, {start: 5, end: 0, attrs: "\x01b\x01" + "7"}];
  
 ====== Replacing the NumItems() and GetItem() functions ====== ====== Replacing the NumItems() and GetItem() functions ======
Line 208: Line 220:
     // You might also opt to give this item specific colors for normal and highlighted     // You might also opt to give this item specific colors for normal and highlighted
     // if you want to make this item appear different for whatever reason.     // if you want to make this item appear different for whatever reason.
-    //menuItemObj.itemColor = "\1r"; // Red +    //menuItemObj.itemColor = "\x01r"; // Red 
-    //menuItemObj.itemSelectedColor = "\1r\1" + "7"; // Red with grey background+    //menuItemObj.itemSelectedColor = "\x01r\x01" + "7"; // Red with grey background
     return menuItemObj; // The DDLightbarMenu object will use this when displaying the menu     return menuItemObj; // The DDLightbarMenu object will use this when displaying the menu
   };   };
Line 223: Line 235:
     else     else
     {     {
-      console.print("* Can't choose " + pItemRetval + " because blah blah blah!\r\n\1p");+      console.print("* Can't choose " + pItemRetval + " because blah blah blah!\r\n\x01p");
       return false;       return false;
     }     }

Trace: