@ni/ok-components 1.10.3 → 1.11.0

package/dist/custom-elements.json

@@ -185,6 +185,513 @@
         }
       ]
     },
+    {
+      "kind": "javascript-module",
+      "path": "src/fv/bulk-edit-field/index.ts",
+      "declarations": [
+        {
+          "kind": "class",
+          "description": "A labeled field shell for single- and multi-record editing.",
+          "name": "FvBulkEditField",
+          "members": [
+            {
+              "kind": "field",
+              "name": "label",
+              "type": {
+                "text": "string"
+              },
+              "privacy": "public",
+              "default": "''"
+            },
+            {
+              "kind": "field",
+              "name": "status",
+              "type": {
+                "text": "BulkEditFieldStatusType"
+              },
+              "privacy": "public"
+            },
+            {
+              "kind": "field",
+              "name": "resetDisabled",
+              "type": {
+                "text": "boolean"
+              },
+              "privacy": "public",
+              "default": "false"
+            },
+            {
+              "kind": "field",
+              "name": "clearDisabled",
+              "type": {
+                "text": "boolean"
+              },
+              "privacy": "public",
+              "default": "false"
+            },
+            {
+              "kind": "field",
+              "name": "labelObserver",
+              "privacy": "private",
+              "readonly": true,
+              "default": "new MutationObserver(() => this.updateControlLabels())"
+            },
+            {
+              "kind": "field",
+              "name": "controlLabel",
+              "type": {
+                "text": "string"
+              },
+              "privacy": "public",
+              "description": "Accessible name applied to directly slotted field controls.",
+              "readonly": true
+            },
+            {
+              "kind": "method",
+              "name": "updateControlLabels",
+              "privacy": "private",
+              "return": {
+                "type": {
+                  "text": "void"
+                }
+              }
+            },
+            {
+              "kind": "method",
+              "name": "observeControlLabels",
+              "privacy": "private",
+              "return": {
+                "type": {
+                  "text": "void"
+                }
+              }
+            }
+          ],
+          "attributes": [
+            {
+              "name": "label",
+              "type": {
+                "text": "string"
+              },
+              "default": "''",
+              "fieldName": "label"
+            },
+            {
+              "name": "status",
+              "type": {
+                "text": "BulkEditFieldStatusType"
+              },
+              "fieldName": "status"
+            },
+            {
+              "name": "reset-disabled",
+              "type": {
+                "text": "boolean"
+              },
+              "default": "false",
+              "fieldName": "resetDisabled"
+            },
+            {
+              "name": "clear-disabled",
+              "type": {
+                "text": "boolean"
+              },
+              "default": "false",
+              "fieldName": "clearDisabled"
+            }
+          ],
+          "superclass": {
+            "name": "FoundationElement",
+            "package": "@ni/fast-foundation"
+          }
+        },
+        {
+          "kind": "variable",
+          "name": "fvBulkEditFieldTag",
+          "type": {
+            "text": "string"
+          },
+          "default": "'ok-fv-bulk-edit-field'"
+        }
+      ],
+      "exports": [
+        {
+          "kind": "js",
+          "name": "FvBulkEditField",
+          "declaration": {
+            "name": "FvBulkEditField",
+            "module": "src/fv/bulk-edit-field/index.ts"
+          }
+        },
+        {
+          "kind": "js",
+          "name": "fvBulkEditFieldTag",
+          "declaration": {
+            "name": "fvBulkEditFieldTag",
+            "module": "src/fv/bulk-edit-field/index.ts"
+          }
+        },
+        {
+          "kind": "js",
+          "name": "BulkEditFieldStatus",
+          "declaration": {
+            "name": "BulkEditFieldStatus",
+            "module": "src/fv/bulk-edit-field/index.ts"
+          }
+        },
+        {
+          "kind": "js",
+          "name": "BulkEditFieldStatusType",
+          "declaration": {
+            "name": "BulkEditFieldStatusType",
+            "module": "src/fv/bulk-edit-field/index.ts"
+          }
+        }
+      ]
+    },
+    {
+      "kind": "javascript-module",
+      "path": "src/fv/bulk-edit-field/types.ts",
+      "declarations": [
+        {
+          "kind": "variable",
+          "name": "BulkEditFieldStatus",
+          "type": {
+            "text": "{\n    unchanged: 'unchanged',\n    mixed: 'mixed',\n    changed: 'changed',\n    willClear: 'will-clear'\n}"
+          },
+          "default": "{ unchanged: 'unchanged', mixed: 'mixed', changed: 'changed', willClear: 'will-clear' }"
+        }
+      ],
+      "exports": [
+        {
+          "kind": "js",
+          "name": "BulkEditFieldStatus",
+          "declaration": {
+            "name": "BulkEditFieldStatus",
+            "module": "src/fv/bulk-edit-field/types.ts"
+          }
+        }
+      ]
+    },
+    {
+      "kind": "javascript-module",
+      "path": "src/fv/bulk-edit-state/index.ts",
+      "declarations": [
+        {
+          "kind": "class",
+          "description": "Framework-neutral state for editing common fields across selected records.",
+          "name": "BulkEditState",
+          "members": [
+            {
+              "kind": "field",
+              "name": "records",
+              "type": {
+                "text": "readonly TRecord[]"
+              },
+              "privacy": "private"
+            },
+            {
+              "kind": "field",
+              "name": "id",
+              "type": {
+                "text": "(record: TRecord) => RecordId"
+              },
+              "privacy": "private",
+              "readonly": true
+            },
+            {
+              "kind": "field",
+              "name": "read",
+              "type": {
+                "text": "(record: TRecord, field: TField) => string"
+              },
+              "privacy": "private",
+              "readonly": true
+            },
+            {
+              "kind": "field",
+              "name": "selected",
+              "privacy": "private",
+              "default": "new Set<RecordId>()"
+            },
+            {
+              "kind": "field",
+              "name": "pending",
+              "privacy": "private",
+              "readonly": true,
+              "default": "new Map<TField, string>()"
+            },
+            {
+              "kind": "field",
+              "name": "draft",
+              "privacy": "private",
+              "readonly": true,
+              "default": "new Map<TField, string>()"
+            },
+            {
+              "kind": "field",
+              "name": "selectedIds",
+              "type": {
+                "text": "readonly RecordId[]"
+              },
+              "privacy": "public",
+              "readonly": true
+            },
+            {
+              "kind": "field",
+              "name": "changes",
+              "type": {
+                "text": "Readonly<PendingChanges<TField>>"
+              },
+              "privacy": "public",
+              "readonly": true
+            },
+            {
+              "kind": "field",
+              "name": "selectedRecords",
+              "type": {
+                "text": "readonly TRecord[]"
+              },
+              "privacy": "public",
+              "readonly": true
+            },
+            {
+              "kind": "method",
+              "name": "field",
+              "privacy": "public",
+              "return": {
+                "type": {
+                  "text": "BulkEditFieldValue"
+                }
+              },
+              "parameters": [
+                {
+                  "name": "field",
+                  "type": {
+                    "text": "TField"
+                  }
+                }
+              ]
+            },
+            {
+              "kind": "method",
+              "name": "edit",
+              "privacy": "public",
+              "return": {
+                "type": {
+                  "text": "void"
+                }
+              },
+              "parameters": [
+                {
+                  "name": "field",
+                  "type": {
+                    "text": "TField"
+                  }
+                },
+                {
+                  "name": "value",
+                  "type": {
+                    "text": "string"
+                  }
+                }
+              ]
+            },
+            {
+              "kind": "method",
+              "name": "clear",
+              "privacy": "public",
+              "return": {
+                "type": {
+                  "text": "void"
+                }
+              },
+              "parameters": [
+                {
+                  "name": "field",
+                  "type": {
+                    "text": "TField"
+                  }
+                }
+              ]
+            },
+            {
+              "kind": "method",
+              "name": "resetField",
+              "privacy": "public",
+              "return": {
+                "type": {
+                  "text": "void"
+                }
+              },
+              "parameters": [
+                {
+                  "name": "field",
+                  "type": {
+                    "text": "TField"
+                  }
+                }
+              ]
+            },
+            {
+              "kind": "method",
+              "name": "revert",
+              "privacy": "public",
+              "return": {
+                "type": {
+                  "text": "void"
+                }
+              }
+            },
+            {
+              "kind": "method",
+              "name": "isSelection",
+              "privacy": "public",
+              "return": {
+                "type": {
+                  "text": "boolean"
+                }
+              },
+              "parameters": [
+                {
+                  "name": "ids",
+                  "type": {
+                    "text": "readonly RecordId[]"
+                  }
+                }
+              ]
+            },
+            {
+              "kind": "method",
+              "name": "visibleSelection",
+              "privacy": "public",
+              "return": {
+                "type": {
+                  "text": "readonly RecordId[]"
+                }
+              },
+              "parameters": [
+                {
+                  "name": "visibleIds",
+                  "type": {
+                    "text": "readonly RecordId[]"
+                  }
+                }
+              ]
+            },
+            {
+              "kind": "method",
+              "name": "mergeVisible",
+              "privacy": "public",
+              "return": {
+                "type": {
+                  "text": "readonly RecordId[]"
+                }
+              },
+              "parameters": [
+                {
+                  "name": "visibleIds",
+                  "type": {
+                    "text": "readonly RecordId[]"
+                  }
+                },
+                {
+                  "name": "selectedVisibleIds",
+                  "type": {
+                    "text": "readonly RecordId[]"
+                  }
+                },
+                {
+                  "name": "additive",
+                  "default": "false"
+                }
+              ]
+            },
+            {
+              "kind": "method",
+              "name": "select",
+              "privacy": "public",
+              "return": {
+                "type": {
+                  "text": "void"
+                }
+              },
+              "parameters": [
+                {
+                  "name": "ids",
+                  "type": {
+                    "text": "readonly RecordId[]"
+                  }
+                }
+              ]
+            },
+            {
+              "kind": "method",
+              "name": "createCommit",
+              "privacy": "public",
+              "return": {
+                "type": {
+                  "text": "BulkEditCommit<TRecord, TField>"
+                }
+              }
+            },
+            {
+              "kind": "method",
+              "name": "commitSucceeded",
+              "privacy": "public",
+              "return": {
+                "type": {
+                  "text": "void"
+                }
+              },
+              "parameters": [
+                {
+                  "name": "updatedRecords",
+                  "optional": true,
+                  "type": {
+                    "text": "readonly TRecord[]"
+                  }
+                }
+              ]
+            },
+            {
+              "kind": "method",
+              "name": "setPending",
+              "privacy": "private",
+              "return": {
+                "type": {
+                  "text": "void"
+                }
+              },
+              "parameters": [
+                {
+                  "name": "field",
+                  "type": {
+                    "text": "TField"
+                  }
+                },
+                {
+                  "name": "value",
+                  "type": {
+                    "text": "string"
+                  }
+                }
+              ]
+            }
+          ]
+        }
+      ],
+      "exports": [
+        {
+          "kind": "js",
+          "name": "BulkEditState",
+          "declaration": {
+            "name": "BulkEditState",
+            "module": "src/fv/bulk-edit-state/index.ts"
+          }
+        }
+      ]
+    },
     {
       "kind": "javascript-module",
       "path": "src/fv/card/index.ts",
@@ -808,6 +1315,209 @@
       "declarations": [],
       "exports": []
     },
