package.src.lit.renderer-directives.d.ts Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of multi-select-combo-box Show documentation

vaadin-multi-select-combo-box

There is a newer version: 24.4.10

Show newest version

/**
 * @license
 * Copyright (c) 2017 - 2024 Vaadin Ltd.
 * This program is available under Apache License Version 2.0, available at https://vaadin.com/license/
 */
import type { DirectiveResult } from 'lit/directive.js';
import type { ComboBoxItemModel } from '@vaadin/combo-box/src/vaadin-combo-box.js';
import type { LitRendererResult } from '@vaadin/lit-renderer';
import { LitRendererDirective } from '@vaadin/lit-renderer';
import type { MultiSelectComboBox } from '../vaadin-multi-select-combo-box.js';

export type MultiSelectComboBoxLitRenderer = (
  item: TItem,
  model: ComboBoxItemModel,
  comboBox: MultiSelectComboBox,
) => LitRendererResult;

export class MultiSelectComboBoxRendererDirective extends LitRendererDirective<
  MultiSelectComboBox,
  MultiSelectComboBoxLitRenderer
> {
  /**
   * Adds the renderer callback to the combo-box.
   */
  addRenderer(): void;

  /**
   * Runs the renderer callback on the combo-box.
   */
  runRenderer(): void;

  /**
   * Removes the renderer callback from the combo-box.
   */
  removeRenderer(): void;
}

/**
 * A Lit directive for rendering the content of the `` elements.
 *
 * The directive accepts a renderer callback returning a Lit template and assigns it to the combo-box
 * via the `renderer` property. The renderer is called for each combo-box item when assigned
 * and whenever a single dependency or an array of dependencies changes.
 * It is not guaranteed that the renderer will be called immediately (synchronously) in both cases.
 *
 * Dependencies can be a single value or an array of values.
 * Values are checked against previous values with strict equality (`===`),
 * so the check won't detect nested property changes inside objects or arrays.
 * When dependencies are provided as an array, each item is checked against the previous value
 * at the same index with strict equality. Nested arrays are also checked only by strict
 * equality.
 *
 * Example of usage:
 * ```js
 * ` html`...`)}
 * >`
 * ```
 *
 * @param renderer the renderer callback that returns a Lit template.
 * @param dependencies a single dependency or an array of dependencies
 *                     which trigger a re-render when changed.
 */
export declare function multiSelectComboBoxRenderer(
  renderer: MultiSelectComboBoxLitRenderer,
  dependencies?: unknown,
): DirectiveResult;