Interface EnhancerDefinition<Options, Api>

Declarative description of an enhancer, passed to defineEnhancer.

interface EnhancerDefinition<
    Options extends object = Record<string, never>,
    Api = null,
> {
    attributes?: AttributeSchema<Options>;
    defaults?: Options;
    name: string;
    selector: string;
    setup: (ctx: EnhancerContext<Options>) => void | Api;
}

Type Parameters

Options extends object = Record<string, never>
Api = null

Index

Properties

attributes? defaults? name selector setup

Properties

`Optional`attributes

attributes?: AttributeSchema<Options>

Options that markup can set through data-hl-* attributes on the root.

`Optional`defaults

defaults?: Options

Default options merged under caller-provided options.

name

name: string

Stable name, used for generated ids and the auto-loader manifest.

selector

selector: string

CSS selector identifying each component root.

setup

setup: (ctx: EnhancerContext<Options>) => void | Api

Wire behavior for a single root. May return the instance's public API.