+    {
+      "kind": "javascript-module",
+      "path": "src/fv/edit-commit-bar/index.ts",
+      "declarations": [
+        {
+          "kind": "class",
+          "description": "Heading, pending-change summary, actions, and feedback for an edit pane.",
+          "name": "FvEditCommitBar",
+          "members": [
+            {
+              "kind": "field",
+              "name": "heading",
+              "type": {
+                "text": "string"
+              },
+              "privacy": "public",
+              "default": "''"
+            },
+            {
+              "kind": "field",
+              "name": "changeCount",
+              "type": {
+                "text": "number"
+              },
+              "privacy": "public",
+              "default": "0"
+            },
+            {
+              "kind": "field",
+              "name": "affectedRowCount",
+              "type": {
+                "text": "number"
+              },
+              "privacy": "public",
+              "default": "0"
+            },
+            {
+              "kind": "field",
+              "name": "hiddenAffectedRowCount",
+              "type": {
+                "text": "number"
+              },
+              "privacy": "public",
+              "default": "0"
+            },
+            {
+              "kind": "field",
+              "name": "saveDisabled",
+              "type": {
+                "text": "boolean"
+              },
+              "privacy": "public",
+              "default": "false"
+            },
+            {
+              "kind": "field",
+              "name": "revertDisabled",
+              "type": {
+                "text": "boolean"
+              },
+              "privacy": "public",
+              "default": "false"
+            },
+            {
+              "kind": "field",
+              "name": "actionsHidden",
+              "type": {
+                "text": "boolean"
+              },
+              "privacy": "public",
+              "default": "false"
+            },
+            {
+              "kind": "field",
+              "name": "hideEmptySummary",
+              "type": {
+                "text": "boolean"
+              },
+              "privacy": "public",
+              "default": "false"
+            },
+            {
+              "kind": "field",
+              "name": "message",
+              "type": {
+                "text": "CommitMessage | undefined"
+              },
+              "privacy": "public"
+            }
+          ],
+          "attributes": [
+            {
+              "name": "heading",
+              "type": {
+                "text": "string"
+              },
+              "default": "''",
+              "fieldName": "heading"
+            },
+            {
+              "name": "change-count",
+              "type": {
+                "text": "number"
+              },
+              "default": "0",
+              "fieldName": "changeCount"
+            },
+            {
+              "name": "affected-row-count",
+              "type": {
+                "text": "number"
+              },
+              "default": "0",
+              "fieldName": "affectedRowCount"
+            },
+            {
+              "name": "hidden-affected-row-count",
+              "type": {
+                "text": "number"
+              },
+              "default": "0",
+              "fieldName": "hiddenAffectedRowCount"
+            },
+            {
+              "name": "save-disabled",
+              "type": {
+                "text": "boolean"
+              },
+              "default": "false",
+              "fieldName": "saveDisabled"
+            },
+            {
+              "name": "revert-disabled",
+              "type": {
+                "text": "boolean"
+              },
+              "default": "false",
+              "fieldName": "revertDisabled"
+            },
+            {
+              "name": "actions-hidden",
+              "type": {
+                "text": "boolean"
+              },
+              "default": "false",
+              "fieldName": "actionsHidden"
+            },
+            {
+              "name": "hide-empty-summary",
+              "type": {
+                "text": "boolean"
+              },
+              "default": "false",
+              "fieldName": "hideEmptySummary"
+            }
+          ],
+          "superclass": {
+            "name": "FoundationElement",
+            "package": "@ni/fast-foundation"
+          }
+        },
+        {
+          "kind": "variable",
+          "name": "fvEditCommitBarTag",
+          "type": {
+            "text": "string"
+          },
+          "default": "'ok-fv-edit-commit-bar'"
+        }
+      ],
+      "exports": [
+        {
+          "kind": "js",
+          "name": "FvEditCommitBar",
+          "declaration": {
+            "name": "FvEditCommitBar",
+            "module": "src/fv/edit-commit-bar/index.ts"
+          }
+        },
+        {
+          "kind": "js",
+          "name": "fvEditCommitBarTag",
+          "declaration": {
+            "name": "fvEditCommitBarTag",
+            "module": "src/fv/edit-commit-bar/index.ts"
+          }
+        },
+        {
+          "kind": "js",
+          "name": "CommitMessage",
+          "declaration": {
+            "name": "CommitMessage",
+            "module": "src/fv/edit-commit-bar/index.ts"
+          }
+        }
+      ]
+    },
+    {
+      "kind": "javascript-module",
+      "path": "src/fv/edit-commit-bar/types.ts",
+      "declarations": [],
+      "exports": []
+    },
     {
       "kind": "javascript-module",
       "path": "src/fv/master-detail-list/index.ts",
@@ -1723,6 +2433,305 @@
         }
       ]
     },
