Skip to content

@pgege/kaboo-react


Interface: DrillState

Defined in: types.ts:196

Drill-down navigation state: the current path into the activity tree plus the actions to move through it. Exposed by useDrill.

Properties

activeDrill

activeDrill: string | null

Defined in: types.ts:200

The deepest group id in the path, or null at the root.


drillIn

drillIn: (groupId) => void

Defined in: types.ts:202

Push a group id, descending one level.

Parameters

groupId

string

Returns

void


drillPath

drillPath: string[]

Defined in: types.ts:198

Group ids from root to the current level.


drillToLevel

drillToLevel: (level) => void

Defined in: types.ts:208

Trim the path to level (0-based), jumping to a breadcrumb.

Parameters

level

number

Returns

void


drillToRoot

drillToRoot: () => void

Defined in: types.ts:206

Clear the path, returning to the root.

Returns

void


drillUp

drillUp: () => void

Defined in: types.ts:204

Pop the last group id, ascending one level.

Returns

void