@nebula.js/sn-action-button 1.14.1 → 1.15.3

package/README.md

@@ -32,11 +32,3 @@ nuked.render({
 ```
 
 [See full example](./example)
-
-## How to release
-
-1. Create a release branch version/1.x.x
-2. Run `npm version patch/minor`
-3. Run `git push && git push --tags`
-4. Merge the branch
-5. Run `npm publish`

package/api-specifications/properties.json

@@ -0,0 +1,664 @@
+{
+  "scriptappy": "1.0.0",
+  "info": {
+    "name": "@nebula.js/sn-action-button:properties",
+    "description": "Action button generic object definition",
+    "version": "1.15.3",
+    "license": "MIT",
+    "stability": "stable",
+    "x-qlik-visibility": "public"
+  },
+  "entries": {
+    "properties": {
+      "extends": [
+        {
+          "type": "qae.GenericObjectProperties"
+        }
+      ],
+      "kind": "object",
+      "entries": {
+        "actions": {
+          "description": "List of actions, performed in this order",
+          "kind": "array",
+          "items": {
+            "type": "#/definitions/Action"
+          }
+        },
+        "enabledCondition": {
+          "description": "Number or expression evaluating to number, 0 means disabling the button",
+          "defaultValue": 1,
+          "kind": "union",
+          "items": [
+            {
+              "type": "number"
+            },
+            {
+              "type": "#/definitions/EnabledExpression"
+            }
+          ],
+          "type": "any"
+        },
+        "footnote": {
+          "description": "Visualization footnote",
+          "optional": true,
+          "defaultValue": "",
+          "type": "string"
+        },
+        "navigation": {
+          "description": "Navigation action to move to new sheet/URL, performed after all other actions",
+          "type": "#/definitions/NavigationAction"
+        },
+        "showTitles": {
+          "description": "Show title for the visualization",
+          "optional": true,
+          "defaultValue": true,
+          "type": "boolean"
+        },
+        "style": {
+          "description": "All styling options",
+          "type": "#/definitions/Style"
+        },
+        "subtitle": {
+          "description": "Visualization subtitle",
+          "optional": true,
+          "defaultValue": "",
+          "type": "string"
+        },
+        "title": {
+          "description": "Visualization title",
+          "optional": true,
+          "defaultValue": "",
+          "type": "string"
+        },
+        "useEnabledCondition": {
+          "description": "Controlling if the button should use an expression to determine if it is enabled or not",
+          "defaultValue": false,
+          "type": "boolean"
+        },
+        "version": {
+          "description": "Current version of this generic object definition.",
+          "type": "string"
+        }
+      }
+    }
+  },
+  "definitions": {
+    "Action": {
+      "description": "Defines what action to perform and options for that action type.",
+      "kind": "object",
+      "entries": {
+        "actionLabel": {
+          "description": "Label for reference",
+          "optional": true,
+          "defaultValue": "''",
+          "type": "string"
+        },
+        "actionType": {
+          "description": "The type of action",
+          "optional": true,
+          "defaultValue": "''",
+          "kind": "union",
+          "items": [
+            {
+              "kind": "literal",
+              "value": "'applyBookmark'"
+            },
+            {
+              "kind": "literal",
+              "value": "'back'"
+            },
+            {
+              "kind": "literal",
+              "value": "'forward'"
+            },
+            {
+              "kind": "literal",
+              "value": "'clearAll'"
+            },
+            {
+              "kind": "literal",
+              "value": "'clearAllButThis'"
+            },
+            {
+              "kind": "literal",
+              "value": "'clearField'"
+            },
+            {
+              "kind": "literal",
+              "value": "'selectAll'"
+            },
+            {
+              "kind": "literal",
+              "value": "'selectValues'"
+            },
+            {
+              "kind": "literal",
+              "value": "'selectMatchingValues'"
+            },
+            {
+              "kind": "literal",
+              "value": "'selectAlternative'"
+            },
+            {
+              "kind": "literal",
+              "value": "'selectExcluded'"
+            },
+            {
+              "kind": "literal",
+              "value": "'selectPossible'"
+            },
+            {
+              "kind": "literal",
+              "value": "'toggleSelect'"
+            },
+            {
+              "kind": "literal",
+              "value": "'lockAll'"
+            },
+            {
+              "kind": "literal",
+              "value": "'lockField'"
+            },
+            {
+              "kind": "literal",
+              "value": "'unlockAll'"
+            },
+            {
+              "kind": "literal",
+              "value": "'unlockField'"
+            },
+            {
+              "kind": "literal",
+              "value": "'setVariable'"
+            },
+            {
+              "kind": "literal",
+              "value": "'doReload'"
+            },
+            {
+              "kind": "literal",
+              "value": "'executeAutomation'"
+            }
+          ],
+          "type": "string"
+        },
+        "bookmark": {
+          "description": "ID of bookmark, required for type 'applyBookmark'",
+          "optional": true,
+          "defaultValue": "''",
+          "type": "string"
+        },
+        "field": {
+          "description": "Name of field. Required for types 'clearAllButThis', 'clearField', 'selectAll', 'selectValues', 'selectMatchingValues', 'selectAlternative', 'selectExcluded', 'selectPossible', 'toggleSelect', 'lockField' and 'unlockField'",
+          "optional": true,
+          "defaultValue": "''",
+          "type": "string"
+        },
+        "softLock": {
+          "description": "Set to true to ignore locked field(s). Required for types 'clearAll', 'clearAllButThis', 'clearField', 'selectAll', 'selectValues', 'selectMatchingValues', 'selectAlternative', 'selectExcluded', 'selectPossible' and 'toggleSelect'",
+          "optional": true,
+          "defaultValue": "''",
+          "type": "string"
+        },
+        "value": {
+          "description": "To select certain values in a field or set a variable. Required for types 'selectValues', 'selectMatchingValues', 'toggleSelect' and 'setVariable'",
+          "optional": true,
+          "defaultValue": "''",
+          "type": "string"
+        },
+        "variable": {
+          "description": "Name of variable. Required for type 'setVariable'",
+          "optional": true,
+          "defaultValue": "''",
+          "type": "string"
+        },
+        "partial": {
+          "description": "Set to true if you want to do a partial reload.",
+          "optional": true,
+          "defaultValue": false,
+          "type": "boolean"
+        },
+        "automation": {
+          "description": "ID of the automation. Required for type 'setVariable'",
+          "optional": true,
+          "defaultValue": "''",
+          "type": "string"
+        },
+        "automationPostData": {
+          "description": "Set to true to include the current selections in the automation. Defaults to false",
+          "optional": true,
+          "defaultValue": false,
+          "type": "boolean"
+        }
+      }
+    },
+    "Background": {
+      "kind": "object",
+      "entries": {
+        "useColorExpression": {
+          "description": "Set to true to use color expression",
+          "optional": true,
+          "defaultValue": false,
+          "type": "boolean"
+        },
+        "color": {
+          "description": "Color defined by index or hex code, needed if useColorExpression is false",
+          "optional": true,
+          "type": "#/definitions/PaletteColor"
+        },
+        "colorExpression": {
+          "description": "Color defined by expression, needed if useColorExpression is true",
+          "optional": true,
+          "type": "#/definitions/ColorExpression"
+        },
+        "useImage": {
+          "description": "Set to true to show background image",
+          "optional": true,
+          "defaultValue": false,
+          "type": "boolean"
+        },
+        "url": {
+          "description": "Contains the URL for the background image",
+          "optional": true,
+          "kind": "object",
+          "entries": {
+            "qStaticContentUrlDef": {
+              "optional": true,
+              "kind": "object",
+              "entries": {
+                "qUrl": {
+                  "description": "URL represented as a string",
+                  "optional": true,
+                  "type": "string"
+                }
+              }
+            }
+          }
+        },
+        "position": {
+          "description": "Image position",
+          "optional": true,
+          "defaultValue": "'centerCenter'",
+          "kind": "union",
+          "items": [
+            {
+              "kind": "literal",
+              "value": "'topLeft'"
+            },
+            {
+              "kind": "literal",
+              "value": "'centerLeft'"
+            },
+            {
+              "kind": "literal",
+              "value": "'bottomLeft'"
+            },
+            {
+              "kind": "literal",
+              "value": "'topCenter'"
+            },
+            {
+              "kind": "literal",
+              "value": "'centerCenter'"
+            },
+            {
+              "kind": "literal",
+              "value": "'bottomCenter'"
+            },
+            {
+              "kind": "literal",
+              "value": "'topRight'"
+            },
+            {
+              "kind": "literal",
+              "value": "'centerRight'"
+            },
+            {
+              "kind": "literal",
+              "value": "'bottomRight'"
+            }
+          ],
+          "type": "string"
+        },
+        "size": {
+          "description": "Size of the image, relative to the button",
+          "optional": true,
+          "defaultValue": "'auto'",
+          "kind": "union",
+          "items": [
+            {
+              "kind": "literal",
+              "value": "'auto'"
+            },
+            {
+              "kind": "literal",
+              "value": "'alwaysFit'"
+            },
+            {
+              "kind": "literal",
+              "value": "'fitWidth'"
+            },
+            {
+              "kind": "literal",
+              "value": "'fitWidth'"
+            },
+            {
+              "kind": "literal",
+              "value": "'fitHeight'"
+            },
+            {
+              "kind": "literal",
+              "value": "'fill'"
+            },
+            {
+              "kind": "literal",
+              "value": "'alwaysFill'"
+            }
+          ],
+          "type": "string"
+        }
+      }
+    },
+    "Border": {
+      "kind": "object",
+      "entries": {
+        "useBorder": {
+          "description": "Set to true to use border expression",
+          "optional": true,
+          "defaultValue": false,
+          "type": "boolean"
+        },
+        "width": {
+          "description": "Relative width, 0 is no border and 1 make the border fill the entire button",
+          "optional": true,
+          "defaultValue": 0,
+          "type": "number"
+        },
+        "radius": {
+          "description": "Relative border radius, 0 is no rounding and 1 will make the short side a half circle",
+          "optional": true,
+          "defaultValue": 0,
+          "type": "number"
+        },
+        "useColorExpression": {
+          "description": "Set to true to use color expression",
+          "optional": true,
+          "defaultValue": false,
+          "type": "boolean"
+        },
+        "color": {
+          "description": "Color defined by index or hex code, needed if useColorExpression is false",
+          "optional": true,
+          "type": "#/definitions/PaletteColor"
+        },
+        "colorExpression": {
+          "description": "Color defined by expression, needed if useColorExpression is true",
+          "optional": true,
+          "type": "string"
+        }
+      }
+    },
+    "ColorExpression": {
+      "description": "Format for using color expressions",
+      "kind": "object",
+      "entries": {
+        "qStringExpression": {
+          "kind": "object",
+          "entries": {
+            "qExpr": {
+              "description": "expression that resolves to a supported color format",
+              "type": "string"
+            }
+          }
+        }
+      }
+    },
+    "EnabledExpression": {
+      "description": "Format for setting if the button is enabled/disabled with an expression",
+      "kind": "object",
+      "entries": {
+        "qStringExpression": {
+          "kind": "object",
+          "entries": {
+            "qExpr": {
+              "description": "expression that resolves to a number",
+              "type": "string"
+            }
+          }
+        }
+      }
+    },
+    "Font": {
+      "kind": "object",
+      "entries": {
+        "useColorExpression": {
+          "description": "Set to true to use color expression",
+          "optional": true,
+          "defaultValue": false,
+          "type": "boolean"
+        },
+        "color": {
+          "description": "Color defined by index or hex code, needed if useColorExpression is false",
+          "optional": true,
+          "type": "#/definitions/PaletteColor"
+        },
+        "colorExpression": {
+          "description": "Color defined by expression, needed if useColorExpression is true",
+          "optional": true,
+          "type": "#/definitions/ColorExpression"
+        },
+        "size": {
+          "description": "Relative[] size of label, must be greater than 0 and 1 fills the entire button",
+          "optional": true,
+          "defaultValue": 0.5,
+          "type": "number"
+        },
+        "align": {
+          "description": "Horizontal alignment",
+          "optional": true,
+          "defaultValue": "'center'",
+          "kind": "union",
+          "items": [
+            {
+              "kind": "literal",
+              "value": "'left'"
+            },
+            {
+              "kind": "literal",
+              "value": "'center'"
+            },
+            {
+              "kind": "literal",
+              "value": "'right'"
+            }
+          ],
+          "type": "string"
+        },
+        "style": {
+          "description": "Additional style options",
+          "optional": true,
+          "kind": "object",
+          "entries": {
+            "bold": {
+              "description": "Bold text",
+              "optional": true,
+              "defaultValue": true,
+              "type": "boolean"
+            },
+            "italic": {
+              "description": "Italic text",
+              "optional": true,
+              "defaultValue": false,
+              "type": "boolean"
+            },
+            "underline": {
+              "description": "Underlined text",
+              "optional": true,
+              "defaultValue": false,
+              "type": "boolean"
+            }
+          }
+        }
+      }
+    },
+    "Icon": {
+      "description": "Icons are only available inside Qlik Sense",
+      "kind": "object",
+      "entries": {
+        "useIcon": {
+          "description": "Set to true to show icon, default is false",
+          "optional": true,
+          "defaultValue": false,
+          "type": "boolean"
+        },
+        "iconType": {
+          "description": "holds the name of the icon",
+          "optional": true,
+          "kind": "object",
+          "entries": {
+            "value": {
+              "description": "name of icon",
+              "optional": true,
+              "defaultValue": "''",
+              "type": "string"
+            }
+          }
+        },
+        "position": {
+          "description": "Defines which side of the label the icon will be",
+          "optional": true,
+          "defaultValue": "'left'",
+          "kind": "union",
+          "items": [
+            {
+              "kind": "literal",
+              "value": "'left'"
+            },
+            {
+              "kind": "literal",
+              "value": "'right'"
+            }
+          ],
+          "type": "string"
+        }
+      }
+    },
+    "NavigationAction": {
+      "description": "Defines a navigation action to perform after the other actions. Note that when the sn-action-button is used outside Qlik Sense you can only use the 'openWebsite' action.",
+      "kind": "object",
+      "entries": {
+        "action": {
+          "description": "Name of navigation action",
+          "kind": "union",
+          "items": [
+            {
+              "kind": "literal",
+              "value": "'nextSheet'"
+            },
+            {
+              "kind": "literal",
+              "value": "'prevSheet'"
+            },
+            {
+              "kind": "literal",
+              "value": "'firstSheet'"
+            },
+            {
+              "kind": "literal",
+              "value": "'lastSheet'"
+            },
+            {
+              "kind": "literal",
+              "value": "'goToSheet'"
+            },
+            {
+              "kind": "literal",
+              "value": "'goToSheetById'"
+            },
+            {
+              "kind": "literal",
+              "value": "'goToSheetById'"
+            },
+            {
+              "kind": "literal",
+              "value": "'goToStory'"
+            },
+            {
+              "kind": "literal",
+              "value": "'openWebsite'"
+            }
+          ],
+          "type": "string"
+        },
+        "sheet": {
+          "description": "sheet ID. Required for 'goToSheet' and 'goToSheetById'",
+          "optional": true,
+          "type": "string"
+        },
+        "story": {
+          "description": "Story ID. Required for 'goToStory'",
+          "optional": true,
+          "type": "string"
+        },
+        "websiteUrl": {
+          "description": "URL for website. required for 'openWebsite'",
+          "optional": true,
+          "type": "string"
+        },
+        "sameWindow": {
+          "description": "Set to true to open in same window/tab. Required for 'openWebsite'",
+          "optional": true,
+          "type": "boolean"
+        }
+      }
+    },
+    "PaletteColor": {
+      "description": "Color information structure. Holds the actual color and index in palette.",
+      "kind": "object",
+      "entries": {
+        "color": {
+          "description": "Color as hex string (only used if index: -1)",
+          "optional": true,
+          "type": "string"
+        },
+        "index": {
+          "description": "Index in palette",
+          "optional": true,
+          "type": "number"
+        }
+      }
+    },
+    "Style": {
+      "description": "Holds styling options",
+      "kind": "object",
+      "entries": {
+        "label": {
+          "description": "The text displayed on the button",
+          "optional": true,
+          "defaultValue": "'Button'",
+          "type": "string"
+        },
+        "font": {
+          "description": "Styling for the label",
+          "optional": true,
+          "type": "#/definitions/Font"
+        },
+        "background": {
+          "description": "Styling for background, including image",
+          "optional": true,
+          "type": "#/definitions/Background"
+        },
+        "border": {
+          "description": "Styling for border",
+          "optional": true,
+          "type": "#/definitions/Border"
+        },
+        "icon": {
+          "description": "Styling for icon",
+          "optional": true,
+          "type": "#/definitions/Icon"
+        }
+      }
+    }
+  }
+}