@itwin/presentation-common
Version:
Common pieces for iModel.js presentation packages
55 lines • 2.6 kB
TypeScript
/** @packageDocumentation
* @module PresentationRules
*/
import { CustomizationRule } from "../customization/CustomizationRule.js";
import { RuleBase } from "../Rule.js";
import { ChildNodeRule } from "./ChildNodeRule.js";
import { ChildNodeSpecification } from "./ChildNodeSpecification.js";
import { RootNodeRule } from "./RootNodeRule.js";
import { SubCondition } from "./SubCondition.js";
/**
* Base class for all [[NavigationRule]] implementations.
*
* @see [Hierarchies reference documentation page]($docs/presentation/hierarchies/index.md)
* @public
* @deprecated in 5.2 - will not be removed until after 2026-10-01. Use the new [@itwin/presentation-hierarchies](https://github.com/iTwin/presentation/blob/master/packages/hierarchies/README.md)
* package for creating hierarchies.
*/
export interface NavigationRuleBase extends RuleBase {
/**
* Defines a condition which needs to be met in order for the rule to be used. The condition is an
* [ECExpression]($docs/presentation/hierarchies/ECExpressions.md#rule-condition) which has to evaluate
* to a boolean value.
*/
condition?: string;
/**
* A list of hierarchy specifications that define what nodes are going to be returned.
*/
specifications?: ChildNodeSpecification[];
/**
* A list of [customization rules]($docs/presentation/hierarchies/index.md#hierarchy-customization) that
* apply only to nodes produced by this rule.
*/
customizationRules?: CustomizationRule[];
/**
* A list of sub-rules which share *placement attributes* and
* [nested customization rules]($docs/presentation/hierarchies/ChildNodeRule.md#attribute-customizationrules)
* of the hierarchy rule. This means the attributes of hierarchy rule are still in effect and the sub-rules
* can add additional condition of their own.
*/
subConditions?: SubCondition[];
/**
* Stop processing rules that have lower priority. Used in cases when recursion suppression is needed.
*/
stopFurtherProcessing?: boolean;
}
/**
* Navigation rules are used to define hierarchies displayed in tree components.
*
* @see [Hierarchies reference documentation page]($docs/presentation/hierarchies/index.md)
* @public
* @deprecated in 5.2 - will not be removed until after 2026-10-01. Use the new [@itwin/presentation-hierarchies](https://github.com/iTwin/presentation/blob/master/packages/hierarchies/README.md)
* package for creating hierarchies.
*/
export type NavigationRule = RootNodeRule | ChildNodeRule;
//# sourceMappingURL=NavigationRule.d.ts.map