@ni/ok-components 1.3.6 → 1.4.0

package/dist/custom-elements.json

@@ -10,7 +10,7 @@
     },
     {
       "kind": "javascript-module",
-      "path": "src/ex/all-ex.ts",
+      "path": "src/ts/all-ts.ts",
       "declarations": [],
       "exports": []
     },
@@ -22,47 +22,74 @@
     },
     {
       "kind": "javascript-module",
-      "path": "src/ts/all-ts.ts",
+      "path": "src/ex/all-ex.ts",
       "declarations": [],
       "exports": []
     },
     {
       "kind": "javascript-module",
-      "path": "src/ex/button/index.ts",
+      "path": "src/ts/icon-dynamic/index.ts",
       "declarations": [
         {
           "kind": "class",
-          "description": "A Ok demo component (not for production use)",
-          "name": "ExButton",
+          "description": "Base class for dynamic icons. Not intended to be used directly, instead use to register dynamic icons:\n```\ncustomElements.get('ok-ts-icon-dynamic').registerIconDynamic('ok-ts-icon-dynamic-awesome', '<img data uri or arbitrary url>');\n```\nAfter calling successfully, the icon can be used like any other icon:\n```\n<ok-ts-icon-dynamic-awesome></ok-ts-icon-dynamic-awesome>\n<nimble-mapping-icon icon=\"ok-ts-icon-dynamic-awesome\"></nimble-mapping-icon>\n```",
+          "name": "TsIconDynamic",
+          "members": [
+            {
+              "kind": "method",
+              "name": "registerIconDynamic",
+              "privacy": "public",
+              "static": true,
+              "return": {
+                "type": {
+                  "text": "void"
+                }
+              },
+              "parameters": [
+                {
+                  "name": "tagName",
+                  "type": {
+                    "text": "string"
+                  }
+                },
+                {
+                  "name": "url",
+                  "type": {
+                    "text": "string"
+                  }
+                }
+              ]
+            }
+          ],
           "superclass": {
-            "name": "FoundationElement",
-            "package": "@ni/fast-foundation"
+            "name": "Icon",
+            "package": "@ni/nimble-components/dist/esm/icon-base"
           }
         },
         {
           "kind": "variable",
-          "name": "exButtonTag",
+          "name": "tsIconDynamicTag",
           "type": {
             "text": "string"
           },
-          "default": "'ok-ex-button'"
+          "default": "'ok-ts-icon-dynamic'"
         }
       ],
       "exports": [
         {
           "kind": "js",
-          "name": "ExButton",
+          "name": "TsIconDynamic",
           "declaration": {
-            "name": "ExButton",
-            "module": "src/ex/button/index.ts"
+            "name": "TsIconDynamic",
+            "module": "src/ts/icon-dynamic/index.ts"
           }
         },
         {
           "kind": "js",
-          "name": "exButtonTag",
+          "name": "tsIconDynamicTag",
           "declaration": {
-            "name": "exButtonTag",
-            "module": "src/ex/button/index.ts"
+            "name": "tsIconDynamicTag",
+            "module": "src/ts/icon-dynamic/index.ts"
           }
         }
       ]
@@ -1678,18 +1705,82 @@
     },
     {
       "kind": "javascript-module",
-      "path": "src/ts/icon-dynamic/index.ts",
+      "path": "src/ex/button/index.ts",
       "declarations": [
         {
           "kind": "class",
-          "description": "Base class for dynamic icons. Not intended to be used directly, instead use to register dynamic icons:\n```\ncustomElements.get('ok-ts-icon-dynamic').registerIconDynamic('ok-ts-icon-dynamic-awesome', '<img data uri or arbitrary url>');\n```\nAfter calling successfully, the icon can be used like any other icon:\n```\n<ok-ts-icon-dynamic-awesome></ok-ts-icon-dynamic-awesome>\n<nimble-mapping-icon icon=\"ok-ts-icon-dynamic-awesome\"></nimble-mapping-icon>\n```",
-          "name": "TsIconDynamic",
+          "description": "A Ok demo component (not for production use)",
+          "name": "ExButton",
+          "superclass": {
+            "name": "FoundationElement",
+            "package": "@ni/fast-foundation"
+          }
+        },
+        {
+          "kind": "variable",
+          "name": "exButtonTag",
+          "type": {
+            "text": "string"
+          },
+          "default": "'ok-ex-button'"
+        }
+      ],
+      "exports": [
+        {
+          "kind": "js",
+          "name": "ExButton",
+          "declaration": {
+            "name": "ExButton",
+            "module": "src/ex/button/index.ts"
+          }
+        },
+        {
+          "kind": "js",
+          "name": "exButtonTag",
+          "declaration": {
+            "name": "exButtonTag",
+            "module": "src/ex/button/index.ts"
+          }
+        }
+      ]
+    },
+    {
+      "kind": "javascript-module",
+      "path": "src/ts/table-column/breakpoint/index.ts",
+      "declarations": [
+        {
+          "kind": "class",
+          "description": "A table column that displays a breakpoint indicator with toggle functionality.",
+          "name": "TsTableColumnBreakpoint",
           "members": [
+            {
+              "kind": "field",
+              "name": "fieldName",
+              "type": {
+                "text": "string | undefined"
+              },
+              "privacy": "public"
+            },
+            {
+              "kind": "field",
+              "name": "menuSlot",
+              "type": {
+                "text": "string | undefined"
+              },
+              "privacy": "public"
+            },
+            {
+              "kind": "field",
+              "name": "position",
+              "type": {
+                "text": "BreakpointMenuPosition"
+              },
+              "privacy": "public"
+            },
             {
               "kind": "method",
-              "name": "registerIconDynamic",
+              "name": "requestBreakpointStateChange",
               "privacy": "public",
-              "static": true,
               "return": {
                 "type": {
                   "text": "void"
@@ -1697,49 +1788,494 @@
               },
               "parameters": [
                 {
-                  "name": "tagName",
+                  "name": "recordId",
                   "type": {
                     "text": "string"
                   }
                 },
                 {
-                  "name": "url",
+                  "name": "currentState",
                   "type": {
-                    "text": "string"
+                    "text": "BreakpointState"
+                  }
+                },
+                {
+                  "name": "requestedState",
+                  "type": {
+                    "text": "BreakpointState"
+                  }
+                }
+              ],
+              "description": "Programmatically requests a breakpoint state change for a record."
+            },
+            {
+              "kind": "method",
+              "name": "getColumnInternalsOptions",
+              "privacy": "protected",
+              "return": {
+                "type": {
+                  "text": "ColumnInternalsOptions"
+                }
+              }
+            },
+            {
+              "kind": "method",
+              "name": "fieldNameChanged",
+              "privacy": "protected",
+              "return": {
+                "type": {
+                  "text": "void"
+                }
+              }
+            },
+            {
+              "kind": "method",
+              "name": "menuSlotChanged",
+              "privacy": "protected",
+              "return": {
+                "type": {
+                  "text": "void"
+                }
+              }
+            },
+            {
+              "kind": "method",
+              "name": "positionChanged",
+              "privacy": "protected",
+              "return": {
+                "type": {
+                  "text": "void"
+                }
+              }
+            },
+            {
+              "kind": "method",
+              "name": "updateColumnConfig",
+              "privacy": "private",
+              "return": {
+                "type": {
+                  "text": "void"
+                }
+              }
+            },
+            {
+              "kind": "field",
+              "name": "resizingDisabled",
+              "type": {
+                "text": "boolean"
+              },
+              "default": "true"
+            },
+            {
+              "kind": "field",
+              "name": "pixelWidth",
+              "default": "singleIconColumnWidth"
+            },
+            {
+              "kind": "field",
+              "name": "minPixelWidth",
+              "default": "singleIconColumnWidth"
+            }
+          ],
+          "attributes": [
+            {
+              "name": "field-name",
+              "type": {
+                "text": "string | undefined"
+              },
+              "fieldName": "fieldName"
+            },
+            {
+              "name": "menu-slot",
+              "type": {
+                "text": "string | undefined"
+              },
+              "fieldName": "menuSlot"
+            },
+            {
+              "name": "position",
+              "type": {
+                "text": "BreakpointMenuPosition"
+              },
+              "fieldName": "position"
+            }
+          ],
+          "superclass": {
+            "name": "TableColumn",
+            "package": "@ni/nimble-components/dist/esm/table-column/base"
+          }
+        },
+        {
+          "kind": "variable",
+          "name": "tsTableColumnBreakpointTag",
+          "type": {
+            "text": "string"
+          },
+          "default": "'ok-ts-table-column-breakpoint'"
+        }
+      ],
+      "exports": [
+        {
+          "kind": "js",
+          "name": "TsTableColumnBreakpoint",
+          "declaration": {
+            "name": "TsTableColumnBreakpoint",
+            "module": "src/ts/table-column/breakpoint/index.ts"
+          }
+        },
+        {
+          "kind": "js",
+          "name": "tsTableColumnBreakpointTag",
+          "declaration": {
+            "name": "tsTableColumnBreakpointTag",
+            "module": "src/ts/table-column/breakpoint/index.ts"
+          }
+        }
+      ]
+    },
+    {
+      "kind": "javascript-module",
+      "path": "src/ts/table-column/breakpoint/types.ts",
+      "declarations": [
+        {
+          "kind": "variable",
+          "name": "BreakpointState",
+          "type": {
+            "text": "{\n    off: 'off',\n    enabled: 'enabled',\n    disabled: 'disabled',\n    hit: 'hit',\n    conditional: 'conditional',\n    hitDisabled: 'hit-disabled'\n}"
+          },
+          "default": "{ off: 'off', enabled: 'enabled', disabled: 'disabled', hit: 'hit', conditional: 'conditional', hitDisabled: 'hit-disabled' }",
+          "description": "The possible states of a breakpoint indicator."
+        }
+      ],
+      "exports": [
+        {
+          "kind": "js",
+          "name": "BreakpointState",
+          "declaration": {
+            "name": "BreakpointState",
+            "module": "src/ts/table-column/breakpoint/types.ts"
+          }
+        }
+      ]
+    },
+    {
+      "kind": "javascript-module",
+      "path": "src/ts/table-column/breakpoint/cell-view/index.ts",
+      "declarations": [
+        {
+          "kind": "class",
+          "description": "Cell view for the breakpoint column that renders a clickable breakpoint indicator.",
+          "name": "TsTableColumnBreakpointCellView",
+          "members": [
+            {
+              "kind": "field",
+              "name": "menuKeyAlias",
+              "type": {
+                "text": "string"
+              },
+              "privacy": "private",
+              "static": true,
+              "readonly": true,
+              "default": "'Menu'"
+            },
+            {
+              "kind": "field",
+              "name": "contextMenuKeyAlias",
+              "type": {
+                "text": "string"
+              },
+              "privacy": "private",
+              "static": true,
+              "readonly": true,
+              "default": "'ContextMenu'"
+            },
+            {
+              "kind": "field",
+              "name": "open",
+              "type": {
+                "text": "boolean"
+              },
+              "privacy": "public",
+              "default": "false",
+              "description": "Specifies whether or not the menu is open."
+            },
+            {
+              "kind": "field",
+              "name": "focusLastItemWhenOpened",
+              "type": {
+                "text": "boolean"
+              },
+              "privacy": "private",
+              "default": "false"
+            },
+            {
+              "kind": "field",
+              "name": "tabbableChildren",
+              "type": {
+                "text": "HTMLElement[]"
+              },
+              "privacy": "public",
+              "readonly": true
+            },
+            {
+              "kind": "method",
+              "name": "regionLoadedHandler",
+              "privacy": "public",
+              "return": {
+                "type": {
+                  "text": "void"
+                }
+              }
+            },
+            {
+              "kind": "method",
+              "name": "regionChanged",
+              "privacy": "public",
+              "return": {
+                "type": {
+                  "text": "void"
+                }
+              },
+              "parameters": [
+                {
+                  "name": "prev",
+                  "type": {
+                    "text": "AnchoredRegion | undefined"
+                  }
+                },
+                {
+                  "name": "_next",
+                  "type": {
+                    "text": "AnchoredRegion | undefined"
+                  }
+                }
+              ]
+            },
+            {
+              "kind": "method",
+              "name": "buttonChanged",
+              "privacy": "public",
+              "return": {
+                "type": {
+                  "text": "void"
+                }
+              }
+            },
+            {
+              "kind": "method",
+              "name": "focusoutHandler",
+              "privacy": "public",
+              "return": {
+                "type": {
+                  "text": "boolean"
+                }
+              },
+              "parameters": [
+                {
+                  "name": "e",
+                  "type": {
+                    "text": "FocusEvent"
+                  }
+                }
+              ]
+            },
+            {
+              "kind": "method",
+              "name": "contextMenuKeyDownHandler",
+              "privacy": "public",
+              "return": {
+                "type": {
+                  "text": "boolean"
+                }
+              },
+              "parameters": [
+                {
+                  "name": "e",
+                  "type": {
+                    "text": "KeyboardEvent"
+                  }
+                }
+              ]
+            },
+            {
+              "kind": "method",
+              "name": "onContextMenuChange",
+              "privacy": "public",
+              "return": {
+                "type": {
+                  "text": "void"
+                }
+              },
+              "parameters": [
+                {
+                  "name": "event",
+                  "type": {
+                    "text": "Event"
                   }
                 }
               ]
+            },
+            {
+              "kind": "method",
+              "name": "getMenu",
+              "privacy": "private",
+              "return": {
+                "type": {
+                  "text": "HTMLElement | undefined"
+                }
+              }
+            },
+            {
+              "kind": "method",
+              "name": "isSlotElement",
+              "privacy": "private",
+              "return": {
+                "type": {
+                  "text": "element is HTMLSlotElement"
+                }
+              },
+              "parameters": [
+                {
+                  "name": "element",
+                  "type": {
+                    "text": "HTMLElement | undefined"
+                  }
+                }
+              ]
+            },
+            {
+              "kind": "method",
+              "name": "focusMenu",
+              "privacy": "private",
+              "return": {
+                "type": {
+                  "text": "void"
+                }
+              }
+            },
+            {
+              "kind": "method",
+              "name": "focusLastMenuItem",
+              "privacy": "private",
+              "return": {
+                "type": {
+                  "text": "void"
+                }
+              }
+            },
+            {
+              "kind": "method",
+              "name": "emitToggle",
+              "privacy": "private",
+              "return": {
+                "type": {
+                  "text": "void"
+                }
+              },
+              "parameters": [
+                {
+                  "name": "oldState",
+                  "type": {
+                    "text": "BreakpointState"
+                  }
+                },
+                {
+                  "name": "newState",
+                  "type": {
+                    "text": "BreakpointState"
+                  }
+                }
+              ]
+            },
+            {
+              "kind": "method",
+              "name": "requestContextMenu",
+              "privacy": "private",
+              "return": {
+                "type": {
+                  "text": "void"
+                }
+              }
+            },
+            {
+              "kind": "method",
+              "name": "openMenuFromColumnSlot",
+              "privacy": "private",
+              "return": {
+                "type": {
+                  "text": "void"
+                }
+              }
+            },
+            {
+              "kind": "field",
+              "name": "menuChangeHandler",
+              "privacy": "private",
+              "readonly": true
+            },
+            {
+              "kind": "method",
+              "name": "getRequestedStateFromEvent",
+              "privacy": "private",
+              "return": {
+                "type": {
+                  "text": "BreakpointState | undefined"
+                }
+              },
+              "parameters": [
+                {
+                  "name": "event",
+                  "type": {
+                    "text": "Event"
+                  }
+                }
+              ]
+            }
+          ],
+          "attributes": [
+            {
+              "name": "open",
+              "type": {
+                "text": "boolean"
+              },
+              "default": "false",
+              "description": "Specifies whether or not the menu is open.",
+              "fieldName": "open"
             }
           ],
           "superclass": {
-            "name": "Icon",
-            "package": "@ni/nimble-components/dist/esm/icon-base"
+            "name": "TableCellView",
+            "package": "@ni/nimble-components/dist/esm/table-column/base/cell-view"
           }
         },
         {
           "kind": "variable",
-          "name": "tsIconDynamicTag",
+          "name": "requestedState"
+        },
+        {
+          "kind": "variable",
+          "name": "tsTableColumnBreakpointCellViewTag",
           "type": {
             "text": "string"
           },
-          "default": "'ok-ts-icon-dynamic'"
+          "default": "'ok-ts-table-column-breakpoint-cell-view'"
         }
       ],
       "exports": [
         {
           "kind": "js",
-          "name": "TsIconDynamic",
+          "name": "TsTableColumnBreakpointCellView",
           "declaration": {
-            "name": "TsIconDynamic",
-            "module": "src/ts/icon-dynamic/index.ts"
+            "name": "TsTableColumnBreakpointCellView",
+            "module": "src/ts/table-column/breakpoint/cell-view/index.ts"
           }
         },
         {
           "kind": "js",
-          "name": "tsIconDynamicTag",
+          "name": "tsTableColumnBreakpointCellViewTag",
           "declaration": {
-            "name": "tsIconDynamicTag",
-            "module": "src/ts/icon-dynamic/index.ts"
+            "name": "tsTableColumnBreakpointCellViewTag",
+            "module": "src/ts/table-column/breakpoint/cell-view/index.ts"
           }
         }
       ]