@fusion.dev/helix 0.5.0 → 0.6.0

package/custom-elements.json

@@ -98849,7 +98849,7 @@
                 "text": "number"
               },
               "default": "32",
-              "description": "How tall one row is, in pixels, used to map scroll offset to an index.",
+              "description": "How tall one row is, in pixels, used to map scroll offset to an index.\n\nAn estimate rather than a measurement while `measured` is off, which is\nright whenever the rows really are one height and is the cheaper of the two.",
               "attribute": "estimate",
               "inheritedFrom": {
                 "name": "HelixHeadlessVirtualList",
@@ -98884,6 +98884,20 @@
                 "module": "src/virtual-list/root/virtual-list-root.ts"
               }
             },
+            {
+              "kind": "field",
+              "name": "measured",
+              "type": {
+                "text": "boolean"
+              },
+              "default": "false",
+              "description": "Places rows by what they came to rather than by `estimate`.\n\n**Off by default, because the straight line is better when it holds.** One\nestimate makes offset and index convert by division, which can never\ndisagree with itself; measuring is what a set of genuinely different\nheights needs and costs a read of each row as it renders. A list of\none-line rows should leave this alone.",
+              "attribute": "measured",
+              "inheritedFrom": {
+                "name": "HelixHeadlessVirtualList",
+                "module": "src/virtual-list/root/virtual-list-root.ts"
+              }
+            },
             {
               "kind": "field",
               "name": "rows",
@@ -98903,7 +98917,22 @@
               "name": "virtualize",
               "privacy": "private",
               "readonly": true,
-              "default": "new VirtualizeController(this, { container: () => this.renderRoot.querySelector<HTMLElement>('[part=\"viewport\"]'), count: () => this.rows.length, estimate: () => this.estimate, })",
+              "default": "new VirtualizeController(this, { container: () => this.renderRoot.querySelector<HTMLElement>('[part=\"viewport\"]'), count: () => this.rows.length, estimate: () => this.estimate, measured: () => this.measured, rows: () => this.drawn(), })",
+              "inheritedFrom": {
+                "name": "HelixHeadlessVirtualList",
+                "module": "src/virtual-list/root/virtual-list-root.ts"
+              }
+            },
+            {
+              "kind": "method",
+              "name": "drawn",
+              "privacy": "private",
+              "return": {
+                "type": {
+                  "text": "{ element: HTMLElement; index: number }[]"
+                }
+              },
+              "description": "The rows in the tree, each with the item it drew.\n\n**Read off `data-index` rather than counted**, because what is in the tree\nwhen the controller asks is what `place` appended on the *previous* pass:\n`hostUpdated` runs before `updated`, so counting from the current window\nwould record the right heights against the wrong items every time the\nwindow moved.",
               "inheritedFrom": {
                 "name": "HelixHeadlessVirtualList",
                 "module": "src/virtual-list/root/virtual-list-root.ts"
@@ -99142,7 +99171,7 @@
                 "text": "number"
               },
               "default": "32",
-              "description": "How tall one row is, in pixels, used to map scroll offset to an index.",
+              "description": "How tall one row is, in pixels, used to map scroll offset to an index.\n\nAn estimate rather than a measurement while `measured` is off, which is\nright whenever the rows really are one height and is the cheaper of the two.",
               "fieldName": "estimate",
               "inheritedFrom": {
                 "name": "HelixHeadlessVirtualList",
@@ -99174,6 +99203,19 @@
                 "name": "HelixHeadlessVirtualList",
                 "module": "src/virtual-list/root/virtual-list-root.ts"
               }
+            },
+            {
+              "name": "measured",
+              "type": {
+                "text": "boolean"
+              },
+              "default": "false",
+              "description": "Places rows by what they came to rather than by `estimate`.\n\n**Off by default, because the straight line is better when it holds.** One\nestimate makes offset and index convert by division, which can never\ndisagree with itself; measuring is what a set of genuinely different\nheights needs and costs a read of each row as it renders. A list of\none-line rows should leave this alone.",
+              "fieldName": "measured",
+              "inheritedFrom": {
+                "name": "HelixHeadlessVirtualList",
+                "module": "src/virtual-list/root/virtual-list-root.ts"
+              }
             }
           ],
           "modulePath": "src/virtual-list/root/virtual-list-root.ts",

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@fusion.dev/helix",
   "description": "Styled component tier. Extends the headless tier with token-driven presentation.",
