react-querybuilder/dist/types-esm/types/props.d.mts

React Query Builder component for constructing queries and filters, with utilities for executing them in various database and evaluation contexts

import type { Classname, Path } from "./basic.mjs";
import type { RuleGroupType, RuleType } from "./ruleGroups.mjs";
import type { RuleGroupTypeAny } from "./ruleGroupsIC.mjs";
/**
* Base interface for all rule subcomponents.
*
* @group Props
*/
export interface CommonRuleSubComponentProps {
	rule: RuleType;
}
/**
* Classnames applied to each component.
*
* @group Props
*/
export interface Classnames {
	/**
	* Classnames applied to the root `<div>` element.
	*/
	queryBuilder: Classname;
	/**
	* Classnames applied to the `<div>` containing the RuleGroup.
	*/
	ruleGroup: Classname;
	/**
	* Classnames applied to the `<div>` containing the RuleGroup header controls.
	*/
	header: Classname;
	/**
	* Classnames applied to the `<div>` containing the RuleGroup child rules/groups.
	*/
	body: Classname;
	/**
	* Classnames applied to the `<select>` control for combinators.
	*/
	combinators: Classname;
	/**
	* Classnames applied to the `<button>` to add a Rule.
	*/
	addRule: Classname;
	/**
	* Classnames applied to the `<button>` to add a RuleGroup.
	*/
	addGroup: Classname;
	/**
	* Classnames applied to the `<button>` to clone a Rule.
	*/
	cloneRule: Classname;
	/**
	* Classnames applied to the `<button>` to clone a RuleGroup.
	*/
	cloneGroup: Classname;
	/**
	* Classnames applied to the `<button>` to remove a RuleGroup.
	*/
	removeGroup: Classname;
	/**
	* Classnames applied to the `<div>` containing the Rule.
	*/
	rule: Classname;
	/**
	* Classnames applied to the `<select>` control for fields.
	*/
	fields: Classname;
	/**
	* Classnames applied to the `<select>` control for match modes.
	*/
	matchMode: Classname;
	/**
	* Classnames applied to the `<input>` for match thresholds.
	*/
	matchThreshold: Classname;
	/**
	* Classnames applied to the `<select>` control for operators.
	*/
	operators: Classname;
	/**
	* Classnames applied to the `<input>` for the rule value.
	*/
	value: Classname;
	/**
	* Classnames applied to the `<button>` to remove a Rule.
	*/
	removeRule: Classname;
	/**
	* Classnames applied to the `<label>` on the "not" toggle.
	*/
	notToggle: Classname;
	/**
	* Classnames applied to the `<span>` handle for dragging rules/groups.
	*/
	shiftActions: Classname;
	/**
	* Classnames applied to the `<span>` handle for dragging rules/groups.
	*/
	dragHandle: Classname;
	/**
	* Classnames applied to the `<button>` to lock/disable a Rule.
	*/
	lockRule: Classname;
	/**
	* Classnames applied to the `<button>` to lock/disable a RuleGroup.
	*/
	lockGroup: Classname;
	/**
	* Classnames applied to the `<select>` control for value sources.
	*/
	valueSource: Classname;
	/**
	* Classnames applied to all action elements.
	*/
	actionElement: Classname;
	/**
	* Classnames applied to all select elements.
	*/
	valueSelector: Classname;
	/**
	* Classname(s) applied to inline combinator elements.
	*/
	betweenRules: Classname;
	/**
	* Classname(s) applied to valid rules and groups.
	*/
	valid: Classname;
	/**
	* Classname(s) applied to invalid rules and groups.
	*/
	invalid: Classname;
	/**
	* Classname(s) applied to rules and groups while being dragged.
	*/
	dndDragging: Classname;
	/**
	* Classname(s) applied to rules and groups hovered over by a dragged element.
	*/
	dndOver: Classname;
	/**
	* Classname(s) applied to rules and groups hovered over by a dragged element
	* when the drop effect is "copy" (modifier key is pressed).
	*/
	dndCopy: Classname;
	/**
	* Classname(s) applied to rules and groups hovered over by a dragged element
	* when the Ctrl key is pressed, indicating the items will form a new group.
	*/
	dndGroup: Classname;
	/**
	* Classname(s) applied to disabled elements.
	*/
	disabled: Classname;
	/**
	* Classname(s) applied to each element in a series of value editors.
	*/
	valueListItem: Classname;
	/**
	* Not applied, but see CSS styles.
	*/
	branches: Classname;
	/**
	* Classname(s) rules that render a subquery.
	*/
	hasSubQuery: Classname;
}
/**
* Functions included in the `actions` prop passed to every subcomponent.
*
* @group Props
*/
export interface QueryActions {
	onGroupAdd(group: RuleGroupTypeAny, parentPath: Path, context?: any): void;
	onGroupRemove(path: Path): void;
	onPropChange(prop: Exclude<keyof RuleType | keyof RuleGroupType, "id" | "path">, value: any, path: Path, context?: any): void;
	onRuleAdd(rule: RuleType, parentPath: Path, context?: any): void;
	onRuleRemove(path: Path): void;
	moveRule(oldPath: Path, newPath: Path | "up" | "down", clone?: boolean, context?: any): void;
	groupRule(sourcePath: Path, targetPath: Path, clone?: boolean, context?: any): void;
}