uxml-preview 0.6.1 → 0.7.0

package/dist/index.d.ts

@@ -1,3 +1,4 @@
+import { Theme } from './controls/theme';
 import { NodeId, UxmlDocument, Warning } from './model/types';
 import { ComputedStyle, ResolveResult } from './style/resolve';
 import { LayoutBox, MeasureText } from './layout/yoga';
@@ -10,6 +11,7 @@ import { ResolveFont } from './render/fonts';
  * See docs/ROADMAP.md.
  */
 export type { Span, SourceRef, NodeId, ElementName, Attribute, ElementSpans, ElementNode, Combinator, SimpleSelector, SelectorPart, Selector, Declaration, Rule, SheetItem, StyleSheet, WarningKind, WarningKindMap, WarningReason, WarningSubject, Warning, UxmlDocument, StyleOrigin, } from './model/types';
+export type { Theme } from './controls/theme';
 export { collectDependencies, expandTemplates, TEMPLATE_DEPTH_LIMIT } from './template/expand';
 export type { TemplateExpansion, TemplateResolver } from './template/expand';
 export { loadLayoutEngine, isLayoutEngineReady, liveNodeCount } from './layout/yoga';
@@ -76,6 +78,14 @@ export declare function serialize(doc: UxmlDocument): {
     uss: string;
 };
 export interface RenderOptions {
+    /**
+     * Defaults to 'runtime' since 0.7.0 (Unity's PanelSettings runtime theme).
+     * 'editor' is Unity's dark editor theme, used for the published 662/676 figure.
+     * The core draws no panel background (transparent, as Unity does). Runtime
+     * text is dark (#1b1b1b), so hosts drawing on a dark backdrop must provide
+     * a panel background.
+     */
+    theme?: Theme;
     /** Resolves font assets once per distinct path and form in each render. */
     resolveFont?: ResolveFont;
     /**
@@ -127,6 +137,8 @@ export interface RenderOptions {
 export { classifyVisibility } from './render/visibility';
 export type { Visibility } from './render/visibility';
 export interface RenderResult {
+    /** The theme actually drawn, after option validation. */
+    theme: Theme;
     /** Expanded document used for rendering, separate from the source AST. */
     document?: UxmlDocument;
     /** Computed styles keyed by rendered element id. */