-  "version": "0.5.0",
+  "version": "0.6.0",
   "license": "MIT",
   "author": "Ross Sheppard <ross.sheppard@fusion.dev>",
   "repository": {
@@ -46,14 +46,14 @@
   },
   "bugs": "https://github.com/project-fusion/fusion/issues",
   "dependencies": {
-    "@fusion.dev/helix-core": "0.5.0",
-    "@fusion.dev/helix-headless": "0.5.0",
-    "@fusion.dev/helix-styles": "0.5.0"
+    "@fusion.dev/helix-core": "0.6.0",
+    "@fusion.dev/helix-headless": "0.6.0",
+    "@fusion.dev/helix-styles": "0.6.0"
   },
   "devDependencies": {
     "@custom-elements-manifest/analyzer": "^0.11.0",
-    "@fusion.dev/helix-cem": "0.5.0",
-    "@fusion.dev/helix-testing": "0.5.0",
+    "@fusion.dev/helix-cem": "0.6.0",
+    "@fusion.dev/helix-testing": "0.6.0",
     "@fusion.dev/scripts": "0.0.0-dev",
     "@happy-dom/global-registrator": "^20.0.0",
     "@lit-labs/ssr": "^3.3.0",

package/types/jsx.d.ts

@@ -17890,21 +17890,43 @@ past the end is the one write the platform answers with an exception. */
 };
 
 export type HelixVirtualListProps = {
-  /** How tall one row is, in pixels, used to map scroll offset to an index. */
+  /** How tall one row is, in pixels, used to map scroll offset to an index.
+
+An estimate rather than a measurement while `measured` is off, which is
+right whenever the rows really are one height and is the cheaper of the two. */
   estimate?: (HelixVirtualList["estimate"]) | undefined;
   /** Id of the element holding the rows, as JSON in a script. */
   for?: (HelixVirtualList["for"]) | undefined;
   /** What the list is called, since the rendered rows are only a window on it. */
   label?: (HelixVirtualList["label"]) | undefined;
+  /** Places rows by what they came to rather than by `estimate`.
+
+**Off by default, because the straight line is better when it holds.** One
+estimate makes offset and index convert by division, which can never
+disagree with itself; measuring is what a set of genuinely different
+heights needs and costs a read of each row as it renders. A list of
+one-line rows should leave this alone. */
+  measured?: (HelixVirtualList["measured"]) | undefined;
 };
 
 export type HelixVirtualListSolidJsProps = {
-  /** How tall one row is, in pixels, used to map scroll offset to an index. */
+  /** How tall one row is, in pixels, used to map scroll offset to an index.
+
+An estimate rather than a measurement while `measured` is off, which is
+right whenever the rows really are one height and is the cheaper of the two. */
   "prop:estimate"?: (HelixVirtualList["estimate"]) | undefined;
   /** Id of the element holding the rows, as JSON in a script. */
   "prop:for"?: (HelixVirtualList["for"]) | undefined;
   /** What the list is called, since the rendered rows are only a window on it. */
   "prop:label"?: (HelixVirtualList["label"]) | undefined;
+  /** Places rows by what they came to rather than by `estimate`.
+
+**Off by default, because the straight line is better when it holds.** One
+estimate makes offset and index convert by division, which can never
+disagree with itself; measuring is what a set of genuinely different
+heights needs and costs a read of each row as it renders. A list of
+one-line rows should leave this alone. */
+  "prop:measured"?: (HelixVirtualList["measured"]) | undefined;
 
   /** Set the innerHTML of the element */
   innerHTML?: (string) | undefined;
@@ -33451,8 +33473,18 @@ export type CustomElements = {
    * Component attributes and properties that can be applied to the element or by using JavaScript.
    *
    * - `estimate`: How tall one row is, in pixels, used to map scroll offset to an index.
+   *
+   * An estimate rather than a measurement while `measured` is off, which is
+   * right whenever the rows really are one height and is the cheaper of the two.
    * - `for`: Id of the element holding the rows, as JSON in a script.
    * - `label`: What the list is called, since the rendered rows are only a window on it.
+   * - `measured`: Places rows by what they came to rather than by `estimate`.
+   *
+   * **Off by default, because the straight line is better when it holds.** One
+   * estimate makes offset and index convert by division, which can never
+   * disagree with itself; measuring is what a set of genuinely different
+   * heights needs and costs a read of each row as it renders. A list of
+   * one-line rows should leave this alone.
    * - `whenSettled`: Resolves a frame after the first update, when transitions are switched on.
    *
    * **Named `whenSettled` because `settled` is taken four times over**, by
@@ -49411,8 +49443,18 @@ export type CustomElementsSolidJs = {
    * Component attributes and properties that can be applied to the element or by using JavaScript.
    *
    * - `estimate`: How tall one row is, in pixels, used to map scroll offset to an index.
+   *
+   * An estimate rather than a measurement while `measured` is off, which is
+   * right whenever the rows really are one height and is the cheaper of the two.
    * - `for`: Id of the element holding the rows, as JSON in a script.
    * - `label`: What the list is called, since the rendered rows are only a window on it.
+   * - `measured`: Places rows by what they came to rather than by `estimate`.
+   *
+   * **Off by default, because the straight line is better when it holds.** One
+   * estimate makes offset and index convert by division, which can never
+   * disagree with itself; measuring is what a set of genuinely different
+   * heights needs and costs a read of each row as it renders. A list of
+   * one-line rows should leave this alone.
    * - `whenSettled`: Resolves a frame after the first update, when transitions are switched on.
    *
    * **Named `whenSettled` because `settled` is taken four times over**, by

package/types/vue.d.ts

@@ -9153,12 +9153,23 @@ export type HelixVideoVueEvents = {
 };
 
 export type HelixVirtualListVueProps = {
-  /** How tall one row is, in pixels, used to map scroll offset to an index. */
+  /** How tall one row is, in pixels, used to map scroll offset to an index.
+
+An estimate rather than a measurement while `measured` is off, which is
+right whenever the rows really are one height and is the cheaper of the two. */
   estimate?: (HelixVirtualList["estimate"]) | undefined;
   /** Id of the element holding the rows, as JSON in a script. */
   for?: (HelixVirtualList["for"]) | undefined;
   /** What the list is called, since the rendered rows are only a window on it. */
   label?: (HelixVirtualList["label"]) | undefined;
+  /** Places rows by what they came to rather than by `estimate`.
+
+**Off by default, because the straight line is better when it holds.** One
+estimate makes offset and index convert by division, which can never
+disagree with itself; measuring is what a set of genuinely different
+heights needs and costs a read of each row as it renders. A list of
+one-line rows should leave this alone. */
+  measured?: (HelixVirtualList["measured"]) | undefined;
 };
 
 export type HelixVirtualListVueEvents = {};