eleva 1.0.1 → 1.1.0

package/types/plugins/Attr.d.ts

@@ -3,27 +3,94 @@ export namespace AttrPlugin {
     let version: string;
     let description: string;
     /**
-     * Installs the plugin into the Eleva instance
+     * Installs the plugin into the Eleva instance.
      *
-     * @param {Object} eleva - The Eleva instance
-     * @param {Object} options - Plugin configuration options
-     * @param {boolean} [options.enableAria=true] - Enable ARIA attribute handling
-     * @param {boolean} [options.enableData=true] - Enable data attribute handling
-     * @param {boolean} [options.enableBoolean=true] - Enable boolean attribute handling
-     * @param {boolean} [options.enableDynamic=true] - Enable dynamic property detection
+     * @public
+     * Method wrapping behavior:
+     * - Stores original `_patchNode` in `renderer._originalPatchNode`
+     * - Overrides `renderer._patchNode` to use enhanced attribute handling
+     * - Adds `renderer.updateAttributes` and `eleva.updateElementAttributes` helpers
+     * - Call `uninstall()` to restore original behavior
+     *
+     * @param {Eleva} eleva - The Eleva instance to enhance.
+     * @param {AttrPluginOptions} options - Plugin configuration options.
+     * @param {boolean} [options.enableAria=true] - Enable ARIA attribute handling.
+     *        Maps aria-* attributes to DOM properties (e.g., aria-expanded → ariaExpanded).
+     * @param {boolean} [options.enableData=true] - Enable data attribute handling.
+     *        Syncs data-* attributes with element.dataset for consistent access.
+     * @param {boolean} [options.enableBoolean=true] - Enable boolean attribute handling.
+     *        Treats empty strings and attribute names as true, "false" string as false.
+     * @param {boolean} [options.enableDynamic=true] - Enable dynamic property detection.
+     *        Searches element prototype chain for property matches (useful for custom elements).
+     * @returns {void}
+     * @example
+     * // Basic installation with defaults
+     * app.use(AttrPlugin);
+     *
+     * @example
+     * // Custom configuration
+     * app.use(AttrPlugin, {
+     *   enableAria: true,
+     *   enableData: true,
+     *   enableBoolean: true,
+     *   enableDynamic: false  // Disable for performance
+     * });
+     *
+     * @example
+     * // Using ARIA attributes in templates
+     * template: (ctx) => `
+     *   <div role="dialog" aria-modal="true" aria-labelledby="title">
+     *     <h2 id="title">Modal Title</h2>
+     *     <button aria-expanded="${ctx.isOpen.value}">Toggle</button>
+     *   </div>
+     * `
+     * @see uninstall - Remove the plugin and restore original behavior.
      */
-    function install(eleva: Object, options?: {
-        enableAria?: boolean | undefined;
-        enableData?: boolean | undefined;
-        enableBoolean?: boolean | undefined;
-        enableDynamic?: boolean | undefined;
-    }): void;
+    function install(eleva: Eleva, options?: AttrPluginOptions): void;
     /**
-     * Uninstalls the plugin from the Eleva instance
+     * Uninstalls the plugin from the Eleva instance.
      *
-     * @param {Object} eleva - The Eleva instance
+     * @public
+     * @param {Eleva} eleva - The Eleva instance.
+     * @returns {void}
+     * @description
+     * Restores the original renderer patching behavior and removes
+     * `eleva.updateElementAttributes`.
+     * @example
+     * // Uninstall the plugin
+     * AttrPlugin.uninstall(app);
+     * @see install - Install the plugin.
      */
-    function uninstall(eleva: Object): void;
+    function uninstall(eleva: Eleva): void;
 }
 export { AttrPlugin as Attr };
+/**
+ * Type imports from the Eleva core library.
+ */
+export type Eleva = import("eleva").Eleva;
+/**
+ * Configuration options for the AttrPlugin.
+ */
+export type AttrPluginOptions = {
+    /**
+     * Enable ARIA attribute handling.
+     */
+    enableAria?: boolean | undefined;
+    /**
+     * Enable data attribute handling.
+     */
+    enableData?: boolean | undefined;
+    /**
+     * Enable boolean attribute handling.
+     */
+    enableBoolean?: boolean | undefined;
+    /**
+     * Enable dynamic property detection.
+     */
+    enableDynamic?: boolean | undefined;
+};
+/**
+ * Function signature for attribute update operations.
+ */
+export type AttributeUpdateFunction = (oldEl: HTMLElement, newEl: HTMLElement) => void;
 //# sourceMappingURL=Attr.d.ts.map

package/types/plugins/Attr.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"Attr.d.ts","sourceRoot":"","sources":["../../src/plugins/Attr.js"],"names":[],"mappings":";cAyCY,MAAM;iBAMN,MAAM;qBAMN,MAAM;IAIhB;;;;;;;;;OASG;IACH,wBAPW,MAAM,YAEd;QAA0B,UAAU;QACV,UAAU;QACV,aAAa;QACb,aAAa;KACzC,QA8JA;IAED;;;;OAIG;IACH,0BAFW,MAAM,QAgBhB"}
+{"version":3,"file":"Attr.d.ts","sourceRoot":"","sources":["../../src/plugins/Attr.js"],"names":[],"mappings":";cAmFY,MAAM;iBAMN,MAAM;qBAMN,MAAM;IAIhB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA2CG;IACH,wBAlCW,KAAK,YACL,iBAAiB,GASf,IAAI,CAsMhB;IAED;;;;;;;;;;;;;OAaG;IACH,0BAVW,KAAK,GACH,IAAI,CAuBhB;;;;;;oBA1UU,OAAO,OAAO,EAAE,KAAK;;;;;;;;;;;;;;;;;;;;;;;;;sCAuBrB,CAAC,KAAK,EAAE,WAAW,EAAE,KAAK,EAAE,WAAW,KAAK,IAAI"}