context.renderLabel

How to read this API

These are TypeScript APIs compiled into SnapTeX; a .tex project cannot load them at runtime.

• function name(...) is a helper that your rule imports and calls.
• apply(...), render(...), extract(...), and collect(...) are callbacks that your rule implements and SnapTeX calls.
• renderer.name(...), context.name(...), input.name(...), and deps.name(...) are methods SnapTeX supplies to callbacks; do not import or construct them.
• service.name(...) is an instance method called after your host or test constructs PreviewUpdateService.

Register extension declarations through SNAP_TEX_RULES in src/rules.ts. See Source API Scope for imports, value ownership, output safety, rebuilds, and testing.

Creates the hidden preview anchor for a LaTeX label. Call it from an AST rule that owns a labeled structure and must expose a target to references and source synchronization.

Signature

context.renderLabel(label: string): string

Returns

Direct HTML for a hidden anchor whose ID and data-label are safely escaped.

Call relationships

• Called by: AST label and labeled-structure rules.
• Provides targets for: references, preview navigation, and tooltips.
• Does not: assign numbering by itself.

const anchor = context.renderLabel('sec:introduction');

See also

• context.renderRef