@fusion.dev/helix-core 0.110.5 → 0.111.0

package/custom-elements.json

@@ -1978,6 +1978,108 @@
         }
       ]
     },
+    {
+      "kind": "javascript-module",
+      "path": "src/controllers/placement-controller/placement-controller.ts",
+      "declarations": [
+        {
+          "kind": "class",
+          "description": "Custom properties another element sets on this one, kept in its own shadow\nroot.\n\n**Nothing is written onto the page's element.** A marker a connector stands\non the map, or a card a board places, is the page's markup, and its `style`\nattribute is the page's too. Written there, a placement was markup the\nserver never sent, which a framework's hydration reports; and a page that\nset `style` on the element, a card's color, wiped the placement every time\nit rendered. Here the values are a\n`:host` rule in a sheet this element adopts, which inherit to everything the\nelement draws exactly as an inline style's did, and which no framework\nsees.\n\n**Rewritten only when a value changes**, since a map moving writes every\nmarker's place on every frame and most frames move some not at all.",
+          "name": "PlacementController",
+          "members": [
+            {
+              "kind": "field",
+              "name": "values",
+              "privacy": "private",
+              "readonly": true,
+              "default": "new Map<string, string>()"
+            },
+            {
+              "kind": "field",
+              "name": "sheet",
+              "type": {
+                "text": "CSSStyleSheet | undefined"
+              },
+              "privacy": "private"
+            },
+            {
+              "kind": "field",
+              "name": "written",
+              "type": {
+                "text": "string | undefined"
+              },
+              "privacy": "private"
+            },
+            {
+              "kind": "method",
+              "name": "set",
+              "return": {
+                "type": {
+                  "text": "void"
+                }
+              },
+              "parameters": [
+                {
+                  "name": "properties",
+                  "type": {
+                    "text": "Readonly<Record<string, string | undefined>>"
+                  }
+                }
+              ],
+              "description": "Sets each property given, and takes away each one given as `undefined`."
+            },
+            {
+              "kind": "method",
+              "name": "get",
+              "return": {
+                "type": {
+                  "text": "string | undefined"
+                }
+              },
+              "parameters": [
+                {
+                  "name": "name",
+                  "type": {
+                    "text": "string"
+                  }
+                }
+              ],
+              "description": "What a property is set to here, or `undefined` where it is not."
+            },
+            {
+              "kind": "method",
+              "name": "hostConnected",
+              "return": {
+                "type": {
+                  "text": "void"
+                }
+              }
+            },
+            {
+              "kind": "method",
+              "name": "write",
+              "privacy": "private",
+              "return": {
+                "type": {
+                  "text": "void"
+                }
+              }
+            }
+          ],
+          "helix": {}
+        }
+      ],
+      "exports": [
+        {
+          "kind": "js",
+          "name": "PlacementController",
+          "declaration": {
+            "name": "PlacementController",
+            "module": "src/controllers/placement-controller/placement-controller.ts"
+          }
+        }
+      ]
+    },
     {
       "kind": "javascript-module",
       "path": "src/controllers/popover-controller/popover-controller.ts",
@@ -6040,6 +6142,14 @@
             "module": "./controllers/paint-gate-controller/paint-gate-controller.js"
           }
         },
