@ni/ok-components 1.3.7 → 1.4.1

package/dist/custom-elements.json

@@ -683,223 +683,6 @@
         }
       ]
     },
-    {
-      "kind": "javascript-module",
-      "path": "src/fv/context-help/index.ts",
-      "declarations": [
-        {
-          "kind": "class",
-          "description": "An info trigger with an attached tooltip for lightweight contextual guidance.",
-          "name": "FvContextHelp",
-          "members": [
-            {
-              "kind": "field",
-              "name": "text",
-              "type": {
-                "text": "string"
-              },
-              "privacy": "public",
-              "default": "''"
-            },
-            {
-              "kind": "field",
-              "name": "triggerLabel",
-              "type": {
-                "text": "string"
-              },
-              "privacy": "public",
-              "default": "'Show help'"
-            },
-            {
-              "kind": "field",
-              "name": "severity",
-              "type": {
-                "text": "FvContextHelpSeverity"
-              },
-              "privacy": "public"
-            },
-            {
-              "kind": "field",
-              "name": "iconVisible",
-              "type": {
-                "text": "boolean"
-              },
-              "privacy": "public",
-              "default": "false"
-            }
-          ],
-          "attributes": [
-            {
-              "name": "text",
-              "type": {
-                "text": "string"
-              },
-              "default": "''",
-              "fieldName": "text"
-            },
-            {
-              "name": "trigger-label",
-              "type": {
-                "text": "string"
-              },
-              "default": "'Show help'",
-              "fieldName": "triggerLabel"
-            },
-            {
-              "name": "severity",
-              "type": {
-                "text": "FvContextHelpSeverity"
-              },
-              "fieldName": "severity"
-            },
-            {
-              "name": "icon-visible",
-              "type": {
-                "text": "boolean"
-              },
-              "default": "false",
-              "fieldName": "iconVisible"
-            }
-          ],
-          "superclass": {
-            "name": "FoundationElement",
-            "package": "@ni/fast-foundation"
-          }
-        },
-        {
-          "kind": "variable",
-          "name": "fvContextHelpTag",
-          "type": {
-            "text": "string"
-          },
-          "default": "'ok-fv-context-help'"
-        }
-      ],
-      "exports": [
-        {
-          "kind": "js",
-          "name": "FvContextHelpSeverity",
-          "declaration": {
-            "name": "FvContextHelpSeverity",
-            "module": "src/fv/context-help/index.ts"
-          }
-        },
-        {
-          "kind": "js",
-          "name": "FvContextHelp",
-          "declaration": {
-            "name": "FvContextHelp",
-            "module": "src/fv/context-help/index.ts"
-          }
-        },
-        {
-          "kind": "js",
-          "name": "fvContextHelpTag",
-          "declaration": {
-            "name": "fvContextHelpTag",
-            "module": "src/fv/context-help/index.ts"
-          }
-        }
-      ]
-    },
-    {
-      "kind": "javascript-module",
-      "path": "src/fv/context-help/types.ts",
-      "declarations": [],
-      "exports": []
-    },
-    {
-      "kind": "javascript-module",
-      "path": "src/fv/search-input/index.ts",
-      "declarations": [
-        {
-          "kind": "class",
-          "description": "A compact search input with a built-in clear affordance.",
-          "name": "FvSearchInput",
-          "members": [
-            {
-              "kind": "field",
-              "name": "appearance",
-              "type": {
-                "text": "FvSearchInputAppearanceType"
-              },
-              "privacy": "public"
-            }
-          ],
-          "events": [
-            {
-              "name": "input",
-              "type": {
-                "text": "Event"
-              }
-            }
-          ],
-          "attributes": [
-            {
-              "name": "appearance",
-              "type": {
-                "text": "FvSearchInputAppearanceType"
-              },
-              "fieldName": "appearance"
-            }
-          ],
-          "superclass": {
-            "name": "FoundationTextField",
-            "package": "@ni/fast-foundation"
-          }
-        },
-        {
-          "kind": "variable",
-          "name": "fvSearchInputTag",
-          "type": {
-            "text": "string"
-          },
-          "default": "'ok-fv-search-input'"
-        }
-      ],
-      "exports": [
-        {
-          "kind": "js",
-          "name": "FvSearchInput",
-          "declaration": {
-            "name": "FvSearchInput",
-            "module": "src/fv/search-input/index.ts"
-          }
-        },
-        {
-          "kind": "js",
-          "name": "fvSearchInputTag",
-          "declaration": {
-            "name": "fvSearchInputTag",
-            "module": "src/fv/search-input/index.ts"
-          }
-        }
-      ]
-    },
-    {
-      "kind": "javascript-module",
-      "path": "src/fv/search-input/types.ts",
-      "declarations": [
-        {
-          "kind": "variable",
-          "name": "FvSearchInputAppearance",
-          "type": {
-            "text": "{\n    block: 'block',\n    outline: 'outline',\n    underline: 'underline',\n    frameless: 'frameless'\n}"
-          },
-          "default": "{ block: 'block', outline: 'outline', underline: 'underline', frameless: 'frameless' }"
-        }
-      ],
-      "exports": [
-        {
-          "kind": "js",
-          "name": "FvSearchInputAppearance",
-          "declaration": {
-            "name": "FvSearchInputAppearance",
-            "module": "src/fv/search-input/types.ts"
-          }
-        }
-      ]
-    },
     {
       "kind": "javascript-module",
       "path": "src/fv/split-button/index.ts",
@@ -1402,41 +1185,258 @@
     },
     {
       "kind": "javascript-module",
-      "path": "src/fv/summary-panel/index.ts",
+      "path": "src/fv/search-input/index.ts",
       "declarations": [
         {
           "kind": "class",
-          "description": "A layout container for summary tiles with an optional edit-items affordance.",
-          "name": "FvSummaryPanel",
+          "description": "A compact search input with a built-in clear affordance.",
+          "name": "FvSearchInput",
           "members": [
             {
               "kind": "field",
-              "name": "showEditItemsButton",
+              "name": "appearance",
               "type": {
-                "text": "boolean"
+                "text": "FvSearchInputAppearanceType"
               },
-              "privacy": "public",
-              "default": "false"
-            },
+              "privacy": "public"
+            }
+          ],
+          "events": [
             {
-              "kind": "field",
-              "name": "legacyStyle",
+              "name": "input",
               "type": {
-                "text": "boolean"
-              },
-              "privacy": "public",
-              "default": "false"
-            },
+                "text": "Event"
+              }
+            }
+          ],
+          "attributes": [
             {
-              "kind": "field",
-              "name": "editItemsButtonLabel",
+              "name": "appearance",
               "type": {
-                "text": "string"
+                "text": "FvSearchInputAppearanceType"
               },
-              "privacy": "public",
-              "default": "'Configure'"
-            },
-            {
+              "fieldName": "appearance"
+            }
+          ],
+          "superclass": {
+            "name": "FoundationTextField",
+            "package": "@ni/fast-foundation"
+          }
+        },
+        {
+          "kind": "variable",
+          "name": "fvSearchInputTag",
+          "type": {
+            "text": "string"
+          },
+          "default": "'ok-fv-search-input'"
+        }
+      ],
+      "exports": [
+        {
+          "kind": "js",
+          "name": "FvSearchInput",
+          "declaration": {
+            "name": "FvSearchInput",
+            "module": "src/fv/search-input/index.ts"
+          }
+        },
+        {
+          "kind": "js",
+          "name": "fvSearchInputTag",
+          "declaration": {
+            "name": "fvSearchInputTag",
+            "module": "src/fv/search-input/index.ts"
+          }
+        }
+      ]
+    },
+    {
+      "kind": "javascript-module",
+      "path": "src/fv/search-input/types.ts",
+      "declarations": [
+        {
+          "kind": "variable",
+          "name": "FvSearchInputAppearance",
+          "type": {
+            "text": "{\n    block: 'block',\n    outline: 'outline',\n    underline: 'underline',\n    frameless: 'frameless'\n}"
+          },
+          "default": "{ block: 'block', outline: 'outline', underline: 'underline', frameless: 'frameless' }"
+        }
+      ],
+      "exports": [
+        {
+          "kind": "js",
+          "name": "FvSearchInputAppearance",
+          "declaration": {
+            "name": "FvSearchInputAppearance",
+            "module": "src/fv/search-input/types.ts"
+          }
+        }
+      ]
+    },
+    {
+      "kind": "javascript-module",
+      "path": "src/fv/context-help/index.ts",
+      "declarations": [
+        {
+          "kind": "class",
+          "description": "An info trigger with an attached tooltip for lightweight contextual guidance.",
+          "name": "FvContextHelp",
+          "members": [
+            {
+              "kind": "field",
+              "name": "text",
+              "type": {
+                "text": "string"
+              },
+              "privacy": "public",
+              "default": "''"
+            },
+            {
+              "kind": "field",
+              "name": "triggerLabel",
+              "type": {
+                "text": "string"
+              },
+              "privacy": "public",
+              "default": "'Show help'"
+            },
+            {
+              "kind": "field",
+              "name": "severity",
+              "type": {
+                "text": "FvContextHelpSeverity"
+              },
+              "privacy": "public"
+            },
+            {
+              "kind": "field",
+              "name": "iconVisible",
+              "type": {
+                "text": "boolean"
+              },
+              "privacy": "public",
+              "default": "false"
+            }
+          ],
+          "attributes": [
+            {
+              "name": "text",
+              "type": {
+                "text": "string"
+              },
+              "default": "''",
+              "fieldName": "text"
+            },
+            {
+              "name": "trigger-label",
+              "type": {
+                "text": "string"
+              },
+              "default": "'Show help'",
+              "fieldName": "triggerLabel"
+            },
+            {
+              "name": "severity",
+              "type": {
+                "text": "FvContextHelpSeverity"
+              },
+              "fieldName": "severity"
+            },
+            {
+              "name": "icon-visible",
+              "type": {
+                "text": "boolean"
+              },
+              "default": "false",
+              "fieldName": "iconVisible"
+            }
+          ],
+          "superclass": {
+            "name": "FoundationElement",
+            "package": "@ni/fast-foundation"
+          }
+        },
+        {
+          "kind": "variable",
+          "name": "fvContextHelpTag",
+          "type": {
+            "text": "string"
+          },
+          "default": "'ok-fv-context-help'"
+        }
+      ],
+      "exports": [
+        {
+          "kind": "js",
+          "name": "FvContextHelpSeverity",
+          "declaration": {
+            "name": "FvContextHelpSeverity",
+            "module": "src/fv/context-help/index.ts"
+          }
+        },
+        {
+          "kind": "js",
+          "name": "FvContextHelp",
+          "declaration": {
+            "name": "FvContextHelp",
+            "module": "src/fv/context-help/index.ts"
+          }
+        },
+        {
+          "kind": "js",
+          "name": "fvContextHelpTag",
+          "declaration": {
+            "name": "fvContextHelpTag",
+            "module": "src/fv/context-help/index.ts"
+          }
+        }
+      ]
+    },
+    {
+      "kind": "javascript-module",
+      "path": "src/fv/context-help/types.ts",
+      "declarations": [],
+      "exports": []
+    },
+    {
+      "kind": "javascript-module",
+      "path": "src/fv/summary-panel/index.ts",
+      "declarations": [
+        {
+          "kind": "class",
+          "description": "A layout container for summary tiles with an optional edit-items affordance.",
+          "name": "FvSummaryPanel",
+          "members": [
+            {
+              "kind": "field",
+              "name": "showEditItemsButton",
+              "type": {
+                "text": "boolean"
+              },
+              "privacy": "public",
+              "default": "false"
+            },
+            {
+              "kind": "field",
+              "name": "legacyStyle",
+              "type": {
+                "text": "boolean"
+              },
+              "privacy": "public",
+              "default": "false"
+            },
+            {
+              "kind": "field",
+              "name": "editItemsButtonLabel",
+              "type": {
+                "text": "string"
+              },
+              "privacy": "public",
+              "default": "'Configure'"
+            },
+            {
               "kind": "method",
               "name": "syncTileLegacyStyle",
               "privacy": "private",
@@ -1743,6 +1743,542 @@
           }
         }
       ]
+    },
+    {
+      "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": "requestBreakpointStateChange",
+              "privacy": "public",
+              "return": {
+                "type": {
+                  "text": "void"
+                }
+              },
+              "parameters": [
+                {
+                  "name": "recordId",
+                  "type": {
+                    "text": "string"
+                  }
+                },
+                {
+                  "name": "currentState",
+                  "type": {
+                    "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": "TableCellView",
+            "package": "@ni/nimble-components/dist/esm/table-column/base/cell-view"
+          }
+        },
+        {
+          "kind": "variable",
+          "name": "requestedState"
+        },
+        {
+          "kind": "variable",
+          "name": "tsTableColumnBreakpointCellViewTag",
+          "type": {
+            "text": "string"
+          },
+          "default": "'ok-ts-table-column-breakpoint-cell-view'"
+        }
+      ],
+      "exports": [
+        {
+          "kind": "js",
+          "name": "TsTableColumnBreakpointCellView",
+          "declaration": {
+            "name": "TsTableColumnBreakpointCellView",
+            "module": "src/ts/table-column/breakpoint/cell-view/index.ts"
+          }
+        },
+        {
+          "kind": "js",
+          "name": "tsTableColumnBreakpointCellViewTag",
+          "declaration": {
+            "name": "tsTableColumnBreakpointCellViewTag",
+            "module": "src/ts/table-column/breakpoint/cell-view/index.ts"
+          }
+        }
+      ]
     }
   ]
 }