Misc

defaultConverter

value 永久链接到 defaultConverter 查看源码

导入

import { defaultConverter } from 'lit';

类型

ComplexAttributeConverter

isServer

value 永久链接到 isServer 查看源码

A boolean that will be true in server environments like Node, and false in browser environments. Note that your server environment or toolchain must support the "node" export condition for this to be true.

导入

import { isServer } from 'lit';

类型

false

详情

This can be used when authoring components to change behavior based on whether or not the component is executing in an SSR context.

LitUnstable

namespace 永久链接到 LitUnstable 查看源码

Contains types that are part of the unstable debug API.

导入

import { LitUnstable } from 'lit';

详情

Everything in this API is not stable and may change or be removed in the future, even on patch releases.

方法和属性

DebugLog

永久链接到 DebugLog 查看源码

When Lit is running in dev mode and window.emitLitDebugLogEvents is true, we will emit 'lit-debug' events to window, with live details about the update and render lifecycle. These can be useful for writing debug tooling and visualizations.

详情

Please be aware that running with window.emitLitDebugLogEvents has performance overhead, making certain operations that are normally very cheap (like a no-op render) much slower, because we must copy data and dispatch events.

notEqual

function 永久链接到 notEqual 查看源码

Change function that returns true if value is different from oldValue. This method is used as the default for a property's hasChanged function.

导入

import { notEqual } from 'lit';

签名

notEqual(value, old): boolean

参数

value
unknown
old
unknown

ReactiveUnstable

namespace 永久链接到 ReactiveUnstable 查看源码

Contains types that are part of the unstable debug API.

导入

import { ReactiveUnstable } from 'lit';

详情

Everything in this API is not stable and may change or be removed in the future, even on patch releases.

方法和属性

DebugLog

永久链接到 DebugLog 查看源码

When Lit is running in dev mode and window.emitLitDebugLogEvents is true, we will emit 'lit-debug' events to window, with live details about the update and render lifecycle. These can be useful for writing debug tooling and visualizations.

详情

Please be aware that running with window.emitLitDebugLogEvents has performance overhead, making certain operations that are normally very cheap (like a no-op render) much slower, because we must copy data and dispatch events.

TemplateInstance

class 永久链接到 TemplateInstance 查看源码

An updateable instance of a Template. Holds references to the Parts used to update the template instance.

导入

import { TemplateInstance } from 'lit';

方法和属性

new TemplateInstance(template, parent): TemplateInstance

永久链接到 constructor
参数
template
Template
parent
ChildPart

parentNode: Node

永久链接到 parentNode 查看源码

Unstable

namespace 永久链接到 Unstable 查看源码

Contains types that are part of the unstable debug API.

导入

import { Unstable } from 'lit';

详情

Everything in this API is not stable and may change or be removed in the future, even on patch releases.

方法和属性

DebugLog

永久链接到 DebugLog 查看源码

When Lit is running in dev mode and window.emitLitDebugLogEvents is true, we will emit 'lit-debug' events to window, with live details about the update and render lifecycle. These can be useful for writing debug tooling and visualizations.

详情

Please be aware that running with window.emitLitDebugLogEvents has performance overhead, making certain operations that are normally very cheap (like a no-op render) much slower, because we must copy data and dispatch events.

CompiledTemplate

type 永久链接到 CompiledTemplate 查看源码

导入

import { CompiledTemplate } from 'lit';

方法和属性

el?: MDN HTMLTemplateElement

永久链接到 el 查看源码

h: TrustedHTML

永久链接到 h 查看源码

parts: Array<TemplatePart>

永久链接到 parts 查看源码

CompiledTemplateResult

type 永久链接到 CompiledTemplateResult 查看源码

导入

import { CompiledTemplateResult } from 'lit';

方法和属性

values: Array<unknown>

永久链接到 values 查看源码

DirectiveParent

type 永久链接到 DirectiveParent 查看源码

导入

import { DirectiveParent } from 'lit';

Disconnectable

type 永久链接到 Disconnectable 查看源码

导入

import { Disconnectable } from 'lit';

HasChanged

type 永久链接到 HasChanged 查看源码

导入

import { HasChanged } from 'lit';

签名

HasChanged(value, old): boolean

参数

value
unknown
old
unknown

HTMLTemplateResult

type 永久链接到 HTMLTemplateResult 查看源码

导入

import { HTMLTemplateResult } from 'lit';

类型

TemplateResult<HTML_RESULT>

Initializer

type 永久链接到 Initializer 查看源码

导入

import { Initializer } from 'lit';

类型

(element: ReactiveElement) => void

PropertyValueMap

type 永久链接到 PropertyValueMap 查看源码

Do not use, instead prefer PropertyValues.

导入

import { PropertyValueMap } from 'lit';

方法和属性

delete(k): boolean

永久链接到 delete 查看源码
参数
k
K

get(k): undefined | T[K]

永久链接到 get 查看源码
参数
k
K

has(k): boolean

永久链接到 has 查看源码
参数
k
K

set(key, value): PropertyValueMap<T>

永久链接到 set 查看源码
参数
key
K
value
T[K]

RootPart

type 永久链接到 RootPart 查看源码

A top-level ChildPart returned from render that manages the connected state of AsyncDirectives created throughout the tree below it.

导入

import { RootPart } from 'lit';

方法和属性

readonly options: undefined | RenderOptions

永久链接到 options 查看源码

readonly type: 2

永久链接到 type 查看源码

endNode: null | Node

永久链接到 endNode 查看源码

The part's trailing marker node, if any. See .parentNode for more information.

parentNode: Node

永久链接到 parentNode 查看源码

The parent node into which the part renders its content.

详情

A ChildPart's content consists of a range of adjacent child nodes of .parentNode, possibly bordered by 'marker nodes' (.startNode and .endNode).

  • If both .startNode and .endNode are non-null, then the part's content consists of all siblings between .startNode and .endNode, exclusively.
  • If .startNode is non-null but .endNode is null, then the part's content consists of all siblings following .startNode, up to and including the last child of .parentNode. If .endNode is non-null, then .startNode will always be non-null.
  • If both .endNode and .startNode are null, then the part's content consists of all child nodes of .parentNode.

startNode: null | Node

永久链接到 startNode 查看源码

The part's leading marker node, if any. See .parentNode for more information.

setConnected(isConnected): void

永久链接到 setConnected 查看源码

Sets the connection state for AsyncDirectives contained within this root ChildPart.

参数
isConnected
boolean

Whether directives within this tree should be connected or not

详情

lit-html does not automatically monitor the connectedness of DOM rendered; as such, it is the responsibility of the caller to render to ensure that part.setConnected(false) is called before the part object is potentially discarded, to ensure that AsyncDirectives have a chance to dispose of any resources being held. If a RootPart that was previously disconnected is subsequently re-connected (and its AsyncDirectives should re-connect), setConnected(true) should be called.

ValueSanitizer

type 永久链接到 ValueSanitizer 查看源码

A function which can sanitize values that will be written to a specific kind of DOM sink.

导入

import { ValueSanitizer } from 'lit';

类型

(value: unknown) => unknown

详情

See SanitizerFactory.

WarningKind

type 永久链接到 WarningKind 查看源码

A string representing one of the supported dev mode warning categories.

导入

import { WarningKind } from 'lit';

类型

"change-in-update" | "migration"