@arcgis/lumina 5.2.0-next.2 → 5.2.0-next.21

package/dist/jsx/directives.d.ts

@@ -1,16 +1,13 @@
-import { nil } from '@arcgis/toolkit/type';
-import { Properties as CssProperties } from 'csstype';
-import { ClassInfo, ClassMapDirective } from 'lit/directives/class-map.js';
-import { DirectiveResult, DirectiveClass, ElementPart, PartInfo, Directive } from 'lit/directive.js';
-import { StyleMapDirective } from 'lit/directives/style-map.js';
-import { noChange } from 'lit';
-import { CustomAttributes } from './baseTypes.ts';
-import { RefDirective } from 'lit/directives/ref.js';
+import type { Properties as CssProperties } from "csstype";
+import type { ClassInfo, ClassMapDirective } from "lit/directives/class-map.js";
+import type { DirectiveResult, DirectiveClass } from "lit/directive.js";
+import type { StyleMapDirective } from "lit/directives/style-map.js";
+import type { CustomAttributes } from "./baseTypes.js";
+
 /**
  * You likely won't have to import this directly. It will be added during
  * _JSX to lit-html_ conversion.
  *
- * @remarks
  * In JSX we allow both of the following:
  * ```tsx
  * const myString = "foo";
@@ -28,14 +25,15 @@ import { RefDirective } from 'lit/directives/ref.js';
  * ternary expression or etc, the `safeClassMap` will be called, which will
  * determine at runtime if directive should be called
  *
- * @private
+ * @param parameters
+ * @internal
  */
-export declare const safeClassMap: (parameters: ClassInfo | nil | string) => DirectiveResult<typeof ClassMapDirective> | nil | string;
+export function safeClassMap(parameters: ClassInfo | null | undefined | string): DirectiveResult<typeof ClassMapDirective> | null | undefined | string;
+
 /**
  * You likely won't have to import this directly. It will be added during
  * _JSX to lit-html_ conversion.
  *
- * @remarks
  * In JSX we allow both of the following:
  * ```tsx
  * const myString = "font-size:'2px'";
@@ -53,30 +51,27 @@ export declare const safeClassMap: (parameters: ClassInfo | nil | string) => Dir
  * ternary expression or etc, the `safeStyleMap` will be called, which will
  * determine at runtime if directive should be called
  *
- * @private
+ * @param parameters
+ * @internal
  */
-export declare const safeStyleMap: (parameters: CssProperties | nil | string) => DirectiveResult<typeof StyleMapDirective> | nil | string;
-declare class DeferLoad extends Directive {
-    update(part: ElementPart): void;
-    render(): typeof noChange;
-}
+export function safeStyleMap(parameters: CssProperties | null | undefined | string): DirectiveResult<typeof StyleMapDirective> | null | undefined | string;
+
 /**
- * @private
  * Do not use this directive directly. Use the `deferLoad` JSX prop instead.
  * [Documentation](https://webgis.esri.com/references/lumina/jsx#deferring-web-component-load)
+ *
+ * @internal
  */
-export declare const deferLoad: DirectiveResult<typeof DeferLoad>;
+export const deferLoad: DirectiveResult;
+
 /**
- * @private
  * Do not use this directly. Use the `deferLoad` JSX prop instead.
  * [Documentation](https://webgis.esri.com/references/lumina/jsx#deferring-web-component-load)
+ *
+ * @internal
  */
-export declare const deferredLoaders: Map<string, () => Promise<unknown>>;
-declare class StabilizedRef extends Directive {
-    #private;
-    constructor(partInfo: PartInfo);
-    render(refValue: CustomAttributes<Element>["ref"]): DirectiveResult<typeof RefDirective>;
-}
+export const deferredLoaders: Map<string, () => Promise<unknown>>;
+
 /**
  * Because of how Lit's ref() works, there are two requirements on ref
  * function:
@@ -89,34 +84,27 @@ declare class StabilizedRef extends Directive {
  * The `stabilizedRef` directive resolves both of these requirements by creating
  * a stable wrapper function for the ref callback.
  *
- * @private
- * Lumina will insert this directive automatically when the `ref` JSX prop is
- * authored in a way that clearly creates a new function on each render:
- * ```tsx
- * <my-component ref={(el) => this.myComponent = el} />
- * <my-component ref={this.callback.bind(this, index)} />
- * ```
  * @deprecated See https://discord.com/channels/1012791295170859069/1047015641225371718
+ * @internal
  */
-export declare const stabilizedRef: <T extends Element>(refValue: CustomAttributes<T>["ref"]) => DirectiveResult<typeof StabilizedRef>;
+export const stabilizedRef: <T extends Element>(refValue: CustomAttributes<T>["ref"]) => DirectiveResult;
+
 /**
  * Creates a user-facing directive function from a Directive class. This
  * function has the same parameters as the directive's render() method.
  *
- * @remarks
  * This is equivalent to Lit's native "directive()", but has return type
  * "never" to allow it be set as a value for any JSX attribute.
  */
-export declare const directive: <C extends DirectiveClass>(c: C) => (...values: Parameters<InstanceType<C>["render"]>) => never;
+export const directive: <C extends DirectiveClass>(c: C) => (...values: Parameters<InstanceType<C>["render"]>) => never;
+
 /**
  * Checks binding values against live DOM values, instead of previously bound
  * values, when determining whether to update the value.
  *
- * @see https://lit.dev/docs/templates/directives/#live
- *
- * @remarks
  * This is equivalent to Lit's native "directive()", but has return type
  * "never" to allow it be set as a value for any JSX attribute.
+ *
+ * @see https://lit.dev/docs/templates/directives/#live
  */
-export declare const live: (value: unknown) => never;
-export {};
+export const live: (value: unknown) => never;