List

class ui.list.List()

Provides a list view component for displaying sortable elements.

Index

Constructors

• constructor

Properties

• styles
• list
• selected

Methods

• updateContext
• updateSelected
• render

Constructors

ui.list.List.constructor()

List(): List

Returns: List

Properties

ui.list.List.styles

static

styles: CSSResult[]

Array of styles to apply to the element. The styles should be defined using the ? tag function, via constructible stylesheets, or imported from native CSS module scripts.

Note on Content Security Policy:

Element styles are implemented with <style> tags when the browser doesn’t support adopted StyleSheets. To use such <style> tags with the style-src CSP directive, the style-src value must either include ‘unsafe-inline’ or nonce-<base64-value> with <base64-value> replaced be a server-generated nonce.

To provide a nonce to use on generated <style> elements, set window.litNonce to a server-generated nonce in your page’s HTML, before loading application code:

<script>
  // Generated and unique per request:
  window.litNonce = 'a1b2c3d4';
</script>

ui.list.List.list

list: ContextWrapper

Context wrapper providing list data access methods. Reassign to trigger updates.

ui.list.List.selected

selected: number[]

Array of selected element keys. Reassign to trigger updates.

Methods

ui.list.List.updateContext()

updateContext(): void

Triggers a re-render by reassigning list context.

Returns: void

void

ui.list.List.updateSelected()

updateSelected(): void

Triggers a re-render by reassigning selected elements.

Returns: void

void

ui.list.List.render()

render(): unknown

Invoked on each update to perform rendering tasks. This method may return any value renderable by lit-html’s ChildPart - typically a TemplateResult. Setting properties inside this method will not trigger the element to update.

Returns: unknown