+        {
+          "kind": "js",
+          "name": "PlacementController",
+          "declaration": {
+            "name": "PlacementController",
+            "module": "./controllers/placement-controller/placement-controller.js"
+          }
+        },
         {
           "kind": "js",
           "name": "PopoverController",

package/dist/controllers/placement-controller/placement-controller.d.ts

@@ -0,0 +1,36 @@
+import type { ReactiveController, ReactiveControllerHost } from 'lit';
+/** A host this can adopt a sheet into: one with a shadow root it renders. */
+type Placed = ReactiveControllerHost & HTMLElement & {
+    readonly renderRoot?: Element | DocumentFragment;
+};
+/**
+ * Custom properties another element sets on this one, kept in its own shadow
+ * root.
+ *
+ * **Nothing is written onto the page's element.** A marker a connector stands
+ * on the map, or a card a board places, is the page's markup, and its `style`
+ * attribute is the page's too. Written there, a placement was markup the
+ * server never sent, which a framework's hydration reports; and a page that
+ * set `style` on the element, a card's color, wiped the placement every time
+ * it rendered. Here the values are a
+ * `:host` rule in a sheet this element adopts, which inherit to everything the
+ * element draws exactly as an inline style's did, and which no framework
+ * sees.
+ *
+ * **Rewritten only when a value changes**, since a map moving writes every
+ * marker's place on every frame and most frames move some not at all.
+ */
+export declare class PlacementController implements ReactiveController {
+    private readonly host;
+    private readonly values;
+    private sheet;
+    private written;
+    constructor(host: Placed);
+    /** Sets each property given, and takes away each one given as `undefined`. */
+    set(properties: Readonly<Record<string, string | undefined>>): void;
+    /** What a property is set to here, or `undefined` where it is not. */
+    get(name: string): string | undefined;
+    hostConnected(): void;
+    private write;
+}
+export {};

package/dist/controllers/placement-controller/placement-controller.js

@@ -0,0 +1,45 @@
+export class PlacementController {
+    constructor(host) {
+        this.host = host;
+        this.values = new Map();
+        host.addController(this);
+    }
+    set(properties) {
+        for (const [name, value] of Object.entries(properties)) {
+            if (value === undefined) {
+                this.values.delete(name);
+            }
+            else {
+                this.values.set(name, value);
+            }
+        }
+        this.write();
+    }
+    get(name) {
+        return this.values.get(name);
+    }
+    hostConnected() {
+        this.write();
+    }
+    write() {
+        const root = this.host.renderRoot;
+        if (!(typeof ShadowRoot !== 'undefined' && root instanceof ShadowRoot)) {
+            return;
+        }
+        if (typeof CSSStyleSheet === 'undefined' || !('replaceSync' in CSSStyleSheet.prototype)) {
+            return;
+        }
+        const text = `:host{${[...this.values].map(([name, value]) => `${name}:${value}`).join(';')}}`;
+        if (!this.sheet) {
+            this.sheet = new CSSStyleSheet();
+            root.adoptedStyleSheets = [...root.adoptedStyleSheets, this.sheet];
+        }
+        else if (!root.adoptedStyleSheets.includes(this.sheet)) {
+            root.adoptedStyleSheets = [...root.adoptedStyleSheets, this.sheet];
+        }
+        if (text !== this.written) {
+            this.sheet.replaceSync(text);
+            this.written = text;
+        }
+    }
+}

package/dist/index.d.ts

@@ -14,6 +14,7 @@ export { IndicatorController, type IndicatorOptions, } from './controllers/indic
 export { KeyboardNavigationController, type KeyboardNavigationOptions, type NavigableItem, } from './controllers/keyboard-navigation-controller/keyboard-navigation-controller.js';
 export { MediaSessionController, type SessionHandlers, SKIP_SECONDS, } from './controllers/media-session-controller/media-session-controller.js';
 export { MAX_FRAME_STEP, PaintGateController, type PaintGateOptions, } from './controllers/paint-gate-controller/paint-gate-controller.js';
+export { PlacementController } from './controllers/placement-controller/placement-controller.js';
 export { PopoverController, type PopoverOptions, } from './controllers/popover-controller/popover-controller.js';
 export { RemotePlaybackController, type RemoteReport, } from './controllers/remote-playback-controller/remote-playback-controller.js';
 export { SourceController, type SourceHost, } from './controllers/source-controller/source-controller.js';

package/dist/index.js

@@ -14,6 +14,7 @@ export { IndicatorController, } from './controllers/indicator-controller/indicat
 export { KeyboardNavigationController, } from './controllers/keyboard-navigation-controller/keyboard-navigation-controller.js';
 export { MediaSessionController, SKIP_SECONDS, } from './controllers/media-session-controller/media-session-controller.js';
 export { MAX_FRAME_STEP, PaintGateController, } from './controllers/paint-gate-controller/paint-gate-controller.js';
+export { PlacementController } from './controllers/placement-controller/placement-controller.js';
 export { PopoverController, } from './controllers/popover-controller/popover-controller.js';
 export { RemotePlaybackController, } from './controllers/remote-playback-controller/remote-playback-controller.js';
 export { SourceController, } from './controllers/source-controller/source-controller.js';

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@fusion.dev/helix-core",
   "description": "Helix element primitives: base classes, mixins, decorators, utilities.",
-  "version": "0.110.5",
+  "version": "0.111.0",
   "license": "MIT",
   "author": "Ross Sheppard <ross.sheppard@fusion.dev>",
   "repository": {
@@ -34,11 +34,11 @@
   "bugs": "https://github.com/project-fusion/fusion/issues",
   "dependencies": {
     "@floating-ui/dom": "^1.8.0",
-    "@fusion.dev/helix-icons": "0.110.5"
+    "@fusion.dev/helix-icons": "0.111.0"
   },
   "devDependencies": {
-    "@fusion.dev/helix-cem": "0.110.5",
-    "@fusion.dev/helix-testing": "0.110.5",
+    "@fusion.dev/helix-cem": "0.111.0",
+    "@fusion.dev/helix-testing": "0.111.0",
     "@lit-labs/ssr": "^4.1.0",
     "lit": "^3.2.1"
   },