@primitiv-ui/web 0.1.53 → 0.1.55

package/dist/custom-elements.json

@@ -516,6 +516,755 @@
         }
       ]
     },
+    {
+      "kind": "javascript-module",
+      "path": "src/modal/elements.ts",
+      "declarations": [
+        {
+          "kind": "class",
+          "description": "`<primitiv-modal>` — the state owner of a modal dialog, built on the native\n`<dialog>` and its `showModal()`: the browser makes the page behind it inert,\npaints the `::backdrop` and owns the top layer, and the element adds the\nrest of the WAI-ARIA Modal Dialog pattern — Tab wraps inside the dialog,\nEscape and a press on the backdrop close it, and closing hands focus back to\nthe button that opened it.\n\nThe root finds its own parts, so a modal nested in a dialog keeps its own,\nand reconciles their ARIA from its reflected state whenever a part arrives,\nleaves, or changes an attribute the root reads (the lifecycle is\n`PrimitivRootElement`'s). Leave `open` off the `<dialog>` itself: the root\nopens it, modally.",
+          "name": "PrimitivModalElement",
+          "members": [
+            {
+              "kind": "field",
+              "name": "#dialog",
+              "privacy": "private",
+              "type": {
+                "text": "HTMLDialogElement | null"
+              },
+              "default": "null",
+              "description": "The dialog the root currently decorates, and the controller over it."
+            },
+            {
+              "kind": "field",
+              "name": "#modal",
+              "privacy": "private",
+              "type": {
+                "text": "ModalController | null"
+              },
+              "default": "null"
+            },
+            {
+              "kind": "field",
+              "name": "#openers",
+              "privacy": "private",
+              "type": {
+                "text": "HTMLElement[]"
+              },
+              "default": "[]",
+              "description": "The decorated trigger and close buttons, as of the last reconcile."
+            },
+            {
+              "kind": "field",
+              "name": "#closers",
+              "privacy": "private",
+              "type": {
+                "text": "HTMLElement[]"
+              },
+              "default": "[]"
+            },
+            {
+              "kind": "field",
+              "name": "#listening",
+              "privacy": "private",
+              "type": {
+                "text": "AbortController | null"
+              },
+              "default": "null",
+              "description": "The root's own click listener, while connected."
+            },
+            {
+              "kind": "field",
+              "name": "controller",
+              "type": {
+                "text": "{ connect(): void; disconnect(): void }"
+              },
+              "privacy": "protected",
+              "readonly": true,
+              "default": "{ connect: (): void => this.#connect(), disconnect: (): void => this.#disconnect(), }"
+            },
+            {
+              "kind": "field",
+              "name": "reconcileOn",
+              "type": {
+                "text": "readonly string[]"
+              },
+              "privacy": "protected",
+              "readonly": true,
+              "default": "[\"open\"]"
+            },
+            {
+              "kind": "field",
+              "name": "open",
+              "type": {
+                "text": "boolean"
+              },
+              "description": "Whether the dialog is open, reflected as the boolean `open` attribute."
+            },
+            {
+              "kind": "method",
+              "name": "#host",
+              "privacy": "private",
+              "return": {
+                "type": {
+                  "text": "ModalControllerHost"
+                }
+              },
+              "description": "The controller's view of this element: state lives in the reflected attribute."
+            },
+            {
+              "kind": "method",
+              "name": "#change",
+              "privacy": "private",
+              "return": {
+                "type": {
+                  "text": "void"
+                }
+              },
+              "parameters": [
+                {
+                  "name": "open",
+                  "type": {
+                    "text": "boolean"
+                  }
+                }
+              ],
+              "description": "A change the user asked for: announced first, so a listener can veto it."
+            },
+            {
+              "kind": "method",
+              "name": "#connect",
+              "privacy": "private",
+              "return": {
+                "type": {
+                  "text": "void"
+                }
+              }
+            },
+            {
+              "kind": "method",
+              "name": "#disconnect",
+              "privacy": "private",
+              "return": {
+                "type": {
+                  "text": "void"
+                }
+              }
+            },
+            {
+              "kind": "method",
+              "name": "#click",
+              "privacy": "private",
+              "return": {
+                "type": {
+                  "text": "void"
+                }
+              },
+              "parameters": [
+                {
+                  "name": "event",
+                  "type": {
+                    "text": "MouseEvent"
+                  }
+                }
+              ]
+            },
+            {
+              "kind": "method",
+              "name": "#use",
+              "privacy": "private",
+              "return": {
+                "type": {
+                  "text": "void"
+                }
+              },
+              "parameters": [
+                {
+                  "name": "dialog",
+                  "type": {
+                    "text": "HTMLDialogElement | null"
+                  }
+                }
+              ],
+              "description": "Decorate `dialog` from now on: the controller follows it. Only a reconcile\ncalls this, and a root reconciles only while connected, so the new\ncontroller listens at once."
+            },
+            {
+              "kind": "method",
+              "name": "reconcile",
+              "privacy": "protected",
+              "return": {
+                "type": {
+                  "text": "void"
+                }
+              }
+            },
+            {
+              "kind": "method",
+              "name": "#buttons",
+              "privacy": "private",
+              "return": {
+                "type": {
+                  "text": "HTMLElement[]"
+                }
+              },
+              "parameters": [
+                {
+                  "name": "selector",
+                  "type": {
+                    "text": "string"
+                  }
+                }
+              ],
+              "description": "The buttons this root's `selector` parts decorate."
+            }
+          ],
+          "events": [
+            {
+              "type": {
+                "text": "CustomEvent<{ open: boolean }>"
+              },
+              "description": "Bubbles, cancelable, fired before a user-driven change is applied — a trigger or close click, Escape, a press on the backdrop, or the dialog closing natively — with the open state afterwards. Call `preventDefault()` to veto it, e.g. to keep a form with unsaved changes open.",
+              "name": "primitiv-modal-change"
+            }
+          ],
+          "attributes": [
+            {
+              "type": {
+                "text": "boolean"
+              },
+              "description": "Whether the dialog is open. Reflected: it changes as the user opens and dismisses the dialog, so a server re-render or a history snapshot sees the live state. Set it (or the `open` property) to open or close the dialog from script.",
+              "name": "open"
+            }
+          ],
+          "superclass": {
+            "name": "PrimitivRootElement",
+            "module": "/src/internal/RootElement.ts"
+          },
+          "tagName": "primitiv-modal",
+          "customElement": true,
+          "summary": "The state owner of a modal dialog on the native `<dialog>`."
+        },
+        {
+          "kind": "class",
+          "description": "`<primitiv-modal-trigger>` — an interactive part. It decorates exactly one\nchild the consumer writes, a `<button>`, which opens the dialog and receives\n`aria-haspopup=\"dialog\"`, `aria-expanded` and `aria-controls`, so the\nrendered DOM matches React's (RFC 0033 D24). A modal may have several.",
+          "name": "PrimitivModalTriggerElement",
+          "superclass": {
+            "name": "ElementBase",
+            "module": "/src/internal/element.ts"
+          },
+          "tagName": "primitiv-modal-trigger",
+          "customElement": true
+        },
+        {
+          "kind": "class",
+          "description": "`<primitiv-modal-content>` — decorates exactly one native `<dialog>` the\nconsumer writes, which the root opens with `showModal()`, closes, and gives\nan id, `data-state`, and `aria-labelledby` / `aria-describedby` pointing at\nthe title and description. The dialog keeps its implicit `dialog` role.",
+          "name": "PrimitivModalContentElement",
+          "superclass": {
+            "name": "ElementBase",
+            "module": "/src/internal/element.ts"
+          },
+          "tagName": "primitiv-modal-content",
+          "customElement": true
+        },
+        {
+          "kind": "class",
+          "description": "`<primitiv-modal-title>` — decorates exactly one heading the consumer writes\n(an `<h2>`, usually), whose id becomes the dialog's `aria-labelledby`, so it\nis the name a screen reader announces as the dialog opens.",
+          "name": "PrimitivModalTitleElement",
+          "superclass": {
+            "name": "ElementBase",
+            "module": "/src/internal/element.ts"
+          },
+          "tagName": "primitiv-modal-title",
+          "customElement": true
+        },
+        {
+          "kind": "class",
+          "description": "`<primitiv-modal-description>` — decorates exactly one element the consumer\nwrites (a `<p>`, usually), whose id becomes the dialog's `aria-describedby`.",
+          "name": "PrimitivModalDescriptionElement",
+          "superclass": {
+            "name": "ElementBase",
+            "module": "/src/internal/element.ts"
+          },
+          "tagName": "primitiv-modal-description",
+          "customElement": true
+        },
+        {
+          "kind": "class",
+          "description": "`<primitiv-modal-close>` — an interactive part. It decorates exactly one\n`<button>` the consumer writes, which closes the dialog. A modal may have\nseveral: the header's icon button and the footer's Cancel.",
+          "name": "PrimitivModalCloseElement",
+          "superclass": {
+            "name": "ElementBase",
+            "module": "/src/internal/element.ts"
+          },
+          "tagName": "primitiv-modal-close",
+          "customElement": true
+        },
+        {
+          "kind": "function",
+          "name": "defineModal",
+          "return": {
+            "type": {
+              "text": "void"
+            }
+          },
+          "parameters": [
+            {
+              "name": "registry",
+              "default": "globalThis.customElements",
+              "type": {
+                "text": "ElementRegistry | undefined"
+              }
+            }
+          ],
+          "description": "Define the six Modal elements on `registry` (the global `customElements` by\ndefault). Safe to call more than once, and a no-op where there is no\nregistry (a server render)."
+        }
+      ],
+      "exports": [
+        {
+          "kind": "js",
+          "name": "ElementRegistry",
+          "declaration": {
+            "name": "ElementRegistry",
+            "module": "src/modal/elements.ts"
+          }
+        },
+        {
+          "kind": "js",
+          "name": "PrimitivModalElement",
+          "declaration": {
+            "name": "PrimitivModalElement",
+            "module": "src/modal/elements.ts"
+          }
+        },
+        {
+          "kind": "js",
+          "name": "PrimitivModalTriggerElement",
+          "declaration": {
+            "name": "PrimitivModalTriggerElement",
+            "module": "src/modal/elements.ts"
+          }
+        },
+        {
+          "kind": "js",
+          "name": "PrimitivModalContentElement",
+          "declaration": {
+            "name": "PrimitivModalContentElement",
+            "module": "src/modal/elements.ts"
+          }
+        },
+        {
+          "kind": "js",
+          "name": "PrimitivModalTitleElement",
+          "declaration": {
+            "name": "PrimitivModalTitleElement",
+            "module": "src/modal/elements.ts"
+          }
+        },
+        {
+          "kind": "js",
+          "name": "PrimitivModalDescriptionElement",
+          "declaration": {
+            "name": "PrimitivModalDescriptionElement",
+            "module": "src/modal/elements.ts"
+          }
+        },
+        {
+          "kind": "js",
+          "name": "PrimitivModalCloseElement",
+          "declaration": {
+            "name": "PrimitivModalCloseElement",
+            "module": "src/modal/elements.ts"
+          }
+        },
+        {
+          "kind": "js",
+          "name": "defineModal",
+          "declaration": {
+            "name": "defineModal",
+            "module": "src/modal/elements.ts"
+          }
+        }
+      ]
+    },
+    {
+      "kind": "javascript-module",
+      "path": "src/popover/elements.ts",
+      "declarations": [
+        {
+          "kind": "class",
+          "description": "`<primitiv-popover>` — the state owner of a non-modal popover: a trigger\nthat opens a floating panel, built on the native Popover API. The browser\nputs the panel in the top layer and light-dismisses it; the element adds the\nrest of the WAI-ARIA non-modal dialog pattern — focus moves into the panel\nas it opens, Escape closes it and hands focus back to the trigger, and the\ntrigger's `aria-expanded` follows it.\n\nThe panel is shown with its trigger (or the anchor) as its source, which\nmakes that element the panel's implicit anchor, so CSS anchor positioning\n(`position-area`) places it with no `anchor-name` to wire.\n\nThe root finds its own parts, so a popover nested in a panel keeps its own,\nand reconciles their ARIA from its reflected state whenever a part arrives,\nleaves, or changes an attribute the root reads (the lifecycle is\n`PrimitivRootElement`'s).",
+          "name": "PrimitivPopoverElement",
+          "members": [
+            {
+              "kind": "field",
+              "name": "#content",
+              "privacy": "private",
+              "type": {
+                "text": "HTMLElement | null"
+              },
+              "default": "null",
+              "description": "The panel the root currently decorates, and the controller over it."
+            },
+            {
+              "kind": "field",
+              "name": "#popover",
+              "privacy": "private",
+              "type": {
+                "text": "PopoverController | null"
+              },
+              "default": "null"
+            },
+            {
+              "kind": "field",
+              "name": "#trigger",
+              "privacy": "private",
+              "type": {
+                "text": "HTMLElement | null"
+              },
+              "default": "null",
+              "description": "The decorated trigger and close buttons, and the anchor, as of the last reconcile."
+            },
+            {
+              "kind": "field",
+              "name": "#anchor",
+              "privacy": "private",
+              "type": {
+                "text": "HTMLElement | null"
+              },
+              "default": "null"
+            },
+            {
+              "kind": "field",
+              "name": "#closers",
+              "privacy": "private",
+              "type": {
+                "text": "HTMLElement[]"
+              },
+              "default": "[]"
+            },
+            {
+              "kind": "field",
+              "name": "#listening",
+              "privacy": "private",
+              "type": {
+                "text": "AbortController | null"
+              },
+              "default": "null",
+              "description": "The root's own click listener, while connected."
+            },
+            {
+              "kind": "field",
+              "name": "controller",
+              "type": {
+                "text": "{ connect(): void; disconnect(): void }"
+              },
+              "privacy": "protected",
+              "readonly": true,
+              "default": "{ connect: (): void => this.#connect(), disconnect: (): void => this.#disconnect(), }"
+            },
+            {
+              "kind": "field",
+              "name": "reconcileOn",
+              "type": {
+                "text": "readonly string[]"
+              },
+              "privacy": "protected",
+              "readonly": true,
+              "default": "[\"open\"]"
+            },
+            {
+              "kind": "field",
+              "name": "open",
+              "type": {
+                "text": "boolean"
+              },
+              "description": "Whether the panel is open, reflected as the boolean `open` attribute."
+            },
+            {
+              "kind": "method",
+              "name": "#host",
+              "privacy": "private",
+              "return": {
+                "type": {
+                  "text": "PopoverControllerHost"
+                }
+              },
+              "description": "The controller's view of this element: state lives in the reflected attribute."
+            },
+            {
+              "kind": "method",
+              "name": "#change",
+              "privacy": "private",
+              "return": {
+                "type": {
+                  "text": "void"
+                }
+              },
+              "parameters": [
+                {
+                  "name": "open",
+                  "type": {
+                    "text": "boolean"
+                  }
+                }
+              ],
+              "description": "A change the user asked for: announced first, so a listener can veto it."
+            },
+            {
+              "kind": "method",
+              "name": "#connect",
+              "privacy": "private",
+              "return": {
+                "type": {
+                  "text": "void"
+                }
+              }
+            },
+            {
+              "kind": "method",
+              "name": "#disconnect",
+              "privacy": "private",
+              "return": {
+                "type": {
+                  "text": "void"
+                }
+              }
+            },
+            {
+              "kind": "method",
+              "name": "#click",
+              "privacy": "private",
+              "return": {
+                "type": {
+                  "text": "void"
+                }
+              },
+              "parameters": [
+                {
+                  "name": "event",
+                  "type": {
+                    "text": "MouseEvent"
+                  }
+                }
+              ]
+            },
+            {
+              "kind": "method",
+              "name": "#use",
+              "privacy": "private",
+              "return": {
+                "type": {
+                  "text": "void"
+                }
+              },
+              "parameters": [
+                {
+                  "name": "content",
+                  "type": {
+                    "text": "HTMLElement | null"
+                  }
+                }
+              ],
+              "description": "Decorate `content` from now on: the controller follows it. Only a\nreconcile calls this, and a root reconciles only while connected, so the\nnew controller listens at once."
+            },
+            {
+              "kind": "method",
+              "name": "reconcile",
+              "privacy": "protected",
+              "return": {
+                "type": {
+                  "text": "void"
+                }
+              }
+            }
+          ],
+          "events": [
+            {
+              "type": {
+                "text": "CustomEvent<{ open: boolean }>"
+              },
+              "description": "Bubbles, cancelable, fired before a user-driven change is applied — a trigger or close click, Escape, or a light dismiss — with the open state afterwards. Call `preventDefault()` to veto it.",
+              "name": "primitiv-popover-change"
+            }
+          ],
+          "attributes": [
+            {
+              "type": {
+                "text": "boolean"
+              },
+              "description": "Whether the panel is open. Reflected: it changes as the user opens and dismisses it, so a server re-render or a history snapshot sees the live state. Set it (or the `open` property) to open or close the panel from script.",
+              "name": "open"
+            }
+          ],
+          "superclass": {
+            "name": "PrimitivRootElement",
+            "module": "/src/internal/RootElement.ts"
+          },
+          "tagName": "primitiv-popover",
+          "customElement": true,
+          "summary": "The state owner of a non-modal popover on the native Popover API."
+        },
+        {
+          "kind": "class",
+          "description": "`<primitiv-popover-trigger>` — an interactive part. It decorates exactly one\nchild the consumer writes, a `<button>`, which toggles the panel and receives\n`aria-haspopup=\"dialog\"`, `aria-expanded` and `aria-controls`, so the\nrendered DOM matches React's (RFC 0033 D24).",
+          "name": "PrimitivPopoverTriggerElement",
+          "superclass": {
+            "name": "ElementBase",
+            "module": "/src/internal/element.ts"
+          },
+          "tagName": "primitiv-popover-trigger",
+          "customElement": true
+        },
+        {
+          "kind": "class",
+          "description": "`<primitiv-popover-anchor>` — optional. It decorates exactly one element the\nconsumer writes, which the panel is anchored to in place of the trigger: a\nfield, say, whose trigger is an icon inside it.",
+          "name": "PrimitivPopoverAnchorElement",
+          "superclass": {
+            "name": "ElementBase",
+            "module": "/src/internal/element.ts"
+          },
+          "tagName": "primitiv-popover-anchor",
+          "customElement": true
+        },
+        {
+          "kind": "class",
+          "description": "`<primitiv-popover-content>` — the panel. Structural: the root gives it an\nid, `role=\"dialog\"`, `popover=\"auto\"` (write it in your markup too, so the\npanel is hidden before the script loads), `tabindex=\"-1\"`, `data-state`, and\n`aria-labelledby` / `aria-describedby` pointing at the title and description.",
+          "name": "PrimitivPopoverContentElement",
+          "superclass": {
+            "name": "ElementBase",
+            "module": "/src/internal/element.ts"
+          },
+          "tagName": "primitiv-popover-content",
+          "customElement": true
+        },
+        {
+          "kind": "class",
+          "description": "`<primitiv-popover-title>` — decorates exactly one heading the consumer\nwrites, whose id becomes the panel's `aria-labelledby`.",
+          "name": "PrimitivPopoverTitleElement",
+          "superclass": {
+            "name": "ElementBase",
+            "module": "/src/internal/element.ts"
+          },
+          "tagName": "primitiv-popover-title",
+          "customElement": true
+        },
+        {
+          "kind": "class",
+          "description": "`<primitiv-popover-description>` — decorates exactly one element the\nconsumer writes (a `<p>`, usually), whose id becomes the panel's\n`aria-describedby`.",
+          "name": "PrimitivPopoverDescriptionElement",
+          "superclass": {
+            "name": "ElementBase",
+            "module": "/src/internal/element.ts"
+          },
+          "tagName": "primitiv-popover-description",
+          "customElement": true
+        },
+        {
+          "kind": "class",
+          "description": "`<primitiv-popover-close>` — an interactive part. It decorates exactly one\n`<button>` the consumer writes, which closes the panel. A popover may have\nseveral.",
+          "name": "PrimitivPopoverCloseElement",
+          "superclass": {
+            "name": "ElementBase",
+            "module": "/src/internal/element.ts"
+          },
+          "tagName": "primitiv-popover-close",
+          "customElement": true
+        },
+        {
+          "kind": "function",
+          "name": "definePopover",
+          "return": {
+            "type": {
+              "text": "void"
+            }
+          },
+          "parameters": [
+            {
+              "name": "registry",
+              "default": "globalThis.customElements",
+              "type": {
+                "text": "ElementRegistry | undefined"
+              }
+            }
+          ],
+          "description": "Define the seven Popover elements on `registry` (the global `customElements`\nby default). Safe to call more than once, and a no-op where there is no\nregistry (a server render)."
+        }
+      ],
+      "exports": [
+        {
+          "kind": "js",
+          "name": "ElementRegistry",
+          "declaration": {
+            "name": "ElementRegistry",
+            "module": "src/popover/elements.ts"
+          }
+        },
+        {
+          "kind": "js",
+          "name": "PrimitivPopoverElement",
+          "declaration": {
+            "name": "PrimitivPopoverElement",
+            "module": "src/popover/elements.ts"
+          }
+        },
+        {
+          "kind": "js",
+          "name": "PrimitivPopoverTriggerElement",
+          "declaration": {
+            "name": "PrimitivPopoverTriggerElement",
+            "module": "src/popover/elements.ts"
+          }
+        },
+        {
+          "kind": "js",
+          "name": "PrimitivPopoverAnchorElement",
+          "declaration": {
+            "name": "PrimitivPopoverAnchorElement",
+            "module": "src/popover/elements.ts"
+          }
+        },
+        {
+          "kind": "js",
+          "name": "PrimitivPopoverContentElement",
+          "declaration": {
+            "name": "PrimitivPopoverContentElement",
+            "module": "src/popover/elements.ts"
+          }
+        },
+        {
+          "kind": "js",
+          "name": "PrimitivPopoverTitleElement",
+          "declaration": {
+            "name": "PrimitivPopoverTitleElement",
+            "module": "src/popover/elements.ts"
+          }
+        },
+        {
+          "kind": "js",
+          "name": "PrimitivPopoverDescriptionElement",
+          "declaration": {
+            "name": "PrimitivPopoverDescriptionElement",
+            "module": "src/popover/elements.ts"
+          }
+        },
+        {
+          "kind": "js",
+          "name": "PrimitivPopoverCloseElement",
+          "declaration": {
+            "name": "PrimitivPopoverCloseElement",
+            "module": "src/popover/elements.ts"
+          }
+        },
+        {
+          "kind": "js",
+          "name": "definePopover",
+          "declaration": {
+            "name": "definePopover",
+            "module": "src/popover/elements.ts"
+          }
+        }
+      ]
+    },
     {
       "kind": "javascript-module",
       "path": "src/tabs/elements.ts",