uxml-preview 0.1.0 → 0.3.0

package/dist/index.d.ts

@@ -11,12 +11,14 @@ export type { Span, SourceRef, NodeId, ElementName, Attribute, ElementSpans, Ele
 export { loadLayoutEngine, isLayoutEngineReady, liveNodeCount } from './layout/yoga';
 export type { LayoutBox, MeasureText, TextContext, TextMetrics } from './layout/yoga';
 export { createDefaultMeasureText } from './render/measure';
-export { NODE_ATTRIBUTE } from './render/paint';
+export { NODE_ATTRIBUTE, PART_ATTRIBUTE, PART_OWNER_ATTRIBUTE } from './render/paint';
 export { supportedControlNames } from './controls/registry';
 export { resolveStyles, explainProperty } from './style/resolve';
 export type { Candidate, ComputedStyle, ComputedValue, ResolveOptions, ResolveResult, } from './style/resolve';
 export type { Specificity } from './style/specificity';
 export { isInherited } from './style/properties';
+export { KNOWN_DIVERGENCES } from './known-divergences';
+export type { KnownDivergence } from './known-divergences';
 /**
  * Parse UXML and USS text into a document model.
  *
@@ -26,12 +28,15 @@ export { isInherited } from './style/properties';
  */
 export interface ParseOptions {
     /**
-     * Loads the text of an `@import`ed stylesheet. Return `null` when the path
-     * cannot be resolved; the import is then reported as a warning and its rules
+     * Loads the text of a stylesheet the document refers to. Return `null` when
+     * the path cannot be resolved; it is then reported as a warning and its rules
      * simply do not participate.
      *
-     * USS import paths look like `project://database/Assets/UI/base.uss`, which
-     * only the host application knows how to turn into file contents.
+     * Used for both ways a document can name a stylesheet — `@import` inside USS,
+     * and `<Style src="…">` inside UXML. Both quote paths like
+     * `project://database/Assets/UI/base.uss`, which only the host application
+     * knows how to turn into file contents, and there is no reason for a host to
+     * implement that lookup twice.
      */
     resolveImport?: (url: string) => string | null;
 }
@@ -54,8 +59,15 @@ export interface RenderOptions {
      * USS background images look like `url("project://database/Assets/foo.png")`
      * or `resource("foo")`. Browsers cannot load these, so the host application
      * must map them to real URLs. Return `null` to draw a placeholder instead.
+     *
+     * `form` says which of the two `path` came from — `'url'` is a path
+     * (project-relative or absolute), `'resource'` is a Unity Resources-folder
+     * name (no extension, resolved by Unity's own lookup rules). They are not
+     * interchangeable: a host that ignores `form` and resolves both as file
+     * paths will resolve `resource("foo")` against whatever happens to sit at
+     * that path — the wrong image, silently, if one exists there at all.
      */
-    resolveAsset?: (path: string) => string | null;
+    resolveAsset?: (path: string, form: 'url' | 'resource') => string | null;
     /** Panel size in pixels. Defaults to the container's client size. */
     size?: {
         width: number;
@@ -69,14 +81,30 @@ export interface RenderOptions {
      * above all — should supply its own.
      */
     measureText?: MeasureText;
-    /** Pseudo-classes to render as active, e.g. `new Set(['hover'])`. */
+    /** Pseudo-classes to render as active on every element, e.g. `new Set(['hover'])`. */
     activeStates?: ReadonlySet<string>;
+    /**
+     * Pseudo-classes to render as active per element, keyed by USS selector.
+     *
+     * ```ts
+     * render(doc, el, { states: { '#UseButton': ['hover'], '#DropButton': ['disabled'] } });
+     * ```
+     *
+     * States are explicit input rather than real mouse events, so the same call
+     * always draws the same picture — which is what makes a rendered screen
+     * something you can compare against Unity, or against yesterday.
+     *
+     * Per element and not per document because real screens mix: one button
+     * hovered while another is disabled is the normal case, not an edge one.
+     */
+    states?: Readonly<Record<string, readonly string[]>>;
 }
 export interface RenderResult {
     /**
      * Everything the renderer could not honour: unsupported controls, properties,
      * selectors and units, plus unresolved assets. Distinct from
-     * `UxmlDocument.warnings`, which only covers malformed input.
+     * `UxmlDocument.warnings`, which covers malformed input and unresolved
+     * `<Style src="…">` / `@import` references rather than render-time support.
      */
     warnings: readonly Warning[];
     /** Painted element per model node. Lets a host map a click back to the tree. */