+    {
+      "kind": "javascript-module",
+      "path": "src/fv/split-layout/index.ts",
+      "declarations": [
+        {
+          "kind": "class",
+          "description": "A full-height, resizable two-pane layout.",
+          "name": "FvSplitLayout",
+          "members": [
+            {
+              "kind": "field",
+              "name": "position",
+              "type": {
+                "text": "number"
+              },
+              "privacy": "public",
+              "default": "60"
+            },
+            {
+              "kind": "field",
+              "name": "min",
+              "type": {
+                "text": "number"
+              },
+              "privacy": "public",
+              "default": "35"
+            },
+            {
+              "kind": "field",
+              "name": "max",
+              "type": {
+                "text": "number"
+              },
+              "privacy": "public",
+              "default": "75"
+            },
+            {
+              "kind": "field",
+              "name": "minSecondaryPixels",
+              "type": {
+                "text": "number"
+              },
+              "privacy": "public",
+              "default": "300"
+            },
+            {
+              "kind": "field",
+              "name": "collapsed",
+              "type": {
+                "text": "boolean"
+              },
+              "privacy": "public",
+              "default": "false"
+            },
+            {
+              "kind": "field",
+              "name": "step",
+              "type": {
+                "text": "number"
+              },
+              "privacy": "public",
+              "default": "1"
+            },
+            {
+              "kind": "field",
+              "name": "primaryPaneId",
+              "type": {
+                "text": "string"
+              },
+              "privacy": "public",
+              "default": "`ok-fv-split-layout-primary-${layoutId}`"
+            },
+            {
+              "kind": "field",
+              "name": "secondaryPaneId",
+              "type": {
+                "text": "string"
+              },
+              "privacy": "public",
+              "default": "`ok-fv-split-layout-secondary-${layoutId}`"
+            },
+            {
+              "kind": "field",
+              "name": "resizeObserver",
+              "privacy": "private",
+              "readonly": true,
+              "default": "new ResizeObserver(entries => { this.availableWidth = entries[0]?.contentRect.width ?? 0; this.constrainPosition(); })"
+            },
+            {
+              "kind": "field",
+              "name": "requestedPosition",
+              "privacy": "private"
+            },
+            {
+              "kind": "field",
+              "name": "applyingConstrainedPosition",
+              "type": {
+                "text": "boolean"
+              },
+              "privacy": "private",
+              "default": "false"
+            },
+            {
+              "kind": "field",
+              "name": "requestedPositionResetScheduled",
+              "type": {
+                "text": "boolean"
+              },
+              "privacy": "private",
+              "default": "false"
+            },
+            {
+              "kind": "field",
+              "name": "positionChangeCallbackVersion",
+              "type": {
+                "text": "number"
+              },
+              "privacy": "private",
+              "default": "0"
+            },
+            {
+              "kind": "method",
+              "name": "positionChanged",
+              "privacy": "public",
+              "return": {
+                "type": {
+                  "text": "void"
+                }
+              }
+            },
+            {
+              "kind": "method",
+              "name": "minChanged",
+              "privacy": "public",
+              "return": {
+                "type": {
+                  "text": "void"
+                }
+              }
+            },
+            {
+              "kind": "method",
+              "name": "maxChanged",
+              "privacy": "public",
+              "return": {
+                "type": {
+                  "text": "void"
+                }
+              }
+            },
+            {
+              "kind": "method",
+              "name": "minSecondaryPixelsChanged",
+              "privacy": "public",
+              "return": {
+                "type": {
+                  "text": "void"
+                }
+              }
+            },
+            {
+              "kind": "method",
+              "name": "collapsedChanged",
+              "privacy": "public",
+              "return": {
+                "type": {
+                  "text": "void"
+                }
+              }
+            },
+            {
+              "kind": "method",
+              "name": "constrainPosition",
+              "privacy": "private",
+              "return": {
+                "type": {
+                  "text": "void"
+                }
+              }
+            },
+            {
+              "kind": "method",
+              "name": "resetRequestedPositionAfterSynchronousUpdates",
+              "privacy": "private",
+              "return": {
+                "type": {
+                  "text": "void"
+                }
+              }
+            },
+            {
+              "kind": "field",
+              "name": "effectiveMinSecondaryPixels",
+              "type": {
+                "text": "number"
+              },
+              "privacy": "private",
+              "readonly": true
+            }
+          ],
+          "attributes": [
+            {
+              "name": "position",
+              "type": {
+                "text": "number"
+              },
+              "default": "60",
+              "fieldName": "position"
+            },
+            {
+              "name": "min",
+              "type": {
+                "text": "number"
+              },
+              "default": "35",
+              "fieldName": "min"
+            },
+            {
+              "name": "max",
+              "type": {
+                "text": "number"
+              },
+              "default": "75",
+              "fieldName": "max"
+            },
+            {
+              "name": "min-secondary-pixels",
+              "type": {
+                "text": "number"
+              },
+              "default": "300",
+              "fieldName": "minSecondaryPixels"
+            },
+            {
+              "name": "collapsed",
+              "type": {
+                "text": "boolean"
+              },
+              "default": "false",
+              "fieldName": "collapsed"
+            },
+            {
+              "name": "step",
+              "type": {
+                "text": "number"
+              },
+              "default": "1",
+              "fieldName": "step"
+            },
+            {
+              "name": "primary-pane-id",
+              "type": {
+                "text": "string"
+              },
+              "default": "`ok-fv-split-layout-primary-${layoutId}`",
+              "fieldName": "primaryPaneId"
+            },
+            {
+              "name": "secondary-pane-id",
+              "type": {
+                "text": "string"
+              },
+              "default": "`ok-fv-split-layout-secondary-${layoutId}`",
+              "fieldName": "secondaryPaneId"
+            }
+          ],
+          "superclass": {
+            "name": "FoundationElement",
+            "package": "@ni/fast-foundation"
+          }
+        },
+        {
+          "kind": "variable",
+          "name": "fvSplitLayoutTag",
+          "type": {
+            "text": "string"
+          },
+          "default": "'ok-fv-split-layout'"
+        }
+      ],
+      "exports": [
+        {
+          "kind": "js",
+          "name": "FvSplitLayout",
+          "declaration": {
+            "name": "FvSplitLayout",
+            "module": "src/fv/split-layout/index.ts"
+          }
+        },
+        {
+          "kind": "js",
+          "name": "fvSplitLayoutTag",
+          "declaration": {
+            "name": "fvSplitLayoutTag",
+            "module": "src/fv/split-layout/index.ts"
+          }
+        }
+      ]
+    },
     {
       "kind": "javascript-module",
       "path": "src/fv/splitter/index.ts",