@v4fire/client/src/base/b-tree/interface.ts

V4Fire client core library

/*!
 * V4Fire Client Core
 * https://github.com/V4Fire/Client
 *
 * Released under the MIT license
 * https://github.com/V4Fire/Client/blob/master/LICENSE
 */

import type bTree from 'base/b-tree/b-tree';
import type { TaskI, ModsTable } from 'base/b-tree/b-tree';
import type { Item as Super } from 'traits/i-active-items/i-active-items';

/**
 * Tree element data
 */
export interface Item extends Super {
	/**
	 * Item value
	 */
	value: unknown;

	/**
	 * Parent element value
	 * (for nested items)
	 */
	parentValue?: Item['value'];

	/**
	 * Nested items
	 */
	children?: Item[];

	/**
	 * Folding flag
	 */
	folded?: boolean;

	/**
	 * Map of additional modifiers of the item
	 */
	mods?: ModsTable;
}

export type Items = Item[];

export interface RenderFilter {
	(ctx: bTree, el: Item, i: number, task: TaskI): CanPromise<boolean>;
}