Event types

PibblClipboardEvent

PibblClipboardEvent is the logical facade for clipboard events and carries the same cancellation and propagation controls as the base Pibbl event.

PibblCompositionEvent

PibblCompositionEvent is the logical facade for composition lifecycle events.

PibblDragEvent

PibblDragEvent is the logical facade for drag-and-drop events.

PibblDragHandleProps

Supplies a controller, optional children, and a position formatter receiving applied left and top. Descendant hit areas determine where dragging can begin.

PibblDragHandleStyle

Ordinary Group-like presentation and layout participation, plus optional readout styling. Width and height do not manufacture an interaction rectangle.

PibblEvent

PibblEvent is the base logical event facade. It exposes propagation phase, target/current target, cancellation, and logical related-target information.

PibblEventCapturePropName

PibblEventCapturePropName is the typed union of supported onXCapture prop names for capture-phase listeners.

PibblEventHandler

PibblEventHandler is the generic callback contract for a selected event facade.

PibblEventHandlers

PibblEventHandlers maps every supported onX and onXCapture property to its specific logical event-handler type.

PibblEventMap

PibblEventMap maps supported event-type strings to their corresponding facade types for generic event code.

PibblEventParticipationOptions

PibblEventParticipationOptions supplies the shared optional pointerEvents property used by drawing primitives and external render layers.

PibblEventPhase

PibblEventPhase represents the capture, target, and bubble phases of Pibbl’s logical propagation path.

PibblEventPropName

PibblEventPropName is the typed union of supported bubbling onX prop names.

PibblEventTarget

PibblEventTarget is Pibbl’s opaque logical-target interface, distinct from a DOM EventTarget and derived from Pibbl’s geometric paint ledger.

PibblEventTargetOptions

PibblEventTargetOptions configures path, fill/stroke hit geometry, cursor, focus behavior, and optional navigation bounds for a logical target.

PibblEventTargetSnapshot

PibblEventTargetSnapshot exposes the current logical focus state returned by useEventTarget during render.

PibblEventType

PibblEventType is the union of supported logical event-type strings.

PibblFocusEvent

PibblFocusEvent is the logical facade for focus and blur transitions. It is available only when a FocusManagement policy is active.

PibblInputEvent

PibblInputEvent is the logical facade for input events on an eligible target.

PibblKeyboardEvent

PibblKeyboardEvent is the logical facade for keyboard events delivered through the Canvas focus host and logical focus target.

PibblKeyboardNavigationOptions

PibblKeyboardNavigationOptions configures the supported directional keyboard navigation policy. Its mode is exactly "directional" and it requires focus management.

PibblLogicalMouseEvent

PibblLogicalMouseEvent is the geometry-targeted mouse facade with root-logical coordinates.

PibblManipulableProps

Binds writable box and optional rotation signals, operation booleans or options, resize-handle selection, lifecycle callbacks, and children for the convenience component.

PibblManipulationActive

Reports the active operation, resize handle, and pointer identifier; the controller publishes null while idle.

PibblManipulationBox

Readonly left, top, width, and height geometry stored in the writable box signal.

PibblManipulationCancelEvent

A terminal cancellation snapshot with before/after geometry and a cancellation reason.

PibblManipulationCancelReason

The closed vocabulary for explicit cancellation, input loss, disabled operations, external changes, coordinate changes, and unsatisfiable constraints.

PibblManipulationCommitEvent

A terminal committed snapshot whose changed field indicates whether geometry differs from the start.

PibblManipulationController

Exposes readonly active and snapshot signals, stable frameProps, and cancel().

PibblManipulationEvent

An immutable operation snapshot with before and after geometry.

PibblManipulationFrameProps

Binds a controller and its original writable box signal to a frame, with optional children.

PibblManipulationGeometry

Combines a box with rotation in radians.

PibblManipulationMoveInput

Configures movement axes, parent-space bounds, grid snapping, and optional signal-valued activation.

PibblManipulationOperation

Names move, resize, or rotate operations.

PibblManipulationOptions

Binds writable geometry, move/resize options, and start/change/commit/cancel callbacks.

PibblManipulationPoint

A geometric coordinate pair used by manipulation calculations.

PibblManipulationReadoutStateStyle

A flat readout state patch containing font, fill, stroke, strokeWidth, opacity, visible, and gap. It cannot contain nested state branches.

PibblManipulationReadoutStyle

Local readout presentation: font, fill, stroke, stroke width, opacity, visibility and outward CSS-pixel gap (default 5), with flat inactive, focused and active overrides. Resolve base, inactive when not active, focused, then active. Labels stay upright and contained in the visible canvas; formatting never changes gesture geometry.

PibblManipulationResizeInput

Configures dimension limits, bounds, aspect ratio, size or grid snapping, and optional signal-valued activation.

PibblManipulationRotateInput

Configures optional signal-valued rotation activation and angular snapping in radians.

PibblManipulationSnapshot

Reports initial, proposed, and applied geometry together with requested and satisfied snapping state.

PibblManipulationWhen

Selects always, shift, alt, ctrl, or meta activation.

PibblPointerEvent

PibblPointerEvent is the logical facade for pointer events, including capture and Pibbl root-logical coordinates.

PibblPointerEvents

PibblPointerEvents is exactly "auto" | "none". "auto" keeps the receiving paint or external-layer target in hit resolution; "none" opts it and its owned interaction bridge out without changing pixels.

PibblResizeHandleProps

Binds one named edge or corner to a controller, with optional custom visuals and hit size.

PibblResizeHandlesProps

Selects corners, edges-and-corners, or an explicit list of resize positions for one controller.

PibblResizeHandleStyle

The resize control’s local style includes an optional readout slot. Omitted readout configuration disables the label; true enables the default active-only label; false explicitly disables it. ResizeHandles shares this style and shows one combined size readout.

PibblResizePosition

Names top-left, top, top-right, right, bottom-right, bottom, bottom-left, or left.

PibblRotationArcStyle

Rotation guide color, sweep in radians, strokeWidth and opacity.

PibblRotationConnectorStyle

Rotation connector stroke, strokeWidth and opacity in CSS-pixel presentation.

PibblRotationHandleProps

Binds a controller to an external rotation handle with optional custom visuals and CSS-pixel hit size.

PibblRotationHandleStyle

Local rotation presentation includes connector, arc and readout slots. Connector is enabled by default; arc and readout are opt-in. Each slot accepts true, false, or its typed configuration. Connector orientation follows the displayed edge; readout text stays upright and inside the canvas.

PibblTouchEvent

PibblTouchEvent is the logical facade for touch events.

PibblWheelEvent

PibblWheelEvent is the logical facade for wheel events.

Manipulation contracts.

PibblManipulationBox is the writable left, top, width, and height geometry. PibblManipulationController exposes active, snapshot, frameProps, and cancel(). PibblManipulationFrameProps is the value supplied by controller.frameProps for ManipulationFrame.

PibblManipulationActive, PibblManipulationSnapshot, and PibblManipulationEvent describe the live operation, starting geometry, proposed geometry, and applied geometry. PibblManipulationCommitEvent adds changed; PibblManipulationCancelEvent adds its cancellation reason.

PibblManipulationOptions accepts the writable box and optional move/resize configuration. PibblManipulationMoveInput controls movement axis, bounds, and grid snapping. PibblManipulationResizeInput controls size limits, bounds, aspect ratio, and size or grid snapping. Their enabled values accept signals.

PibblResizePosition names the supported frame edges and corners. PibblDragHandleProps, PibblDragHandleStyle, PibblResizeHandleProps, and PibblResizeHandlesProps configure the public handle components.

API details from source

PibblKeyboardNavigationOptions

Directional keyboard-navigation policy for a focus scope.

interface PibblKeyboardNavigationOptions

Related API: PibblKeyboardNavigationOptions.

Properties and methods

mode

readonly mode: "directional"

Selects the supported mapping, placement, or result policy. See PibblKeyboardNavigationOptions.

View source — packages/core/src/lib/focus/types.ts:19

PibblClipboardEvent

Pibbl’s logical clipboard event, retaining the corresponding native event payload.

interface PibblClipboardEvent extends PibblEvent<ClipboardEvent>

Related API: PibblClipboardEvent, PibblEvent.

Properties and methods

clipboardData

readonly clipboardData: DataTransfer | null

Clipboard payload supplied by the originating browser event. See PibblClipboardEvent.

View source — packages/core/src/lib/events/types.ts:383

type

readonly type: string

Native-style name identifying the event being dispatched. See PibblEvent.

View source — packages/core/src/lib/events/types.ts:20

target

readonly target: PibblEventTarget

Related API: PibblEventTarget.

The selected logical target or target configuration. See PibblEventTarget.

View source — packages/core/src/lib/events/types.ts:22

currentTarget

readonly currentTarget: PibblEventTarget

Related API: PibblEventTarget.

The logical target whose handler is currently being dispatched. See PibblEventTarget.

View source — packages/core/src/lib/events/types.ts:24

relatedTarget

readonly relatedTarget: PibblEventTarget | null

Related API: PibblEventTarget.

The other logical target involved in a focus or boundary transition. See PibblEventTarget.

View source — packages/core/src/lib/events/types.ts:29

eventPhase

readonly eventPhase: PibblEventPhase

Related API: PibblEventPhase.

Current capture, target, or bubble phase of event propagation. See PibblEventPhase.

View source — packages/core/src/lib/events/types.ts:31

bubbles

readonly bubbles: boolean

Whether the event propagates through bubble handlers. See PibblEvent.

View source — packages/core/src/lib/events/types.ts:33

cancelable

readonly cancelable: boolean

Whether the originating event permits cancellation of its default action. See PibblEvent .

View source — packages/core/src/lib/events/types.ts:38

defaultPrevented

readonly defaultPrevented: boolean

Whether the default action has been prevented. See PibblEvent.

View source — packages/core/src/lib/events/types.ts:40

timeStamp

readonly timeStamp: number

Timestamp of the event in the browser event time coordinate system. See PibblEvent.

View source — packages/core/src/lib/events/types.ts:42

originalEvent

readonly originalEvent: ClipboardEvent

The originating browser event. See PibblEvent.

View source — packages/core/src/lib/events/types.ts:44

sourceEvent (optional)

readonly sourceEvent?: Event | undefined

The native event retained as the source of this logical event. See PibblEvent.

View source — packages/core/src/lib/events/types.ts:46

composedPath

composedPath: () => readonly PibblEventTarget[]

Related API: PibblEventTarget.

Returns the logical propagation path of the event. See PibblEventTarget.

Returns

The logical event propagation path. See PibblEventTarget.

View source — packages/core/src/lib/events/types.ts:51

preventDefault

preventDefault: () => void

Prevents the originating event’s default action when cancellation is supported. See PibblEvent.

View source — packages/core/src/lib/events/types.ts:56

stopPropagation

stopPropagation: () => void

Stops propagation to subsequent logical ancestors. See PibblEvent.

View source — packages/core/src/lib/events/types.ts:58

stopImmediatePropagation

stopImmediatePropagation: () => void

Stops remaining handlers at this target and further propagation. See PibblEvent.

View source — packages/core/src/lib/events/types.ts:60

PibblCompositionEvent

Pibbl’s logical composition event, retaining the corresponding native event payload.

interface PibblCompositionEvent extends PibblEvent<CompositionEvent>

Related API: PibblCompositionEvent, PibblEvent.

Properties and methods

data

readonly data: string

Application data supplied to the component or reported by the event. See PibblCompositionEvent.

View source — packages/core/src/lib/events/types.ts:372

type

readonly type: string

Native-style name identifying the event being dispatched. See PibblEvent.

View source — packages/core/src/lib/events/types.ts:20

target

readonly target: PibblEventTarget

Related API: PibblEventTarget.

The selected logical target or target configuration. See PibblEventTarget.

View source — packages/core/src/lib/events/types.ts:22

currentTarget

readonly currentTarget: PibblEventTarget

Related API: PibblEventTarget.

The logical target whose handler is currently being dispatched. See PibblEventTarget.

View source — packages/core/src/lib/events/types.ts:24

relatedTarget

readonly relatedTarget: PibblEventTarget | null

Related API: PibblEventTarget.

The other logical target involved in a focus or boundary transition. See PibblEventTarget.

View source — packages/core/src/lib/events/types.ts:29

eventPhase

readonly eventPhase: PibblEventPhase

Related API: PibblEventPhase.

Current capture, target, or bubble phase of event propagation. See PibblEventPhase.

View source — packages/core/src/lib/events/types.ts:31

bubbles

readonly bubbles: boolean

Whether the event propagates through bubble handlers. See PibblEvent.

View source — packages/core/src/lib/events/types.ts:33

cancelable

readonly cancelable: boolean

Whether the originating event permits cancellation of its default action. See PibblEvent .

View source — packages/core/src/lib/events/types.ts:38

defaultPrevented

readonly defaultPrevented: boolean

Whether the default action has been prevented. See PibblEvent.

View source — packages/core/src/lib/events/types.ts:40

timeStamp

readonly timeStamp: number

Timestamp of the event in the browser event time coordinate system. See PibblEvent.

View source — packages/core/src/lib/events/types.ts:42

originalEvent

readonly originalEvent: CompositionEvent

The originating browser event. See PibblEvent.

View source — packages/core/src/lib/events/types.ts:44

sourceEvent (optional)

readonly sourceEvent?: Event | undefined

The native event retained as the source of this logical event. See PibblEvent.

View source — packages/core/src/lib/events/types.ts:46

composedPath

composedPath: () => readonly PibblEventTarget[]

Related API: PibblEventTarget.

Returns the logical propagation path of the event. See PibblEventTarget.

Returns

The logical event propagation path. See PibblEventTarget.

View source — packages/core/src/lib/events/types.ts:51

preventDefault

preventDefault: () => void

Prevents the originating event’s default action when cancellation is supported. See PibblEvent.

View source — packages/core/src/lib/events/types.ts:56

stopPropagation

stopPropagation: () => void

Stops propagation to subsequent logical ancestors. See PibblEvent.

View source — packages/core/src/lib/events/types.ts:58

stopImmediatePropagation

stopImmediatePropagation: () => void

Stops remaining handlers at this target and further propagation. See PibblEvent.

View source — packages/core/src/lib/events/types.ts:60

PibblDragEvent

Pibbl’s logical drag event, retaining the corresponding native event payload.

interface PibblDragEvent extends PibblLogicalMouseEvent<DragEvent>

Related API: PibblDragEvent, PibblLogicalMouseEvent.

Properties and methods

dataTransfer

readonly dataTransfer: DataTransfer | null

Drag-and-drop or input transfer payload from the originating browser event. See PibblDragEvent.

View source — packages/core/src/lib/events/types.ts:397

type

readonly type: string

Native-style name identifying the event being dispatched. See PibblEvent.

View source — packages/core/src/lib/events/types.ts:20

target

readonly target: PibblEventTarget

Related API: PibblEventTarget.

The selected logical target or target configuration. See PibblEventTarget.

View source — packages/core/src/lib/events/types.ts:22

currentTarget

readonly currentTarget: PibblEventTarget

Related API: PibblEventTarget.

The logical target whose handler is currently being dispatched. See PibblEventTarget.

View source — packages/core/src/lib/events/types.ts:24

relatedTarget

readonly relatedTarget: PibblEventTarget | null

Related API: PibblEventTarget.

The other logical target involved in a focus or boundary transition. See PibblEventTarget.

View source — packages/core/src/lib/events/types.ts:29

eventPhase

readonly eventPhase: PibblEventPhase

Related API: PibblEventPhase.

Current capture, target, or bubble phase of event propagation. See PibblEventPhase.

View source — packages/core/src/lib/events/types.ts:31

bubbles

readonly bubbles: boolean

Whether the event propagates through bubble handlers. See PibblEvent.

View source — packages/core/src/lib/events/types.ts:33

cancelable

readonly cancelable: boolean

Whether the originating event permits cancellation of its default action. See PibblEvent .

View source — packages/core/src/lib/events/types.ts:38

defaultPrevented

readonly defaultPrevented: boolean

Whether the default action has been prevented. See PibblEvent.

View source — packages/core/src/lib/events/types.ts:40

timeStamp

readonly timeStamp: number

Timestamp of the event in the browser event time coordinate system. See PibblEvent.

View source — packages/core/src/lib/events/types.ts:42

originalEvent

readonly originalEvent: DragEvent

The originating browser event. See PibblEvent.

View source — packages/core/src/lib/events/types.ts:44

sourceEvent (optional)

readonly sourceEvent?: Event | undefined

The native event retained as the source of this logical event. See PibblEvent.

View source — packages/core/src/lib/events/types.ts:46

composedPath

composedPath: () => readonly PibblEventTarget[]

Related API: PibblEventTarget.

Returns the logical propagation path of the event. See PibblEventTarget.

Returns

The logical event propagation path. See PibblEventTarget.

View source — packages/core/src/lib/events/types.ts:51

preventDefault

preventDefault: () => void

Prevents the originating event’s default action when cancellation is supported. See PibblEvent.

View source — packages/core/src/lib/events/types.ts:56

stopPropagation

stopPropagation: () => void

Stops propagation to subsequent logical ancestors. See PibblEvent.

View source — packages/core/src/lib/events/types.ts:58

stopImmediatePropagation

stopImmediatePropagation: () => void

Stops remaining handlers at this target and further propagation. See PibblEvent.

View source — packages/core/src/lib/events/types.ts:60

altKey

readonly altKey: boolean

Whether Alt was held when the event occurred. See PibblModifierEvent.

View source — packages/core/src/lib/events/types.ts:175

ctrlKey

readonly ctrlKey: boolean

Whether Control was held when the event occurred. See PibblModifierEvent.

View source — packages/core/src/lib/events/types.ts:177

metaKey

readonly metaKey: boolean

Whether the platform Meta key was held when the event occurred. See PibblModifierEvent.

View source — packages/core/src/lib/events/types.ts:181

shiftKey

readonly shiftKey: boolean

Whether Shift was held when the event occurred. See PibblModifierEvent.

View source — packages/core/src/lib/events/types.ts:183

readonly x: number

Root-logical canvas coordinates.

View source — packages/core/src/lib/events/types.ts:197

readonly y: number

Root-logical canvas coordinates.

View source — packages/core/src/lib/events/types.ts:199

clientX

readonly clientX: number

Browser client-space horizontal coordinate. See PibblLogicalMouseEvent.

View source — packages/core/src/lib/events/types.ts:201

clientY

readonly clientY: number

Browser client-space vertical coordinate. See PibblLogicalMouseEvent.

View source — packages/core/src/lib/events/types.ts:203

screenX

readonly screenX: number

Browser screen-space horizontal coordinate. See PibblLogicalMouseEvent.

View source — packages/core/src/lib/events/types.ts:205

screenY

readonly screenY: number

Browser screen-space vertical coordinate. See PibblLogicalMouseEvent.

View source — packages/core/src/lib/events/types.ts:207

movementX

readonly movementX: number

Browser-reported horizontal motion since the previous event. See PibblLogicalMouseEvent .

View source — packages/core/src/lib/events/types.ts:212

movementY

readonly movementY: number

Browser-reported vertical motion since the previous event. See PibblLogicalMouseEvent.

View source — packages/core/src/lib/events/types.ts:216

button

readonly button: number

The button that changed state for this mouse or pointer event. See PibblLogicalMouseEvent.

View source — packages/core/src/lib/events/types.ts:221

buttons

readonly buttons: number

Bit mask of buttons held during this mouse or pointer event. See PibblLogicalMouseEvent .

View source — packages/core/src/lib/events/types.ts:226

detail

readonly detail: number

Browser mouse-event detail, such as the click count. See PibblLogicalMouseEvent.

View source — packages/core/src/lib/events/types.ts:228

PibblEvent

Base Pibbl event with logical targeting, propagation, and native-event access.

interface PibblEvent<TOriginal extends Event = Event>

Related API: PibblEvent.

Properties and methods

type

readonly type: string

Native-style name identifying the event being dispatched. See PibblEvent.

View source — packages/core/src/lib/events/types.ts:20

target

readonly target: PibblEventTarget

Related API: PibblEventTarget.

The selected logical target or target configuration. See PibblEventTarget.

View source — packages/core/src/lib/events/types.ts:22

currentTarget

readonly currentTarget: PibblEventTarget

Related API: PibblEventTarget.

The logical target whose handler is currently being dispatched. See PibblEventTarget.

View source — packages/core/src/lib/events/types.ts:24

relatedTarget

readonly relatedTarget: PibblEventTarget | null

Related API: PibblEventTarget.

The other logical target involved in a focus or boundary transition. See PibblEventTarget.

View source — packages/core/src/lib/events/types.ts:29

eventPhase

readonly eventPhase: PibblEventPhase

Related API: PibblEventPhase.

Current capture, target, or bubble phase of event propagation. See PibblEventPhase.

View source — packages/core/src/lib/events/types.ts:31

bubbles

readonly bubbles: boolean

Whether the event propagates through bubble handlers. See PibblEvent.

View source — packages/core/src/lib/events/types.ts:33

cancelable

readonly cancelable: boolean

Whether the originating event permits cancellation of its default action. See PibblEvent .

View source — packages/core/src/lib/events/types.ts:38

defaultPrevented

readonly defaultPrevented: boolean

Whether the default action has been prevented. See PibblEvent.

View source — packages/core/src/lib/events/types.ts:40

timeStamp

readonly timeStamp: number

Timestamp of the event in the browser event time coordinate system. See PibblEvent.

View source — packages/core/src/lib/events/types.ts:42

originalEvent

readonly originalEvent: TOriginal

The originating browser event. See PibblEvent.

View source — packages/core/src/lib/events/types.ts:44

sourceEvent (optional)

readonly sourceEvent?: Event | undefined

The native event retained as the source of this logical event. See PibblEvent.

View source — packages/core/src/lib/events/types.ts:46

composedPath

composedPath: () => readonly PibblEventTarget[]

Related API: PibblEventTarget.

Returns the logical propagation path of the event. See PibblEventTarget.

Returns

The logical event propagation path. See PibblEventTarget.

View source — packages/core/src/lib/events/types.ts:51

preventDefault

preventDefault: () => void

Prevents the originating event’s default action when cancellation is supported. See PibblEvent.

View source — packages/core/src/lib/events/types.ts:56

stopPropagation

stopPropagation: () => void

Stops propagation to subsequent logical ancestors. See PibblEvent.

View source — packages/core/src/lib/events/types.ts:58

stopImmediatePropagation

stopImmediatePropagation: () => void

Stops remaining handlers at this target and further propagation. See PibblEvent.

View source — packages/core/src/lib/events/types.ts:60

PibblEventCapturePropName

The capture-handler prop name corresponding to a supported event type.

type PibblEventCapturePropName = `${PibblEventPropName}Capture`

PibblEventHandler

A typed callback for a Pibbl event.

type PibblEventHandler<K extends PibblEventType> = (
  event: PibblEventMap[K],
) => void

Parameters

event — Typed Pibbl event being dispatched to this handler. See PibblEventMap.

PibblEventHandlers

Optional typed event props for capture and bubble dispatch.

type PibblEventHandlers = Partial<{
  [K in PibblEventType as PibblEventPropMap[K]]: PibblEventHandler<K>;
} & {
  [K in PibblEventType as `${PibblEventPropMap[K]}Capture`]: PibblEventHandler<K>;
}>

PibblEventMap

Maps supported native-style event names to their Pibbl event payload types.

interface PibblEventMap

Related API: PibblEventMap.

Properties and methods

pointerover

pointerover: PibblPointerEvent

Related API: PibblPointerEvent.

The typed Pibbl payload for the pointerover event. See PibblPointerEvent.

View source — packages/core/src/lib/events/types.ts:417

pointerenter

pointerenter: PibblPointerEvent

Related API: PibblPointerEvent.

The typed Pibbl payload for the pointerenter event. See PibblPointerEvent.

View source — packages/core/src/lib/events/types.ts:419

pointerdown

pointerdown: PibblPointerEvent

Related API: PibblPointerEvent.

The typed Pibbl payload for the pointerdown event. See PibblPointerEvent.

View source — packages/core/src/lib/events/types.ts:421

pointermove

pointermove: PibblPointerEvent

Related API: PibblPointerEvent.

The typed Pibbl payload for the pointermove event. See PibblPointerEvent.

View source — packages/core/src/lib/events/types.ts:423

pointerrawupdate

pointerrawupdate: PibblPointerEvent

Related API: PibblPointerEvent.

The typed Pibbl payload for the pointerrawupdate event. See PibblPointerEvent.

View source — packages/core/src/lib/events/types.ts:425

pointerup

pointerup: PibblPointerEvent

Related API: PibblPointerEvent.

The typed Pibbl payload for the pointerup event. See PibblPointerEvent.

View source — packages/core/src/lib/events/types.ts:427

pointercancel

pointercancel: PibblPointerEvent

Related API: PibblPointerEvent.

The typed Pibbl payload for the pointercancel event. See PibblPointerEvent.

View source — packages/core/src/lib/events/types.ts:429

pointerout

pointerout: PibblPointerEvent

Related API: PibblPointerEvent.

The typed Pibbl payload for the pointerout event. See PibblPointerEvent.

View source — packages/core/src/lib/events/types.ts:431

pointerleave

pointerleave: PibblPointerEvent

Related API: PibblPointerEvent.

The typed Pibbl payload for the pointerleave event. See PibblPointerEvent.

View source — packages/core/src/lib/events/types.ts:433

gotpointercapture

gotpointercapture: PibblPointerEvent

Related API: PibblPointerEvent.

The typed Pibbl payload for the gotpointercapture event. See PibblPointerEvent.

View source — packages/core/src/lib/events/types.ts:435

lostpointercapture

lostpointercapture: PibblPointerEvent

Related API: PibblPointerEvent.

The typed Pibbl payload for the lostpointercapture event. See PibblPointerEvent.

View source — packages/core/src/lib/events/types.ts:437

click

click: PibblLogicalMouseEvent<MouseEvent>

Related API: PibblLogicalMouseEvent.

The typed Pibbl payload for the click event. See PibblLogicalMouseEvent.

View source — packages/core/src/lib/events/types.ts:439

dblclick

dblclick: PibblLogicalMouseEvent<MouseEvent>

Related API: PibblLogicalMouseEvent.

The typed Pibbl payload for the dblclick event. See PibblLogicalMouseEvent.

View source — packages/core/src/lib/events/types.ts:441

auxclick

auxclick: PibblLogicalMouseEvent<MouseEvent>

Related API: PibblLogicalMouseEvent.

The typed Pibbl payload for the auxclick event. See PibblLogicalMouseEvent.

View source — packages/core/src/lib/events/types.ts:443

contextmenu

contextmenu: PibblLogicalMouseEvent<MouseEvent>

Related API: PibblLogicalMouseEvent.

The typed Pibbl payload for the contextmenu event. See PibblLogicalMouseEvent.

View source — packages/core/src/lib/events/types.ts:445

mouseover

mouseover: PibblLogicalMouseEvent<MouseEvent>

Related API: PibblLogicalMouseEvent.

The typed Pibbl payload for the mouseover event. See PibblLogicalMouseEvent.

View source — packages/core/src/lib/events/types.ts:447

mouseenter

mouseenter: PibblLogicalMouseEvent<MouseEvent>

Related API: PibblLogicalMouseEvent.

The typed Pibbl payload for the mouseenter event. See PibblLogicalMouseEvent.

View source — packages/core/src/lib/events/types.ts:449

mousedown

mousedown: PibblLogicalMouseEvent<MouseEvent>

Related API: PibblLogicalMouseEvent.

The typed Pibbl payload for the mousedown event. See PibblLogicalMouseEvent.

View source — packages/core/src/lib/events/types.ts:451

mousemove

mousemove: PibblLogicalMouseEvent<MouseEvent>

Related API: PibblLogicalMouseEvent.

The typed Pibbl payload for the mousemove event. See PibblLogicalMouseEvent.

View source — packages/core/src/lib/events/types.ts:453

mouseup

mouseup: PibblLogicalMouseEvent<MouseEvent>

Related API: PibblLogicalMouseEvent.

The typed Pibbl payload for the mouseup event. See PibblLogicalMouseEvent.

View source — packages/core/src/lib/events/types.ts:455

mouseout

mouseout: PibblLogicalMouseEvent<MouseEvent>

Related API: PibblLogicalMouseEvent.

The typed Pibbl payload for the mouseout event. See PibblLogicalMouseEvent.

View source — packages/core/src/lib/events/types.ts:457

mouseleave

mouseleave: PibblLogicalMouseEvent<MouseEvent>

Related API: PibblLogicalMouseEvent.

The typed Pibbl payload for the mouseleave event. See PibblLogicalMouseEvent.

View source — packages/core/src/lib/events/types.ts:459

touchstart

touchstart: PibblTouchEvent

Related API: PibblTouchEvent.

The typed Pibbl payload for the touchstart event. See PibblTouchEvent.

View source — packages/core/src/lib/events/types.ts:461

touchmove

touchmove: PibblTouchEvent

Related API: PibblTouchEvent.

The typed Pibbl payload for the touchmove event. See PibblTouchEvent.

View source — packages/core/src/lib/events/types.ts:463

touchend

touchend: PibblTouchEvent

Related API: PibblTouchEvent.

The typed Pibbl payload for the touchend event. See PibblTouchEvent.

View source — packages/core/src/lib/events/types.ts:465

touchcancel

touchcancel: PibblTouchEvent

Related API: PibblTouchEvent.

The typed Pibbl payload for the touchcancel event. See PibblTouchEvent.

View source — packages/core/src/lib/events/types.ts:467

wheel

wheel: PibblWheelEvent

Related API: PibblWheelEvent.

The typed Pibbl payload for the wheel event. See PibblWheelEvent.

View source — packages/core/src/lib/events/types.ts:469

keydown

keydown: PibblKeyboardEvent

Related API: PibblKeyboardEvent.

The typed Pibbl payload for the keydown event. See PibblKeyboardEvent.

View source — packages/core/src/lib/events/types.ts:471

keyup

keyup: PibblKeyboardEvent

Related API: PibblKeyboardEvent.

The typed Pibbl payload for the keyup event. See PibblKeyboardEvent.

View source — packages/core/src/lib/events/types.ts:473

focus

focus: PibblFocusEvent

Related API: PibblFocusEvent.

The typed Pibbl payload for the focus event. See PibblFocusEvent.

View source — packages/core/src/lib/events/types.ts:475

blur

blur: PibblFocusEvent

Related API: blur, PibblFocusEvent.

The typed Pibbl payload for the blur event. See PibblFocusEvent.

View source — packages/core/src/lib/events/types.ts:477

focusin

focusin: PibblFocusEvent

Related API: PibblFocusEvent.

The typed Pibbl payload for the focusin event. See PibblFocusEvent.

View source — packages/core/src/lib/events/types.ts:479

focusout

focusout: PibblFocusEvent

Related API: PibblFocusEvent.

The typed Pibbl payload for the focusout event. See PibblFocusEvent.

View source — packages/core/src/lib/events/types.ts:481

beforeinput

beforeinput: PibblInputEvent

Related API: PibblInputEvent.

The typed Pibbl payload for the beforeinput event. See PibblInputEvent.

View source — packages/core/src/lib/events/types.ts:483

input

input: PibblInputEvent

Related API: PibblInputEvent.

The typed Pibbl payload for the input event. See PibblInputEvent.

View source — packages/core/src/lib/events/types.ts:485

change

change: PibblEvent<Event>

Related API: PibblEvent.

The typed Pibbl payload for the change event. See PibblEvent.

View source — packages/core/src/lib/events/types.ts:487

compositionstart

compositionstart: PibblCompositionEvent

Related API: PibblCompositionEvent.

The typed Pibbl payload for the compositionstart event. See PibblCompositionEvent.

View source — packages/core/src/lib/events/types.ts:489

compositionupdate

compositionupdate: PibblCompositionEvent

Related API: PibblCompositionEvent.

The typed Pibbl payload for the compositionupdate event. See PibblCompositionEvent.

View source — packages/core/src/lib/events/types.ts:491

compositionend

compositionend: PibblCompositionEvent

Related API: PibblCompositionEvent.

The typed Pibbl payload for the compositionend event. See PibblCompositionEvent.

View source — packages/core/src/lib/events/types.ts:493

select

select: PibblEvent<Event>

Related API: PibblEvent.

The typed Pibbl payload for the select event. See PibblEvent.

View source — packages/core/src/lib/events/types.ts:495

selectionchange

selectionchange: PibblEvent<Event>

Related API: PibblEvent.

The typed Pibbl payload for the selectionchange event. See PibblEvent.

View source — packages/core/src/lib/events/types.ts:497

copy

copy: PibblClipboardEvent

Related API: PibblClipboardEvent.

The typed Pibbl payload for the copy event. See PibblClipboardEvent.

View source — packages/core/src/lib/events/types.ts:499

cut

cut: PibblClipboardEvent

Related API: PibblClipboardEvent.

The typed Pibbl payload for the cut event. See PibblClipboardEvent.

View source — packages/core/src/lib/events/types.ts:501

paste

paste: PibblClipboardEvent

Related API: PibblClipboardEvent.

The typed Pibbl payload for the paste event. See PibblClipboardEvent.

View source — packages/core/src/lib/events/types.ts:503

dragstart

dragstart: PibblDragEvent

Related API: PibblDragEvent.

The typed Pibbl payload for the dragstart event. See PibblDragEvent.

View source — packages/core/src/lib/events/types.ts:505

drag

drag: PibblDragEvent

Related API: PibblDragEvent.

The typed Pibbl payload for the drag event. See PibblDragEvent.

View source — packages/core/src/lib/events/types.ts:507

dragend

dragend: PibblDragEvent

Related API: PibblDragEvent.

The typed Pibbl payload for the dragend event. See PibblDragEvent.

View source — packages/core/src/lib/events/types.ts:509

dragenter

dragenter: PibblDragEvent

Related API: PibblDragEvent.

The typed Pibbl payload for the dragenter event. See PibblDragEvent.

View source — packages/core/src/lib/events/types.ts:511

dragleave

dragleave: PibblDragEvent

Related API: PibblDragEvent.

The typed Pibbl payload for the dragleave event. See PibblDragEvent.

View source — packages/core/src/lib/events/types.ts:513

dragover

dragover: PibblDragEvent

Related API: PibblDragEvent.

The typed Pibbl payload for the dragover event. See PibblDragEvent.

View source — packages/core/src/lib/events/types.ts:515

drop

drop: PibblDragEvent

Related API: PibblDragEvent.

The typed Pibbl payload for the drop event. See PibblDragEvent.

View source — packages/core/src/lib/events/types.ts:517

PibblEventParticipationOptions

Controls whether a primitive participates in pointer targeting.

interface PibblEventParticipationOptions

Related API: PibblEventParticipationOptions.

Properties and methods

pointerEvents (optional)

readonly pointerEvents?: PibblPointerEvents | undefined

Related API: PibblPointerEvents.

Whether this content participates in pointer targeting. See PibblPointerEvents.

View source — packages/core/src/lib/events/types.ts:126

PibblEventPhase

The capture, target, or bubble phase of Pibbl event dispatch.

type PibblEventPhase = 1 | 2 | 3

Related API: PibblEventPhase.

PibblEventPropName

The bubble-handler prop name corresponding to a supported event type.

type PibblEventPropName = PibblEventPropMap[PibblEventType]

Related API: PibblEventPropName, PibblEventType.

PibblEventTarget

A logical target identity used by Pibbl event dispatch and focus management.

interface PibblEventTarget

Related API: PibblEventTarget.

Properties and methods

setPointerCapture

setPointerCapture: (pointerId: number) => void

Captures the pointer for this logical target until release or cancellation. See PibblEventTarget.

Parameters

pointerId — Pointer identifier from the routed pointer event.

View source — packages/core/src/lib/events/types.ts:81

hasPointerCapture

hasPointerCapture: (pointerId: number) => boolean

Reports whether this target currently owns capture of the identified pointer. See PibblEventTarget.

Parameters

pointerId — Pointer identifier to check.

Returns

Whether this target currently owns capture for that pointer.

View source — packages/core/src/lib/events/types.ts:88

releasePointerCapture

releasePointerCapture: (pointerId: number) => void

Releases this target’s capture of the identified pointer. See PibblEventTarget.

Parameters

pointerId — Pointer identifier from the routed pointer event.

View source — packages/core/src/lib/events/types.ts:93

PibblEventTargetOptions

Geometry, hit testing, and focus configuration used to register an event target.

interface PibblEventTargetOptions extends PibblEventFocusOptions

Related API: PibblEventTargetOptions.

Properties and methods

path

readonly path: Path2D | PathGeometry

Related API: PathGeometry.

Path geometry used by this operation. See PathGeometry.

View source — packages/core/src/lib/events/types.ts:150

fill (optional)

readonly fill?: boolean | undefined

Whether the path’s filled interior participates in hit testing. See PibblEventTargetOptions.

View source — packages/core/src/lib/events/types.ts:155

lineInteractionWidth (optional)

readonly lineInteractionWidth?: number | undefined

Width used for line hit testing independently of the visible stroke width. See PibblEventTargetOptions.

View source — packages/core/src/lib/events/types.ts:160

cursor (optional)

readonly cursor?: string | undefined

Cursor shown while this target owns pointer presentation. See PibblEventTargetOptions.

View source — packages/core/src/lib/events/types.ts:164

keyboardFocusable (optional)

readonly keyboardFocusable?: boolean | undefined

Whether the target may receive keyboard focus. See PibblEventFocusOptions.

View source — packages/core/src/lib/events/types.ts:137

keyboardNavigationBounds (optional)

readonly keyboardNavigationBounds?: Readonly<LayoutBox> | undefined

Related API: LayoutBox.

Logical rectangle used for directional keyboard navigation. See LayoutBox.

View source — packages/core/src/lib/events/types.ts:139

PibblEventTargetSnapshot

Current interaction and focus state returned for a registered target.

interface PibblEventTargetSnapshot

Related API: PibblEventTargetSnapshot.

Properties and methods

isFocused

readonly isFocused: boolean

Whether this target currently holds logical focus. See PibblEventTargetSnapshot.

View source — packages/core/src/lib/events/types.ts:103

isFocusVisible

readonly isFocusVisible: boolean

Whether focus should be presented as keyboard-visible. See PibblEventTargetSnapshot.

View source — packages/core/src/lib/events/types.ts:105

PibblEventType

The supported event names in the Pibbl event map.

type PibblEventType = keyof PibblEventMap

Related API: PibblEventType, PibblEventMap.

PibblFocusEvent

Pibbl’s logical focus event, retaining the corresponding native event payload.

interface PibblFocusEvent extends PibblEvent<FocusEvent>

Related API: PibblFocusEvent, PibblEvent.

Properties and methods

type

readonly type: string

Native-style name identifying the event being dispatched. See PibblEvent.

View source — packages/core/src/lib/events/types.ts:20

target

readonly target: PibblEventTarget

Related API: PibblEventTarget.

The selected logical target or target configuration. See PibblEventTarget.

View source — packages/core/src/lib/events/types.ts:22

currentTarget

readonly currentTarget: PibblEventTarget

Related API: PibblEventTarget.

The logical target whose handler is currently being dispatched. See PibblEventTarget.

View source — packages/core/src/lib/events/types.ts:24

relatedTarget

readonly relatedTarget: PibblEventTarget | null

Related API: PibblEventTarget.

The other logical target involved in a focus or boundary transition. See PibblEventTarget.

View source — packages/core/src/lib/events/types.ts:29

eventPhase

readonly eventPhase: PibblEventPhase

Related API: PibblEventPhase.

Current capture, target, or bubble phase of event propagation. See PibblEventPhase.

View source — packages/core/src/lib/events/types.ts:31

bubbles

readonly bubbles: boolean

Whether the event propagates through bubble handlers. See PibblEvent.

View source — packages/core/src/lib/events/types.ts:33

cancelable

readonly cancelable: boolean

Whether the originating event permits cancellation of its default action. See PibblEvent .

View source — packages/core/src/lib/events/types.ts:38

defaultPrevented

readonly defaultPrevented: boolean

Whether the default action has been prevented. See PibblEvent.

View source — packages/core/src/lib/events/types.ts:40

timeStamp

readonly timeStamp: number

Timestamp of the event in the browser event time coordinate system. See PibblEvent.

View source — packages/core/src/lib/events/types.ts:42

originalEvent

readonly originalEvent: FocusEvent

The originating browser event. See PibblEvent.

View source — packages/core/src/lib/events/types.ts:44

sourceEvent (optional)

readonly sourceEvent?: Event | undefined

The native event retained as the source of this logical event. See PibblEvent.

View source — packages/core/src/lib/events/types.ts:46

composedPath

composedPath: () => readonly PibblEventTarget[]

Related API: PibblEventTarget.

Returns the logical propagation path of the event. See PibblEventTarget.

Returns

The logical event propagation path. See PibblEventTarget.

View source — packages/core/src/lib/events/types.ts:51

preventDefault

preventDefault: () => void

Prevents the originating event’s default action when cancellation is supported. See PibblEvent.

View source — packages/core/src/lib/events/types.ts:56

stopPropagation

stopPropagation: () => void

Stops propagation to subsequent logical ancestors. See PibblEvent.

View source — packages/core/src/lib/events/types.ts:58

stopImmediatePropagation

stopImmediatePropagation: () => void

Stops remaining handlers at this target and further propagation. See PibblEvent.

View source — packages/core/src/lib/events/types.ts:60

PibblInputEvent

Pibbl’s logical input event, retaining the corresponding native event payload.

interface PibblInputEvent extends PibblEvent<InputEvent>

Related API: PibblInputEvent, PibblEvent.

Properties and methods

data

readonly data: string | null

Application data supplied to the component or reported by the event. See PibblInputEvent .

View source — packages/core/src/lib/events/types.ts:346

dataTransfer

readonly dataTransfer: DataTransfer | null

Drag-and-drop or input transfer payload from the originating browser event. See PibblInputEvent.

View source — packages/core/src/lib/events/types.ts:351

inputType

readonly inputType: string

The editing operation reported by the browser input event. See PibblInputEvent.

View source — packages/core/src/lib/events/types.ts:353

isComposing

readonly isComposing: boolean

Whether the event occurred during an active text-composition session. See PibblInputEvent.

View source — packages/core/src/lib/events/types.ts:358

type

readonly type: string

Native-style name identifying the event being dispatched. See PibblEvent.

View source — packages/core/src/lib/events/types.ts:20

target

readonly target: PibblEventTarget

Related API: PibblEventTarget.

The selected logical target or target configuration. See PibblEventTarget.

View source — packages/core/src/lib/events/types.ts:22

currentTarget

readonly currentTarget: PibblEventTarget

Related API: PibblEventTarget.

The logical target whose handler is currently being dispatched. See PibblEventTarget.

View source — packages/core/src/lib/events/types.ts:24

relatedTarget

readonly relatedTarget: PibblEventTarget | null

Related API: PibblEventTarget.

The other logical target involved in a focus or boundary transition. See PibblEventTarget.

View source — packages/core/src/lib/events/types.ts:29

eventPhase

readonly eventPhase: PibblEventPhase

Related API: PibblEventPhase.

Current capture, target, or bubble phase of event propagation. See PibblEventPhase.

View source — packages/core/src/lib/events/types.ts:31

bubbles

readonly bubbles: boolean

Whether the event propagates through bubble handlers. See PibblEvent.

View source — packages/core/src/lib/events/types.ts:33

cancelable

readonly cancelable: boolean

Whether the originating event permits cancellation of its default action. See PibblEvent .

View source — packages/core/src/lib/events/types.ts:38

defaultPrevented

readonly defaultPrevented: boolean

Whether the default action has been prevented. See PibblEvent.

View source — packages/core/src/lib/events/types.ts:40

timeStamp

readonly timeStamp: number

Timestamp of the event in the browser event time coordinate system. See PibblEvent.

View source — packages/core/src/lib/events/types.ts:42

originalEvent

readonly originalEvent: InputEvent

The originating browser event. See PibblEvent.

View source — packages/core/src/lib/events/types.ts:44

sourceEvent (optional)

readonly sourceEvent?: Event | undefined

The native event retained as the source of this logical event. See PibblEvent.

View source — packages/core/src/lib/events/types.ts:46

composedPath

composedPath: () => readonly PibblEventTarget[]

Related API: PibblEventTarget.

Returns the logical propagation path of the event. See PibblEventTarget.

Returns

The logical event propagation path. See PibblEventTarget.

View source — packages/core/src/lib/events/types.ts:51

preventDefault

preventDefault: () => void

Prevents the originating event’s default action when cancellation is supported. See PibblEvent.

View source — packages/core/src/lib/events/types.ts:56

stopPropagation

stopPropagation: () => void

Stops propagation to subsequent logical ancestors. See PibblEvent.

View source — packages/core/src/lib/events/types.ts:58

stopImmediatePropagation

stopImmediatePropagation: () => void

Stops remaining handlers at this target and further propagation. See PibblEvent.

View source — packages/core/src/lib/events/types.ts:60

PibblKeyboardEvent

Pibbl’s logical keyboard event, retaining the corresponding native event payload.

interface PibblKeyboardEvent extends PibblModifierEvent<KeyboardEvent>

Related API: PibblKeyboardEvent.

Properties and methods

key

readonly key: string

Logical key value reported by the browser. See PibblKeyboardEvent.

View source — packages/core/src/lib/events/types.ts:313

code

readonly code: string

Physical key code reported by the browser. See PibblKeyboardEvent.

View source — packages/core/src/lib/events/types.ts:315

location

readonly location: number

Browser-reported location of the key on the keyboard. See PibblKeyboardEvent.

View source — packages/core/src/lib/events/types.ts:317

repeat

readonly repeat: boolean

Related API: repeat.

Whether the browser reported an auto-repeated key press. See PibblKeyboardEvent.

View source — packages/core/src/lib/events/types.ts:319

isComposing

readonly isComposing: boolean

Whether the event occurred during an active text-composition session. See PibblKeyboardEvent.

View source — packages/core/src/lib/events/types.ts:324

type

readonly type: string

Native-style name identifying the event being dispatched. See PibblEvent.

View source — packages/core/src/lib/events/types.ts:20

target

readonly target: PibblEventTarget

Related API: PibblEventTarget.

The selected logical target or target configuration. See PibblEventTarget.

View source — packages/core/src/lib/events/types.ts:22

currentTarget

readonly currentTarget: PibblEventTarget

Related API: PibblEventTarget.

The logical target whose handler is currently being dispatched. See PibblEventTarget.

View source — packages/core/src/lib/events/types.ts:24

relatedTarget

readonly relatedTarget: PibblEventTarget | null

Related API: PibblEventTarget.

The other logical target involved in a focus or boundary transition. See PibblEventTarget.

View source — packages/core/src/lib/events/types.ts:29

eventPhase

readonly eventPhase: PibblEventPhase

Related API: PibblEventPhase.

Current capture, target, or bubble phase of event propagation. See PibblEventPhase.

View source — packages/core/src/lib/events/types.ts:31

bubbles

readonly bubbles: boolean

Whether the event propagates through bubble handlers. See PibblEvent.

View source — packages/core/src/lib/events/types.ts:33

cancelable

readonly cancelable: boolean

Whether the originating event permits cancellation of its default action. See PibblEvent .

View source — packages/core/src/lib/events/types.ts:38

defaultPrevented

readonly defaultPrevented: boolean

Whether the default action has been prevented. See PibblEvent.

View source — packages/core/src/lib/events/types.ts:40

timeStamp

readonly timeStamp: number

Timestamp of the event in the browser event time coordinate system. See PibblEvent.

View source — packages/core/src/lib/events/types.ts:42

originalEvent

readonly originalEvent: KeyboardEvent

The originating browser event. See PibblEvent.

View source — packages/core/src/lib/events/types.ts:44

sourceEvent (optional)

readonly sourceEvent?: Event | undefined

The native event retained as the source of this logical event. See PibblEvent.

View source — packages/core/src/lib/events/types.ts:46

composedPath

composedPath: () => readonly PibblEventTarget[]

Related API: PibblEventTarget.

Returns the logical propagation path of the event. See PibblEventTarget.

Returns

The logical event propagation path. See PibblEventTarget.

View source — packages/core/src/lib/events/types.ts:51

preventDefault

preventDefault: () => void

Prevents the originating event’s default action when cancellation is supported. See PibblEvent.

View source — packages/core/src/lib/events/types.ts:56

stopPropagation

stopPropagation: () => void

Stops propagation to subsequent logical ancestors. See PibblEvent.

View source — packages/core/src/lib/events/types.ts:58

stopImmediatePropagation

stopImmediatePropagation: () => void

Stops remaining handlers at this target and further propagation. See PibblEvent.

View source — packages/core/src/lib/events/types.ts:60

altKey

readonly altKey: boolean

Whether Alt was held when the event occurred. See PibblModifierEvent.

View source — packages/core/src/lib/events/types.ts:175

ctrlKey

readonly ctrlKey: boolean

Whether Control was held when the event occurred. See PibblModifierEvent.

View source — packages/core/src/lib/events/types.ts:177

metaKey

readonly metaKey: boolean

Whether the platform Meta key was held when the event occurred. See PibblModifierEvent.

View source — packages/core/src/lib/events/types.ts:181

shiftKey

readonly shiftKey: boolean

Whether Shift was held when the event occurred. See PibblModifierEvent.

View source — packages/core/src/lib/events/types.ts:183

PibblLogicalMouseEvent

Mouse event coordinates and buttons expressed in Pibbl’s logical coordinate system.

interface PibblLogicalMouseEvent<TOriginal extends MouseEvent = MouseEvent> extends PibblModifierEvent<TOriginal>

Related API: PibblLogicalMouseEvent.

Properties and methods

readonly x: number

Root-logical canvas coordinates.

View source — packages/core/src/lib/events/types.ts:197

readonly y: number

Root-logical canvas coordinates.

View source — packages/core/src/lib/events/types.ts:199

clientX

readonly clientX: number

Browser client-space horizontal coordinate. See PibblLogicalMouseEvent.

View source — packages/core/src/lib/events/types.ts:201

clientY

readonly clientY: number

Browser client-space vertical coordinate. See PibblLogicalMouseEvent.

View source — packages/core/src/lib/events/types.ts:203

screenX

readonly screenX: number

Browser screen-space horizontal coordinate. See PibblLogicalMouseEvent.

View source — packages/core/src/lib/events/types.ts:205

screenY

readonly screenY: number

Browser screen-space vertical coordinate. See PibblLogicalMouseEvent.

View source — packages/core/src/lib/events/types.ts:207

movementX

readonly movementX: number

Browser-reported horizontal motion since the previous event. See PibblLogicalMouseEvent .

View source — packages/core/src/lib/events/types.ts:212

movementY

readonly movementY: number

Browser-reported vertical motion since the previous event. See PibblLogicalMouseEvent.

View source — packages/core/src/lib/events/types.ts:216

button

readonly button: number

The button that changed state for this mouse or pointer event. See PibblLogicalMouseEvent.

View source — packages/core/src/lib/events/types.ts:221

buttons

readonly buttons: number

Bit mask of buttons held during this mouse or pointer event. See PibblLogicalMouseEvent .

View source — packages/core/src/lib/events/types.ts:226

detail

readonly detail: number

Browser mouse-event detail, such as the click count. See PibblLogicalMouseEvent.

View source — packages/core/src/lib/events/types.ts:228

type

readonly type: string

Native-style name identifying the event being dispatched. See PibblEvent.

View source — packages/core/src/lib/events/types.ts:20

target

readonly target: PibblEventTarget

Related API: PibblEventTarget.

The selected logical target or target configuration. See PibblEventTarget.

View source — packages/core/src/lib/events/types.ts:22

currentTarget

readonly currentTarget: PibblEventTarget

Related API: PibblEventTarget.

The logical target whose handler is currently being dispatched. See PibblEventTarget.

View source — packages/core/src/lib/events/types.ts:24

relatedTarget

readonly relatedTarget: PibblEventTarget | null

Related API: PibblEventTarget.

The other logical target involved in a focus or boundary transition. See PibblEventTarget.

View source — packages/core/src/lib/events/types.ts:29

eventPhase

readonly eventPhase: PibblEventPhase

Related API: PibblEventPhase.

Current capture, target, or bubble phase of event propagation. See PibblEventPhase.

View source — packages/core/src/lib/events/types.ts:31

bubbles

readonly bubbles: boolean

Whether the event propagates through bubble handlers. See PibblEvent.

View source — packages/core/src/lib/events/types.ts:33

cancelable

readonly cancelable: boolean

Whether the originating event permits cancellation of its default action. See PibblEvent .

View source — packages/core/src/lib/events/types.ts:38

defaultPrevented

readonly defaultPrevented: boolean

Whether the default action has been prevented. See PibblEvent.

View source — packages/core/src/lib/events/types.ts:40

timeStamp

readonly timeStamp: number

Timestamp of the event in the browser event time coordinate system. See PibblEvent.

View source — packages/core/src/lib/events/types.ts:42

originalEvent

readonly originalEvent: TOriginal

The originating browser event. See PibblEvent.

View source — packages/core/src/lib/events/types.ts:44

sourceEvent (optional)

readonly sourceEvent?: Event | undefined

The native event retained as the source of this logical event. See PibblEvent.

View source — packages/core/src/lib/events/types.ts:46

composedPath

composedPath: () => readonly PibblEventTarget[]

Related API: PibblEventTarget.

Returns the logical propagation path of the event. See PibblEventTarget.

Returns

The logical event propagation path. See PibblEventTarget.

View source — packages/core/src/lib/events/types.ts:51

preventDefault

preventDefault: () => void

Prevents the originating event’s default action when cancellation is supported. See PibblEvent.

View source — packages/core/src/lib/events/types.ts:56

stopPropagation

stopPropagation: () => void

Stops propagation to subsequent logical ancestors. See PibblEvent.

View source — packages/core/src/lib/events/types.ts:58

stopImmediatePropagation

stopImmediatePropagation: () => void

Stops remaining handlers at this target and further propagation. See PibblEvent.

View source — packages/core/src/lib/events/types.ts:60

altKey

readonly altKey: boolean

Whether Alt was held when the event occurred. See PibblModifierEvent.

View source — packages/core/src/lib/events/types.ts:175

ctrlKey

readonly ctrlKey: boolean

Whether Control was held when the event occurred. See PibblModifierEvent.

View source — packages/core/src/lib/events/types.ts:177

metaKey

readonly metaKey: boolean

Whether the platform Meta key was held when the event occurred. See PibblModifierEvent.

View source — packages/core/src/lib/events/types.ts:181

shiftKey

readonly shiftKey: boolean

Whether Shift was held when the event occurred. See PibblModifierEvent.

View source — packages/core/src/lib/events/types.ts:183

PibblPointerEvent

Pibbl’s logical pointer event, retaining the corresponding native event payload.

interface PibblPointerEvent extends PibblLogicalMouseEvent<PointerEvent>

Properties and methods

pointerId

readonly pointerId: number

Browser identifier of the active pointer. See PibblPointerEvent.

View source — packages/core/src/lib/events/types.ts:239

width

readonly width: number

Horizontal extent in the units of the containing geometry or surface. See PibblPointerEvent.

View source — packages/core/src/lib/events/types.ts:244

height

readonly height: number

Vertical extent in the units of the containing geometry or surface. See PibblPointerEvent.

View source — packages/core/src/lib/events/types.ts:249

pressure

readonly pressure: number

Normalized pressure reported by the pointer device. See PibblPointerEvent.

View source — packages/core/src/lib/events/types.ts:251

tangentialPressure

readonly tangentialPressure: number

Normalized tangential pressure reported by the pointer device. See PibblPointerEvent.

View source — packages/core/src/lib/events/types.ts:253

tiltX

readonly tiltX: number

Pointer tilt relative to the x axis, in degrees. See PibblPointerEvent.

View source — packages/core/src/lib/events/types.ts:255

tiltY

readonly tiltY: number

Pointer tilt relative to the y axis, in degrees. See PibblPointerEvent.

View source — packages/core/src/lib/events/types.ts:257

twist

readonly twist: number

Pointer rotation around its own axis, in degrees. See PibblPointerEvent.

View source — packages/core/src/lib/events/types.ts:259

pointerType

readonly pointerType: string

Browser-reported pointer device category. See PibblPointerEvent.

View source — packages/core/src/lib/events/types.ts:261

isPrimary

readonly isPrimary: boolean

Whether this is the primary pointer of its device category. See PibblPointerEvent.

View source — packages/core/src/lib/events/types.ts:263

type

readonly type: string

Native-style name identifying the event being dispatched. See PibblEvent.

View source — packages/core/src/lib/events/types.ts:20

target

readonly target: PibblEventTarget

Related API: PibblEventTarget.

The selected logical target or target configuration. See PibblEventTarget.

View source — packages/core/src/lib/events/types.ts:22

currentTarget

readonly currentTarget: PibblEventTarget

Related API: PibblEventTarget.

The logical target whose handler is currently being dispatched. See PibblEventTarget.

View source — packages/core/src/lib/events/types.ts:24

relatedTarget

readonly relatedTarget: PibblEventTarget | null

Related API: PibblEventTarget.

The other logical target involved in a focus or boundary transition. See PibblEventTarget.

View source — packages/core/src/lib/events/types.ts:29

eventPhase

readonly eventPhase: PibblEventPhase

Related API: PibblEventPhase.

Current capture, target, or bubble phase of event propagation. See PibblEventPhase.

View source — packages/core/src/lib/events/types.ts:31

bubbles

readonly bubbles: boolean

Whether the event propagates through bubble handlers. See PibblEvent.

View source — packages/core/src/lib/events/types.ts:33

cancelable

readonly cancelable: boolean

Whether the originating event permits cancellation of its default action. See PibblEvent .

View source — packages/core/src/lib/events/types.ts:38

defaultPrevented

readonly defaultPrevented: boolean

Whether the default action has been prevented. See PibblEvent.

View source — packages/core/src/lib/events/types.ts:40

timeStamp

readonly timeStamp: number

Timestamp of the event in the browser event time coordinate system. See PibblEvent.

View source — packages/core/src/lib/events/types.ts:42

originalEvent

readonly originalEvent: PointerEvent

The originating browser event. See PibblEvent.

View source — packages/core/src/lib/events/types.ts:44

sourceEvent (optional)

readonly sourceEvent?: Event | undefined

The native event retained as the source of this logical event. See PibblEvent.

View source — packages/core/src/lib/events/types.ts:46

composedPath

composedPath: () => readonly PibblEventTarget[]

Related API: PibblEventTarget.

Returns the logical propagation path of the event. See PibblEventTarget.

Returns

The logical event propagation path. See PibblEventTarget.

View source — packages/core/src/lib/events/types.ts:51

preventDefault

preventDefault: () => void

Prevents the originating event’s default action when cancellation is supported. See PibblEvent.

View source — packages/core/src/lib/events/types.ts:56

stopPropagation

stopPropagation: () => void

Stops propagation to subsequent logical ancestors. See PibblEvent.

View source — packages/core/src/lib/events/types.ts:58

stopImmediatePropagation

stopImmediatePropagation: () => void

Stops remaining handlers at this target and further propagation. See PibblEvent.

View source — packages/core/src/lib/events/types.ts:60

altKey

readonly altKey: boolean

Whether Alt was held when the event occurred. See PibblModifierEvent.

View source — packages/core/src/lib/events/types.ts:175

ctrlKey

readonly ctrlKey: boolean

Whether Control was held when the event occurred. See PibblModifierEvent.

View source — packages/core/src/lib/events/types.ts:177

metaKey

readonly metaKey: boolean

Whether the platform Meta key was held when the event occurred. See PibblModifierEvent.

View source — packages/core/src/lib/events/types.ts:181

shiftKey

readonly shiftKey: boolean

Whether Shift was held when the event occurred. See PibblModifierEvent.

View source — packages/core/src/lib/events/types.ts:183

readonly x: number

Root-logical canvas coordinates.

View source — packages/core/src/lib/events/types.ts:197

readonly y: number

Root-logical canvas coordinates.

View source — packages/core/src/lib/events/types.ts:199

clientX

readonly clientX: number

Browser client-space horizontal coordinate. See PibblLogicalMouseEvent.

View source — packages/core/src/lib/events/types.ts:201

clientY

readonly clientY: number

Browser client-space vertical coordinate. See PibblLogicalMouseEvent.

View source — packages/core/src/lib/events/types.ts:203

screenX

readonly screenX: number

Browser screen-space horizontal coordinate. See PibblLogicalMouseEvent.

View source — packages/core/src/lib/events/types.ts:205

screenY

readonly screenY: number

Browser screen-space vertical coordinate. See PibblLogicalMouseEvent.

View source — packages/core/src/lib/events/types.ts:207

movementX

readonly movementX: number

Browser-reported horizontal motion since the previous event. See PibblLogicalMouseEvent .

View source — packages/core/src/lib/events/types.ts:212

movementY

readonly movementY: number

Browser-reported vertical motion since the previous event. See PibblLogicalMouseEvent.

View source — packages/core/src/lib/events/types.ts:216

button

readonly button: number

The button that changed state for this mouse or pointer event. See PibblLogicalMouseEvent.

View source — packages/core/src/lib/events/types.ts:221

buttons

readonly buttons: number

Bit mask of buttons held during this mouse or pointer event. See PibblLogicalMouseEvent .

View source — packages/core/src/lib/events/types.ts:226

detail

readonly detail: number

Browser mouse-event detail, such as the click count. See PibblLogicalMouseEvent.

View source — packages/core/src/lib/events/types.ts:228

PibblPointerEvents

Whether paint participates in coordinate targeting or is skipped as decoration.

type PibblPointerEvents = 'auto' | 'none'

Related API: PibblPointerEvents.

PibblTouchEvent

Pibbl’s logical touch event, retaining the corresponding native event payload.

interface PibblTouchEvent extends PibblModifierEvent<TouchEvent>

Related API: PibblTouchEvent.

Properties and methods

readonly x: number

Root-logical coordinates from the first changed touch.

View source — packages/core/src/lib/events/types.ts:273

readonly y: number

Root-logical coordinates from the first changed touch.

View source — packages/core/src/lib/events/types.ts:275

touches

readonly touches: TouchList

All active browser touch contacts. See PibblTouchEvent.

View source — packages/core/src/lib/events/types.ts:277

targetTouches

readonly targetTouches: TouchList

Active browser touch contacts associated with the event target. See PibblTouchEvent.

View source — packages/core/src/lib/events/types.ts:279

changedTouches

readonly changedTouches: TouchList

Browser touch contacts changed by this event. See PibblTouchEvent.

View source — packages/core/src/lib/events/types.ts:281

type

readonly type: string

Native-style name identifying the event being dispatched. See PibblEvent.

View source — packages/core/src/lib/events/types.ts:20

target

readonly target: PibblEventTarget

Related API: PibblEventTarget.

The selected logical target or target configuration. See PibblEventTarget.

View source — packages/core/src/lib/events/types.ts:22

currentTarget

readonly currentTarget: PibblEventTarget

Related API: PibblEventTarget.

The logical target whose handler is currently being dispatched. See PibblEventTarget.

View source — packages/core/src/lib/events/types.ts:24

relatedTarget

readonly relatedTarget: PibblEventTarget | null

Related API: PibblEventTarget.

The other logical target involved in a focus or boundary transition. See PibblEventTarget.

View source — packages/core/src/lib/events/types.ts:29

eventPhase

readonly eventPhase: PibblEventPhase

Related API: PibblEventPhase.

Current capture, target, or bubble phase of event propagation. See PibblEventPhase.

View source — packages/core/src/lib/events/types.ts:31

bubbles

readonly bubbles: boolean

Whether the event propagates through bubble handlers. See PibblEvent.

View source — packages/core/src/lib/events/types.ts:33

cancelable

readonly cancelable: boolean

Whether the originating event permits cancellation of its default action. See PibblEvent .

View source — packages/core/src/lib/events/types.ts:38

defaultPrevented

readonly defaultPrevented: boolean

Whether the default action has been prevented. See PibblEvent.

View source — packages/core/src/lib/events/types.ts:40

timeStamp

readonly timeStamp: number

Timestamp of the event in the browser event time coordinate system. See PibblEvent.

View source — packages/core/src/lib/events/types.ts:42

originalEvent

readonly originalEvent: TouchEvent

The originating browser event. See PibblEvent.

View source — packages/core/src/lib/events/types.ts:44

sourceEvent (optional)

readonly sourceEvent?: Event | undefined

The native event retained as the source of this logical event. See PibblEvent.

View source — packages/core/src/lib/events/types.ts:46

composedPath

composedPath: () => readonly PibblEventTarget[]

Related API: PibblEventTarget.

Returns the logical propagation path of the event. See PibblEventTarget.

Returns

The logical event propagation path. See PibblEventTarget.

View source — packages/core/src/lib/events/types.ts:51

preventDefault

preventDefault: () => void

Prevents the originating event’s default action when cancellation is supported. See PibblEvent.

View source — packages/core/src/lib/events/types.ts:56

stopPropagation

stopPropagation: () => void

Stops propagation to subsequent logical ancestors. See PibblEvent.

View source — packages/core/src/lib/events/types.ts:58

stopImmediatePropagation

stopImmediatePropagation: () => void

Stops remaining handlers at this target and further propagation. See PibblEvent.

View source — packages/core/src/lib/events/types.ts:60

altKey

readonly altKey: boolean

Whether Alt was held when the event occurred. See PibblModifierEvent.

View source — packages/core/src/lib/events/types.ts:175

ctrlKey

readonly ctrlKey: boolean

Whether Control was held when the event occurred. See PibblModifierEvent.

View source — packages/core/src/lib/events/types.ts:177

metaKey

readonly metaKey: boolean

Whether the platform Meta key was held when the event occurred. See PibblModifierEvent.

View source — packages/core/src/lib/events/types.ts:181

shiftKey

readonly shiftKey: boolean

Whether Shift was held when the event occurred. See PibblModifierEvent.

View source — packages/core/src/lib/events/types.ts:183

PibblWheelEvent

Pibbl’s logical wheel event, retaining the corresponding native event payload.

interface PibblWheelEvent extends PibblLogicalMouseEvent<WheelEvent>

Related API: PibblWheelEvent, PibblLogicalMouseEvent.

Properties and methods

deltaX

readonly deltaX: number

Horizontal wheel displacement in the units identified by deltaMode. See PibblWheelEvent .

View source — packages/core/src/lib/events/types.ts:295

deltaY

readonly deltaY: number

Vertical wheel displacement in the units identified by deltaMode. See PibblWheelEvent.

View source — packages/core/src/lib/events/types.ts:299

deltaZ

readonly deltaZ: number

Depth wheel displacement in the units identified by deltaMode. See PibblWheelEvent.

View source — packages/core/src/lib/events/types.ts:301

deltaMode

readonly deltaMode: number

The browser unit convention for wheel deltas. See PibblWheelEvent.

View source — packages/core/src/lib/events/types.ts:303

type

readonly type: string

Native-style name identifying the event being dispatched. See PibblEvent.

View source — packages/core/src/lib/events/types.ts:20

target

readonly target: PibblEventTarget

Related API: PibblEventTarget.

The selected logical target or target configuration. See PibblEventTarget.

View source — packages/core/src/lib/events/types.ts:22

currentTarget

readonly currentTarget: PibblEventTarget

Related API: PibblEventTarget.

The logical target whose handler is currently being dispatched. See PibblEventTarget.

View source — packages/core/src/lib/events/types.ts:24

relatedTarget

readonly relatedTarget: PibblEventTarget | null

Related API: PibblEventTarget.

The other logical target involved in a focus or boundary transition. See PibblEventTarget.

View source — packages/core/src/lib/events/types.ts:29

eventPhase

readonly eventPhase: PibblEventPhase

Related API: PibblEventPhase.

Current capture, target, or bubble phase of event propagation. See PibblEventPhase.

View source — packages/core/src/lib/events/types.ts:31

bubbles

readonly bubbles: boolean

Whether the event propagates through bubble handlers. See PibblEvent.

View source — packages/core/src/lib/events/types.ts:33

cancelable

readonly cancelable: boolean

Whether the originating event permits cancellation of its default action. See PibblEvent .

View source — packages/core/src/lib/events/types.ts:38

defaultPrevented

readonly defaultPrevented: boolean

Whether the default action has been prevented. See PibblEvent.

View source — packages/core/src/lib/events/types.ts:40

timeStamp

readonly timeStamp: number

Timestamp of the event in the browser event time coordinate system. See PibblEvent.

View source — packages/core/src/lib/events/types.ts:42

originalEvent

readonly originalEvent: WheelEvent

The originating browser event. See PibblEvent.

View source — packages/core/src/lib/events/types.ts:44

sourceEvent (optional)

readonly sourceEvent?: Event | undefined

The native event retained as the source of this logical event. See PibblEvent.

View source — packages/core/src/lib/events/types.ts:46

composedPath

composedPath: () => readonly PibblEventTarget[]

Related API: PibblEventTarget.

Returns the logical propagation path of the event. See PibblEventTarget.

Returns

The logical event propagation path. See PibblEventTarget.

View source — packages/core/src/lib/events/types.ts:51

preventDefault

preventDefault: () => void

Prevents the originating event’s default action when cancellation is supported. See PibblEvent.

View source — packages/core/src/lib/events/types.ts:56

stopPropagation

stopPropagation: () => void

Stops propagation to subsequent logical ancestors. See PibblEvent.

View source — packages/core/src/lib/events/types.ts:58

stopImmediatePropagation

stopImmediatePropagation: () => void

Stops remaining handlers at this target and further propagation. See PibblEvent.

View source — packages/core/src/lib/events/types.ts:60

altKey

readonly altKey: boolean

Whether Alt was held when the event occurred. See PibblModifierEvent.

View source — packages/core/src/lib/events/types.ts:175

ctrlKey

readonly ctrlKey: boolean

Whether Control was held when the event occurred. See PibblModifierEvent.

View source — packages/core/src/lib/events/types.ts:177

metaKey

readonly metaKey: boolean

Whether the platform Meta key was held when the event occurred. See PibblModifierEvent.

View source — packages/core/src/lib/events/types.ts:181

shiftKey

readonly shiftKey: boolean

Whether Shift was held when the event occurred. See PibblModifierEvent.

View source — packages/core/src/lib/events/types.ts:183

readonly x: number

Root-logical canvas coordinates.

View source — packages/core/src/lib/events/types.ts:197

readonly y: number

Root-logical canvas coordinates.

View source — packages/core/src/lib/events/types.ts:199

clientX

readonly clientX: number

Browser client-space horizontal coordinate. See PibblLogicalMouseEvent.

View source — packages/core/src/lib/events/types.ts:201

clientY

readonly clientY: number

Browser client-space vertical coordinate. See PibblLogicalMouseEvent.

View source — packages/core/src/lib/events/types.ts:203

screenX

readonly screenX: number

Browser screen-space horizontal coordinate. See PibblLogicalMouseEvent.

View source — packages/core/src/lib/events/types.ts:205

screenY

readonly screenY: number

Browser screen-space vertical coordinate. See PibblLogicalMouseEvent.

View source — packages/core/src/lib/events/types.ts:207

movementX

readonly movementX: number

Browser-reported horizontal motion since the previous event. See PibblLogicalMouseEvent .

View source — packages/core/src/lib/events/types.ts:212

movementY

readonly movementY: number

Browser-reported vertical motion since the previous event. See PibblLogicalMouseEvent.

View source — packages/core/src/lib/events/types.ts:216

button

readonly button: number

The button that changed state for this mouse or pointer event. See PibblLogicalMouseEvent.

View source — packages/core/src/lib/events/types.ts:221

buttons

readonly buttons: number

Bit mask of buttons held during this mouse or pointer event. See PibblLogicalMouseEvent .

View source — packages/core/src/lib/events/types.ts:226

detail

readonly detail: number

Browser mouse-event detail, such as the click count. See PibblLogicalMouseEvent.

View source — packages/core/src/lib/events/types.ts:228

PibblManipulationController

Stable controls and reactive geometry for one mounted manipulation session.

interface PibblManipulationController

Related API: PibblManipulationController.

Properties and methods

active

readonly active: Signal<PibblManipulationActive | null>

Related API: Signal, PibblManipulationActive.

Current active operation or its presentation configuration. See Signal, PibblManipulationActive.

View source — packages/core/src/lib/manipulation/controller-types.ts:297

snapshot

readonly snapshot: Signal<PibblManipulationSnapshot | null>

Related API: Signal, PibblManipulationSnapshot.

Current immutable observation of the manipulation session. See Signal, PibblManipulationSnapshot.

View source — packages/core/src/lib/manipulation/controller-types.ts:302

frameProps

readonly frameProps: PibblManipulationFrameProps

Related API: PibblManipulationFrameProps.

Props for presenting the controller’s current manipulation frame. See PibblManipulationFrameProps.

View source — packages/core/src/lib/manipulation/controller-types.ts:307

cancel

cancel: () => void

Cancels the active manipulation and applies its cancellation policy. See PibblManipulationController.

View source — packages/core/src/lib/manipulation/controller-types.ts:312

PibblManipulationOptions

Geometry, constraints, and lifecycle callbacks for a manipulation controller.

interface PibblManipulationOptions

Related API: PibblManipulationOptions.

Properties and methods

box

readonly box: WritableSignal<PibblManipulationBox>

Related API: WritableSignal, PibblManipulationBox.

Logical rectangle read and updated by the manipulation controller. See WritableSignal , PibblManipulationBox.

View source — packages/core/src/lib/manipulation/controller-types.ts:215

rotation (optional)

readonly rotation?: WritableSignal<number> | undefined

Related API: WritableSignal.

Rotation applied to the containing geometry. See WritableSignal.

View source — packages/core/src/lib/manipulation/controller-types.ts:217

move (optional)

readonly move?: PibblManipulationMoveInput | undefined

Related API: PibblManipulationMoveInput.

Configuration for translation of the manipulation target. See PibblManipulationMoveInput .

View source — packages/core/src/lib/manipulation/controller-types.ts:222

resize (optional)

readonly resize?: PibblManipulationResizeInput | undefined

Related API: PibblManipulationResizeInput.

Configuration or operation for changing the target dimensions. See PibblManipulationResizeInput.

View source — packages/core/src/lib/manipulation/controller-types.ts:227

rotate (optional)

readonly rotate?: PibblManipulationRotateInput | undefined

Related API: PibblManipulationRotateInput.

Configuration for rotation of the manipulation target. See PibblManipulationRotateInput .

View source — packages/core/src/lib/manipulation/controller-types.ts:232

onStart (optional)

readonly onStart?: ((event: PibblManipulationEvent) => void) | undefined

Related API: PibblManipulationEvent.

Receives the initial state when a manipulation begins. See PibblManipulationEvent.

Parameters

event — Current manipulation session and proposed geometry. See PibblManipulationEvent .

View source — packages/core/src/lib/manipulation/controller-types.ts:238

onChange (optional)

readonly onChange?: ((event: PibblManipulationEvent) => void) | undefined

Related API: PibblManipulationEvent.

Receives geometry changes during an active manipulation. See PibblManipulationEvent.

Parameters

event — Current manipulation session and proposed geometry. See PibblManipulationEvent .

View source — packages/core/src/lib/manipulation/controller-types.ts:244

onCommit (optional)

readonly onCommit?: ((event: PibblManipulationCommitEvent) => void) | undefined

Related API: PibblManipulationCommitEvent.

Receives the final state of a committed manipulation. See PibblManipulationCommitEvent.

Parameters

event — Successfully committed manipulation state. See PibblManipulationCommitEvent .

View source — packages/core/src/lib/manipulation/controller-types.ts:250

onCancel (optional)

readonly onCancel?: ((event: PibblManipulationCancelEvent) => void) | undefined

Related API: PibblManipulationCancelEvent.

Receives the reason and state of a cancelled manipulation. See PibblManipulationCancelEvent.

Parameters

event — Canceled manipulation state and cancellation reason. See PibblManipulationCancelEvent .

View source — packages/core/src/lib/manipulation/controller-types.ts:257

PibblManipulationSnapshot

The controller’s current geometry and active-operation state.

interface PibblManipulationSnapshot

Related API: PibblManipulationSnapshot.

Properties and methods

operation

readonly operation: PibblManipulationOperation

Related API: PibblManipulationOperation.

Kind of manipulation currently being performed. See PibblManipulationOperation.

View source — packages/core/src/lib/manipulation/controller-types.ts:78

handle

readonly handle: PibblResizePosition | null

Related API: PibblResizePosition.

Handle identity associated with the operation or body. See PibblResizePosition.

View source — packages/core/src/lib/manipulation/controller-types.ts:80

initial

readonly initial: PibblManipulationGeometry

Related API: PibblManipulationGeometry.

Geometry captured when this manipulation began. See PibblManipulationGeometry.

View source — packages/core/src/lib/manipulation/controller-types.ts:82

proposed

readonly proposed: PibblManipulationGeometry

Related API: PibblManipulationGeometry.

Geometry proposed before constraints and snapping are applied. See PibblManipulationGeometry.

View source — packages/core/src/lib/manipulation/controller-types.ts:87

applied

readonly applied: PibblManipulationGeometry

Related API: PibblManipulationGeometry.

Geometry after constraints and snapping are applied. See PibblManipulationGeometry.

View source — packages/core/src/lib/manipulation/controller-types.ts:89

snapActive

readonly snapActive: boolean

Whether snapping is currently enabled for this operation. See PibblManipulationSnapshot .

View source — packages/core/src/lib/manipulation/controller-types.ts:94

snapSatisfied

readonly snapSatisfied: boolean

Whether the applied geometry satisfies the active snap constraint. See PibblManipulationSnapshot.

View source — packages/core/src/lib/manipulation/controller-types.ts:99

PibblManipulationEvent

Geometry and operation information emitted while manipulating a target.

interface PibblManipulationEvent extends PibblManipulationSnapshot

Properties and methods

before

readonly before: PibblManipulationGeometry

Related API: PibblManipulationGeometry.

Geometry before this manipulation update. See PibblManipulationGeometry.

View source — packages/core/src/lib/manipulation/controller-types.ts:111

after

readonly after: PibblManipulationGeometry

Related API: PibblManipulationGeometry.

Geometry after this manipulation update. See PibblManipulationGeometry.

View source — packages/core/src/lib/manipulation/controller-types.ts:113

operation

readonly operation: PibblManipulationOperation

Related API: PibblManipulationOperation.

Kind of manipulation currently being performed. See PibblManipulationOperation.

View source — packages/core/src/lib/manipulation/controller-types.ts:78

handle

readonly handle: PibblResizePosition | null

Related API: PibblResizePosition.

Handle identity associated with the operation or body. See PibblResizePosition.

View source — packages/core/src/lib/manipulation/controller-types.ts:80

initial

readonly initial: PibblManipulationGeometry

Related API: PibblManipulationGeometry.

Geometry captured when this manipulation began. See PibblManipulationGeometry.

View source — packages/core/src/lib/manipulation/controller-types.ts:82

proposed

readonly proposed: PibblManipulationGeometry

Related API: PibblManipulationGeometry.

Geometry proposed before constraints and snapping are applied. See PibblManipulationGeometry.

View source — packages/core/src/lib/manipulation/controller-types.ts:87

applied

readonly applied: PibblManipulationGeometry

Related API: PibblManipulationGeometry.

Geometry after constraints and snapping are applied. See PibblManipulationGeometry.

View source — packages/core/src/lib/manipulation/controller-types.ts:89

snapActive

readonly snapActive: boolean

Whether snapping is currently enabled for this operation. See PibblManipulationSnapshot .

View source — packages/core/src/lib/manipulation/controller-types.ts:94

snapSatisfied

readonly snapSatisfied: boolean

Whether the applied geometry satisfies the active snap constraint. See PibblManipulationSnapshot.

View source — packages/core/src/lib/manipulation/controller-types.ts:99

PibblManipulationCommitEvent

The final geometry of a successfully committed manipulation.

interface PibblManipulationCommitEvent extends PibblManipulationEvent

Properties and methods

changed

readonly changed: boolean

Whether the committed geometry differs from the starting geometry. See PibblManipulationCommitEvent.

View source — packages/core/src/lib/manipulation/controller-types.ts:126

operation

readonly operation: PibblManipulationOperation

Related API: PibblManipulationOperation.

Kind of manipulation currently being performed. See PibblManipulationOperation.

View source — packages/core/src/lib/manipulation/controller-types.ts:78

handle

readonly handle: PibblResizePosition | null

Related API: PibblResizePosition.

Handle identity associated with the operation or body. See PibblResizePosition.

View source — packages/core/src/lib/manipulation/controller-types.ts:80

initial

readonly initial: PibblManipulationGeometry

Related API: PibblManipulationGeometry.

Geometry captured when this manipulation began. See PibblManipulationGeometry.

View source — packages/core/src/lib/manipulation/controller-types.ts:82

proposed

readonly proposed: PibblManipulationGeometry

Related API: PibblManipulationGeometry.

Geometry proposed before constraints and snapping are applied. See PibblManipulationGeometry.

View source — packages/core/src/lib/manipulation/controller-types.ts:87

applied

readonly applied: PibblManipulationGeometry

Related API: PibblManipulationGeometry.

Geometry after constraints and snapping are applied. See PibblManipulationGeometry.

View source — packages/core/src/lib/manipulation/controller-types.ts:89

snapActive

readonly snapActive: boolean

Whether snapping is currently enabled for this operation. See PibblManipulationSnapshot .

View source — packages/core/src/lib/manipulation/controller-types.ts:94

snapSatisfied

readonly snapSatisfied: boolean

Whether the applied geometry satisfies the active snap constraint. See PibblManipulationSnapshot.

View source — packages/core/src/lib/manipulation/controller-types.ts:99

before

readonly before: PibblManipulationGeometry

Related API: PibblManipulationGeometry.

Geometry before this manipulation update. See PibblManipulationGeometry.

View source — packages/core/src/lib/manipulation/controller-types.ts:111

after

readonly after: PibblManipulationGeometry

Related API: PibblManipulationGeometry.

Geometry after this manipulation update. See PibblManipulationGeometry.

View source — packages/core/src/lib/manipulation/controller-types.ts:113

PibblManipulationCancelEvent

Cancellation reason and geometry information for an abandoned manipulation.

interface PibblManipulationCancelEvent extends PibblManipulationEvent

Properties and methods

reason

readonly reason: PibblManipulationCancelReason

Related API: PibblManipulationCancelReason.

Reason the operation could not produce its ordinary result. See PibblManipulationCancelReason.

View source — packages/core/src/lib/manipulation/controller-types.ts:140

operation

readonly operation: PibblManipulationOperation

Related API: PibblManipulationOperation.

Kind of manipulation currently being performed. See PibblManipulationOperation.

View source — packages/core/src/lib/manipulation/controller-types.ts:78

handle

readonly handle: PibblResizePosition | null

Related API: PibblResizePosition.

Handle identity associated with the operation or body. See PibblResizePosition.

View source — packages/core/src/lib/manipulation/controller-types.ts:80

initial

readonly initial: PibblManipulationGeometry

Related API: PibblManipulationGeometry.

Geometry captured when this manipulation began. See PibblManipulationGeometry.

View source — packages/core/src/lib/manipulation/controller-types.ts:82

proposed

readonly proposed: PibblManipulationGeometry

Related API: PibblManipulationGeometry.

Geometry proposed before constraints and snapping are applied. See PibblManipulationGeometry.

View source — packages/core/src/lib/manipulation/controller-types.ts:87

applied

readonly applied: PibblManipulationGeometry

Related API: PibblManipulationGeometry.

Geometry after constraints and snapping are applied. See PibblManipulationGeometry.

View source — packages/core/src/lib/manipulation/controller-types.ts:89

snapActive

readonly snapActive: boolean

Whether snapping is currently enabled for this operation. See PibblManipulationSnapshot .

View source — packages/core/src/lib/manipulation/controller-types.ts:94

snapSatisfied

readonly snapSatisfied: boolean

Whether the applied geometry satisfies the active snap constraint. See PibblManipulationSnapshot.

View source — packages/core/src/lib/manipulation/controller-types.ts:99

before

readonly before: PibblManipulationGeometry

Related API: PibblManipulationGeometry.

Geometry before this manipulation update. See PibblManipulationGeometry.

View source — packages/core/src/lib/manipulation/controller-types.ts:111

after

readonly after: PibblManipulationGeometry

Related API: PibblManipulationGeometry.

Geometry after this manipulation update. See PibblManipulationGeometry.

View source — packages/core/src/lib/manipulation/controller-types.ts:113

PibblManipulationCancelReason

Why an active manipulation session was cancelled.

type PibblManipulationCancelReason = | "explicit"
  | "escape"
  | "pointer-cancel"
  | "capture-lost"
  | "disabled"
  | "external-change"
  | "coordinate-space-changed"
  | "constraints-unsatisfiable"

Related API: PibblManipulationCancelReason.

PibblManipulationGeometry

The box and rotation that a manipulation controller reads and updates.

interface PibblManipulationGeometry

Related API: PibblManipulationGeometry.

Properties and methods

box

readonly box: PibblManipulationBox

Related API: PibblManipulationBox.

Logical rectangle read and updated by the manipulation controller. See PibblManipulationBox.

View source — packages/core/src/lib/manipulation/controller-types.ts:27

rotation

readonly rotation: number

Rotation applied to the containing geometry. See PibblManipulationGeometry.

View source — packages/core/src/lib/manipulation/controller-types.ts:29

PibblManipulationOperation

The move, resize, or rotate operation performed by a manipulation session.

type PibblManipulationOperation = "move" | "resize" | "rotate"

Related API: PibblManipulationOperation.

PibblManipulationActive

Details identifying an operation currently in progress.

interface PibblManipulationActive

Related API: PibblManipulationActive.

Properties and methods

operation

readonly operation: PibblManipulationOperation

Related API: PibblManipulationOperation.

Kind of manipulation currently being performed. See PibblManipulationOperation.

View source — packages/core/src/lib/manipulation/controller-types.ts:61

handle

readonly handle: PibblResizePosition | null

Related API: PibblResizePosition.

Handle identity associated with the operation or body. See PibblResizePosition.

View source — packages/core/src/lib/manipulation/controller-types.ts:63

pointerId

readonly pointerId: number

Browser identifier of the active pointer. See PibblManipulationActive.

View source — packages/core/src/lib/manipulation/controller-types.ts:65

PibblManipulationFrameProps

Authored inputs for ManipulationFrame, including the declared data and presentation options.

interface PibblManipulationFrameProps

Related API: PibblManipulationFrameProps.

Properties and methods

controller

readonly controller: PibblManipulationController

Related API: PibblManipulationController.

Controller owning the current interaction or mounted scenario. See PibblManipulationController.

View source — packages/core/src/lib/manipulation/controller-types.ts:273

style

readonly style: WritableSignal<PibblManipulationBox>

Related API: WritableSignal, PibblManipulationBox.

Declared presentation and layout properties. See WritableSignal, PibblManipulationBox.

View source — packages/core/src/lib/manipulation/controller-types.ts:278

children (optional)

readonly children?: PibblNode

Related API: PibblNode.

Descendant content or the callback that supplies it. See PibblNode.

View source — packages/core/src/lib/manipulation/controller-types.ts:280

PibblManipulationMoveInput

Translation constraints and signal-capable enablement and snapping configuration.

type PibblManipulationMoveInput = Omit<PibblManipulationMoveOptions, "snap"> & {
  /** Whether this operation or resource participates in updates. See {@link SignalValue}. */
  readonly enabled?: SignalValue<boolean>;
  /**
   * Snapping configuration for the manipulation operation. See {@link PibblManipulationMoveOptions}
   * , {@link SignalValue}.
   */
  readonly snap?: Omit<NonNullable<PibblManipulationMoveOptions["snap"]>, "enabled"> & {
    /** Whether this operation or resource participates in updates. See {@link SignalValue}. */
    readonly enabled?: SignalValue<boolean>;
  };
}

Related API: PibblManipulationMoveInput, SignalValue.

Properties and methods

axis (optional)

readonly axis?: "both" | "x" | "y" | undefined

Selects "both", "x", "y" for axis. See PibblManipulationMoveOptions.

View source — packages/core/src/lib/manipulation/types.ts:90

bounds (optional)

readonly bounds?: PibblManipulationBox | undefined

Related API: PibblManipulationBox.

Logical region constraining the content or query. See PibblManipulationBox.

View source — packages/core/src/lib/manipulation/types.ts:92

enabled (optional)

readonly enabled?: SignalValue<boolean> | undefined

Related API: SignalValue.

Whether this operation or resource participates in updates. See SignalValue.

View source — packages/core/src/lib/manipulation/controller-types.ts:151

snap (optional)

readonly snap?: (Omit<import("./types.js").PibblManipulationMoveSnap, "enabled"> & { readonly enabled?: SignalValue<boolean>; }) | undefined

Related API: SignalValue.

Snapping configuration for the manipulation operation. See PibblManipulationMoveOptions , SignalValue.

View source — packages/core/src/lib/manipulation/controller-types.ts:156

PibblManipulationResizeInput

Resize constraints and signal-capable enablement and snapping configuration.

type PibblManipulationResizeInput = Omit<PibblManipulationResizeOptions, "snap"> & {
  /** Whether this operation or resource participates in updates. See {@link SignalValue}. */
  readonly enabled?: SignalValue<boolean>;
  /**
   * Snapping configuration for the manipulation operation. See {@link SignalEnabled},
   * {@link PibblManipulationResizeOptions}.
   */
  readonly snap?: SignalEnabled<NonNullable<PibblManipulationResizeOptions["snap"]>>;
}

Properties and methods

minWidth (optional)

readonly minWidth?: number | undefined

Minimum permitted width. See PibblManipulationResizeOptions.

View source — packages/core/src/lib/manipulation/types.ts:125

minHeight (optional)

readonly minHeight?: number | undefined

Minimum permitted height. See PibblManipulationResizeOptions.

View source — packages/core/src/lib/manipulation/types.ts:127

maxWidth (optional)

readonly maxWidth?: number | undefined

Maximum permitted width. See PibblManipulationResizeOptions.

View source — packages/core/src/lib/manipulation/types.ts:129

maxHeight (optional)

readonly maxHeight?: number | undefined

Maximum permitted height. See PibblManipulationResizeOptions.

View source — packages/core/src/lib/manipulation/types.ts:131

bounds (optional)

readonly bounds?: PibblManipulationBox | undefined

Related API: PibblManipulationBox.

Logical region constraining the content or query. See PibblManipulationBox.

View source — packages/core/src/lib/manipulation/types.ts:133

aspectRatio (optional)

readonly aspectRatio?: PibblManipulationAspectRatio | undefined

Constraint on the manipulated width-to-height ratio. See PibblManipulationAspectRatio.

View source — packages/core/src/lib/manipulation/types.ts:137

enabled (optional)

readonly enabled?: SignalValue<boolean> | undefined

Related API: SignalValue.

Whether this operation or resource participates in updates. See SignalValue.

View source — packages/core/src/lib/manipulation/controller-types.ts:173

snap (optional)

readonly snap?: (Omit<import("./types.js").PibblManipulationResizeGridSnap, "enabled"> & { readonly enabled?: SignalValue<boolean>; }) | (Omit<import("./types.js").PibblManipulationResizeSizeSnap, "enabled"> & { readonly enabled?: SignalValue<boolean>; }) | undefined

Related API: SignalValue.

Snapping configuration for the manipulation operation. See SignalEnabled, PibblManipulationResizeOptions.

View source — packages/core/src/lib/manipulation/controller-types.ts:178

PibblManipulationRotateInput

Rotation constraints and signal-capable enablement and snapping configuration.

type PibblManipulationRotateInput = Omit<PibblManipulationRotateOptions, "snap"> & {
  /** Whether this operation or resource participates in updates. See {@link SignalValue}. */
  readonly enabled?: SignalValue<boolean>;
  /**
   * Snapping configuration for the manipulation operation. See {@link SignalEnabled},
   * {@link PibblManipulationRotateOptions}.
   */
  readonly snap?: SignalEnabled<NonNullable<PibblManipulationRotateOptions["snap"]>>;
}

Properties and methods

enabled (optional)

readonly enabled?: SignalValue<boolean> | undefined

Related API: SignalValue.

Whether this operation or resource participates in updates. See SignalValue.

View source — packages/core/src/lib/manipulation/controller-types.ts:189

snap (optional)

readonly snap?: (Omit<import("./types.js").PibblManipulationRotateSnap, "enabled"> & { readonly enabled?: SignalValue<boolean>; }) | undefined

Related API: SignalValue.

Snapping configuration for the manipulation operation. See SignalEnabled, PibblManipulationRotateOptions.

View source — packages/core/src/lib/manipulation/controller-types.ts:194

PibblManipulationBox

Position and dimensions of a manipulation target in logical coordinates.

interface PibblManipulationBox

Related API: PibblManipulationBox.

Properties and methods

left

readonly left: number

Left edge coordinate or inset. See PibblManipulationBox.

View source — packages/core/src/lib/manipulation/types.ts:12

top

readonly top: number

Top edge value or top envelope guide. See PibblManipulationBox.

View source — packages/core/src/lib/manipulation/types.ts:14

width

readonly width: number

Horizontal extent in the units of the containing geometry or surface. See PibblManipulationBox.

View source — packages/core/src/lib/manipulation/types.ts:19

height

readonly height: number

Vertical extent in the units of the containing geometry or surface. See PibblManipulationBox.

View source — packages/core/src/lib/manipulation/types.ts:24

PibblManipulationPoint

A manipulation input point in logical coordinates.

interface PibblManipulationPoint

Related API: PibblManipulationPoint.

Properties and methods

readonly x: number

Horizontal coordinate or displacement in the containing coordinate system. See PibblManipulationPoint.

View source — packages/core/src/lib/manipulation/types.ts:37

readonly y: number

Vertical coordinate or displacement in the containing coordinate system. See PibblManipulationPoint.

View source — packages/core/src/lib/manipulation/types.ts:42

PibblManipulationWhen

Modifier-key condition used to activate manipulation snapping or affordances.

type PibblManipulationWhen = 'always' | 'shift' | 'alt' | 'ctrl' | 'meta'

Related API: PibblManipulationWhen.

PibblResizePosition

An edge or corner at which a resize handle is placed.

type PibblResizePosition = | 'top-left'
  | 'top'
  | 'top-right'
  | 'right'
  | 'bottom-right'
  | 'bottom'
  | 'bottom-left'
  | 'left'

Related API: PibblResizePosition.

PibblDragHandleProps

Authored inputs for DragHandle, including the declared data and presentation options.

interface PibblDragHandleProps

Related API: PibblDragHandleProps.

Properties and methods

formatReadout (optional)

readonly formatReadout?: ((value: { readonly left: number; readonly top: number; }) => string) | undefined

Formats the value shown by the manipulation readout. See PibblDragHandleProps.

Parameters

value — Current left and top coordinates.

Returns

Text to display in the drag readout.

View source — packages/core/src/lib/manipulation/handles.ts:44

controller

readonly controller: PibblManipulationController

Related API: PibblManipulationController.

Controller owning the current interaction or mounted scenario. See PibblManipulationController.

View source — packages/core/src/lib/manipulation/handles.ts:54

children (optional)

readonly children?: PibblNode

Related API: PibblNode.

Descendant content or the callback that supplies it. See PibblNode.

View source — packages/core/src/lib/manipulation/handles.ts:56

PibblDragHandleStyle

Supported geometry and presentation properties for DragHandle.

interface PibblDragHandleStyle extends GStyle

Related API: PibblDragHandleStyle, GStyle.

Properties and methods

width (optional)

width?: Length | undefined

Related API: Length.

Horizontal extent in the units of the containing geometry or surface. See Length.

View source — packages/core/src/lib/style/types.ts:81

height (optional)

height?: Length | undefined

Related API: Length.

Vertical extent in the units of the containing geometry or surface. See Length.

View source — packages/core/src/lib/style/types.ts:83

readout (optional)

readonly readout?: boolean | PibblManipulationReadoutStyle | undefined

Related API: PibblManipulationReadoutStyle.

Presentation of the manipulation value readout. See PibblManipulationReadoutStyle.

View source — packages/core/src/lib/manipulation/handles.ts:68

left (optional)

left?: number | `${number}%` | undefined

Left edge coordinate or inset. See Length.

View source — packages/core/src/lib/style/positioning.ts:127

top (optional)

top?: number | `${number}%` | undefined

Top edge value or top envelope guide. See Length.

View source — packages/core/src/lib/style/positioning.ts:129

minWidth (optional)

minWidth?: number | `${number}%` | undefined

Minimum permitted width. See Length.

View source — packages/core/src/lib/style/types.ts:85

maxWidth (optional)

maxWidth?: number | `${number}%` | undefined

Maximum permitted width. See Length.

View source — packages/core/src/lib/style/types.ts:87

minHeight (optional)

minHeight?: number | `${number}%` | undefined

Minimum permitted height. See Length.

View source — packages/core/src/lib/style/types.ts:89

maxHeight (optional)

maxHeight?: number | `${number}%` | undefined

Maximum permitted height. See Length.

View source — packages/core/src/lib/style/types.ts:91

padding (optional)

padding?: EdgeValues | undefined

Related API: EdgeValues.

Insets between the border box and content box. See EdgeValues.

View source — packages/core/src/lib/style/types.ts:93

overflow (optional)

overflow?: "clip" | "visible" | undefined

Selects "visible", "clip" for overflow. See BoxStyle.

View source — packages/core/src/lib/style/types.ts:95

alignSelf (optional)

alignSelf?: "auto" | "center" | "end" | "flex-end" | "flex-start" | "start" | "stretch" | undefined

This child’s cross-axis or block-axis alignment override. See LayoutItemStyle.

View source — packages/core/src/lib/style/types.ts:121

justifySelf (optional)

justifySelf?: "auto" | "center" | "end" | "start" | "stretch" | undefined

This child’s inline-axis alignment override. See LayoutItemStyle.

View source — packages/core/src/lib/style/types.ts:123

flexBasis (optional)

flexBasis?: Length | undefined

Related API: Length.

Initial main-axis size before flex growth or shrinkage. See Length.

View source — packages/core/src/lib/style/types.ts:125

flexGrow (optional)

flexGrow?: number | undefined

Relative share of positive free space assigned to this child. See LayoutItemStyle.

View source — packages/core/src/lib/style/types.ts:127

flexShrink (optional)

flexShrink?: number | undefined

Relative factor used when reducing main-axis size. See LayoutItemStyle.

View source — packages/core/src/lib/style/types.ts:129

gridColumnStart (optional)

gridColumnStart?: number | undefined

Explicit starting grid column. See LayoutItemStyle.

View source — packages/core/src/lib/style/types.ts:131

gridColumnSpan (optional)

gridColumnSpan?: number | undefined

Number of columns occupied by this child. See LayoutItemStyle.

View source — packages/core/src/lib/style/types.ts:133

gridRowStart (optional)

gridRowStart?: number | undefined

Explicit starting grid row. See LayoutItemStyle.

View source — packages/core/src/lib/style/types.ts:135

gridRowSpan (optional)

gridRowSpan?: number | undefined

Number of rows occupied by this child. See LayoutItemStyle.

View source — packages/core/src/lib/style/types.ts:137

scaleX (optional)

scaleX?: number | undefined

Horizontal scale factor. See GStyle.

View source — packages/core/src/lib/components/g.ts:45

scaleY (optional)

scaleY?: number | undefined

Vertical scale factor. See GStyle.

View source — packages/core/src/lib/components/g.ts:47

rotationDegrees (optional)

rotationDegrees?: number | undefined

Clockwise rotation in degrees.

View source — packages/core/src/lib/components/g.ts:49

rotationOrigin (optional)

rotationOrigin?: [number, number] | undefined

Point around which the rotation is applied. See GStyle.

View source — packages/core/src/lib/components/g.ts:51

translateX (optional)

translateX?: number | undefined

Horizontal translation in the current logical coordinate system. See GStyle.

View source — packages/core/src/lib/components/g.ts:53

translateY (optional)

translateY?: number | undefined

Vertical translation in the current logical coordinate system. See GStyle.

View source — packages/core/src/lib/components/g.ts:55

skewX (optional)

skewX?: number | undefined

Horizontal skew angle in degrees.

View source — packages/core/src/lib/components/g.ts:57

skewY (optional)

skewY?: number | undefined

Vertical skew angle in degrees.

View source — packages/core/src/lib/components/g.ts:59

transition (optional)

transition?: PibblTransitionBinding | undefined

Related API: PibblTransitionBinding.

Visibility-transition binding applied to this primitive and its captured descendants. See SystemStyle.

View source — packages/core/src/lib/types.ts:69

custom (optional)

custom?: unknown

Application-defined style payload passed through the runtime. See SystemStyle.

View source — packages/core/src/lib/types.ts:71

filter (optional)

filter?: PibblFilter | readonly PibblFilter[] | undefined

Related API: PibblFilter.

Ordered pixel-only filters applied to the receiving primitive and its descendants. See PibblFilter.

View source — packages/core/src/lib/types.ts:76

PibblResizeHandleProps

Authored inputs for ResizeHandle, including the declared data and presentation options.

interface PibblResizeHandleProps

Related API: PibblResizeHandleProps.

Properties and methods

controller

readonly controller: PibblManipulationController

Related API: PibblManipulationController.

Controller owning the current interaction or mounted scenario. See PibblManipulationController.

View source — packages/core/src/lib/manipulation/handles.ts:303

position

readonly position: PibblResizePosition

Related API: PibblResizePosition.

Position of the geometry, source, or selected resize handle. See PibblResizeHandleProps .

View source — packages/core/src/lib/manipulation/handles.ts:308

hitSize (optional)

readonly hitSize?: number | undefined

Size of the handle’s interactive hit region. See PibblResizeHandleProps.

View source — packages/core/src/lib/manipulation/handles.ts:310

formatReadout (optional)

readonly formatReadout?: ((value: { readonly width: number; readonly height: number; }) => string) | undefined

Formats the value shown by the manipulation readout. See PibblResizeHandleProps.

Parameters

value — Current width and height.

Returns

Text to display in the resize readout.

View source — packages/core/src/lib/manipulation/handles.ts:316

children (optional)

readonly children?: PibblNode

Related API: PibblNode.

Descendant content or the callback that supplies it. See PibblNode.

View source — packages/core/src/lib/manipulation/handles.ts:329

PibblResizeHandlesProps

Authored inputs for ResizeHandles, including the declared data and presentation options.

interface PibblResizeHandlesProps

Related API: PibblResizeHandlesProps.

Properties and methods

controller

readonly controller: PibblManipulationController

Related API: PibblManipulationController.

Controller owning the current interaction or mounted scenario. See PibblManipulationController.

View source — packages/core/src/lib/manipulation/handles.ts:346

positions (optional)

readonly positions?: "corners" | "edges-and-corners" | readonly PibblResizePosition[] | undefined

Related API: PibblResizePosition.

Edges and corners at which resize handles are created. See PibblResizeHandlesProps.

View source — packages/core/src/lib/manipulation/handles.ts:348

hitSize (optional)

readonly hitSize?: number | undefined

Size of the handle’s interactive hit region. See PibblResizeHandlesProps.

View source — packages/core/src/lib/manipulation/handles.ts:351

style (optional)

readonly style?: PibblResizeHandleStyle | undefined

Related API: PibblResizeHandleStyle.

Declared presentation and layout properties. See PibblResizeHandleStyle.

View source — packages/core/src/lib/manipulation/handles.ts:353

formatReadout (optional)

readonly formatReadout?: ((value: { readonly width: number; readonly height: number; }) => string) | undefined

Formats the value shown by the manipulation readout. See PibblResizeHandleProps.

View source — packages/core/src/lib/manipulation/handles.ts:355

PibblRotationHandleProps

Authored inputs for RotationHandle, including the declared data and presentation options.

interface PibblRotationHandleProps

Related API: PibblRotationHandleProps.

Properties and methods

controller

readonly controller: PibblManipulationController

Related API: PibblManipulationController.

Controller owning the current interaction or mounted scenario. See PibblManipulationController.

View source — packages/core/src/lib/manipulation/handles.ts:584

hitSize (optional)

readonly hitSize?: number | undefined

Size of the handle’s interactive hit region. See PibblRotationHandleProps.

View source — packages/core/src/lib/manipulation/handles.ts:586

readoutUnit (optional)

readonly readoutUnit?: "degrees" | "radians" | undefined

Related API: degrees.

Selects "degrees", "radians" for readout unit. See PibblRotationHandleProps.

View source — packages/core/src/lib/manipulation/handles.ts:588

formatReadout (optional)

readonly formatReadout?: ((value: { readonly rotation: number; }) => string) | undefined

Formats the value shown by the manipulation readout. See PibblRotationHandleProps.

Parameters

value — Current rotation.

Returns

Text to display in the rotation readout.

View source — packages/core/src/lib/manipulation/handles.ts:594

children (optional)

readonly children?: PibblNode

Related API: PibblNode.

Descendant content or the callback that supplies it. See PibblNode.

View source — packages/core/src/lib/manipulation/handles.ts:599

PibblResizeHandleStyle

Supported geometry and presentation properties for ResizeHandle.

interface PibblResizeHandleStyle extends SystemStyle

Related API: PibblResizeHandleStyle, SystemStyle.

Properties and methods

readout (optional)

readonly readout?: boolean | PibblManipulationReadoutStyle | undefined

Related API: PibblManipulationReadoutStyle.

Presentation of the manipulation value readout. See PibblManipulationReadoutStyle.

View source — packages/core/src/lib/manipulation/handles.ts:238

transition (optional)

transition?: PibblTransitionBinding | undefined

Related API: PibblTransitionBinding.

Visibility-transition binding applied to this primitive and its captured descendants. See SystemStyle.

View source — packages/core/src/lib/types.ts:69

custom (optional)

custom?: unknown

Application-defined style payload passed through the runtime. See SystemStyle.

View source — packages/core/src/lib/types.ts:71

filter (optional)

filter?: PibblFilter | readonly PibblFilter[] | undefined

Related API: PibblFilter.

Ordered pixel-only filters applied to the receiving primitive and its descendants. See PibblFilter.

View source — packages/core/src/lib/types.ts:76

PibblRotationHandleStyle

Supported geometry and presentation properties for RotationHandle.

interface PibblRotationHandleStyle extends SystemStyle

Related API: PibblRotationHandleStyle, SystemStyle.

Properties and methods

connector (optional)

readonly connector?: boolean | PibblRotationConnectorStyle | undefined

Related API: PibblRotationConnectorStyle.

Presentation of the line connecting the rotation handle to its target. See PibblRotationConnectorStyle.

View source — packages/core/src/lib/manipulation/handles.ts:283

arc (optional)

readonly arc?: boolean | PibblRotationArcStyle | undefined

Related API: PibblRotationArcStyle.

Presentation of the rotation-angle arc. See PibblRotationArcStyle.

View source — packages/core/src/lib/manipulation/handles.ts:285

readout (optional)

readonly readout?: boolean | PibblManipulationReadoutStyle | undefined

Related API: PibblManipulationReadoutStyle.

Presentation of the manipulation value readout. See PibblManipulationReadoutStyle.

View source — packages/core/src/lib/manipulation/handles.ts:287

transition (optional)

transition?: PibblTransitionBinding | undefined

Related API: PibblTransitionBinding.

Visibility-transition binding applied to this primitive and its captured descendants. See SystemStyle.

View source — packages/core/src/lib/types.ts:69

custom (optional)

custom?: unknown

Application-defined style payload passed through the runtime. See SystemStyle.

View source — packages/core/src/lib/types.ts:71

filter (optional)

filter?: PibblFilter | readonly PibblFilter[] | undefined

Related API: PibblFilter.

Ordered pixel-only filters applied to the receiving primitive and its descendants. See PibblFilter.

View source — packages/core/src/lib/types.ts:76

PibblManipulationReadoutStyle

Supported geometry and presentation properties for ManipulationReadout.

interface PibblManipulationReadoutStyle extends PibblManipulationReadoutStateStyle

Properties and methods

inactive (optional)

readonly inactive?: PibblManipulationReadoutStateStyle | undefined

Readout presentation while no interaction is active. See PibblManipulationReadoutStateStyle.

View source — packages/core/src/lib/manipulation/handles.ts:216

focused (optional)

readonly focused?: PibblManipulationReadoutStateStyle | undefined

Readout presentation while the handle has keyboard focus. See PibblManipulationReadoutStateStyle.

View source — packages/core/src/lib/manipulation/handles.ts:221

active (optional)

readonly active?: PibblManipulationReadoutStateStyle | undefined

Current active operation or its presentation configuration. See PibblManipulationReadoutStateStyle.

View source — packages/core/src/lib/manipulation/handles.ts:226

gap (optional)

readonly gap?: number | undefined

Minimum outward spacing in CSS pixels; defaults to 40 for drag, 5 otherwise.

View source — packages/core/src/lib/manipulation/handles.ts:186

font (optional)

readonly font?: string | undefined

Canvas font string used to draw or measure text. See PibblManipulationReadoutStateStyle .

View source — packages/core/src/lib/manipulation/handles.ts:191

fill (optional)

readonly fill?: string | undefined

Paint used for the interior. See PibblManipulationReadoutStateStyle.

View source — packages/core/src/lib/manipulation/handles.ts:193

stroke (optional)

readonly stroke?: string | undefined

Paint used for the outline. See PibblManipulationReadoutStateStyle.

View source — packages/core/src/lib/manipulation/handles.ts:195

strokeWidth (optional)

readonly strokeWidth?: number | undefined

Width of the painted outline. See PibblManipulationReadoutStateStyle.

View source — packages/core/src/lib/manipulation/handles.ts:197

opacity (optional)

readonly opacity?: number | undefined

Related API: opacity.

Opacity of the painted result. See PibblManipulationReadoutStateStyle.

View source — packages/core/src/lib/manipulation/handles.ts:199

visible (optional)

readonly visible?: boolean | undefined

Whether this presentation is visible. See PibblManipulationReadoutStateStyle.

View source — packages/core/src/lib/manipulation/handles.ts:201

PibblManipulationReadoutStateStyle

Supported geometry and presentation properties for ManipulationReadoutState.

interface PibblManipulationReadoutStateStyle

Properties and methods

gap (optional)

readonly gap?: number | undefined

Minimum outward spacing in CSS pixels; defaults to 40 for drag, 5 otherwise.

View source — packages/core/src/lib/manipulation/handles.ts:186

font (optional)

readonly font?: string | undefined

Canvas font string used to draw or measure text. See PibblManipulationReadoutStateStyle .

View source — packages/core/src/lib/manipulation/handles.ts:191

fill (optional)

readonly fill?: string | undefined

Paint used for the interior. See PibblManipulationReadoutStateStyle.

View source — packages/core/src/lib/manipulation/handles.ts:193

stroke (optional)

readonly stroke?: string | undefined

Paint used for the outline. See PibblManipulationReadoutStateStyle.

View source — packages/core/src/lib/manipulation/handles.ts:195

strokeWidth (optional)

readonly strokeWidth?: number | undefined

Width of the painted outline. See PibblManipulationReadoutStateStyle.

View source — packages/core/src/lib/manipulation/handles.ts:197

opacity (optional)

readonly opacity?: number | undefined

Related API: opacity.

Opacity of the painted result. See PibblManipulationReadoutStateStyle.

View source — packages/core/src/lib/manipulation/handles.ts:199

visible (optional)

readonly visible?: boolean | undefined

Whether this presentation is visible. See PibblManipulationReadoutStateStyle.

View source — packages/core/src/lib/manipulation/handles.ts:201

PibblRotationConnectorStyle

Supported geometry and presentation properties for RotationConnector.

interface PibblRotationConnectorStyle

Related API: PibblRotationConnectorStyle.

Properties and methods

stroke (optional)

readonly stroke?: string | undefined

Paint used for the outline. See PibblRotationConnectorStyle.

View source — packages/core/src/lib/manipulation/handles.ts:247

strokeWidth (optional)

readonly strokeWidth?: number | undefined

Width of the painted outline. See PibblRotationConnectorStyle.

View source — packages/core/src/lib/manipulation/handles.ts:249

opacity (optional)

readonly opacity?: number | undefined

Related API: opacity.

Opacity of the painted result. See PibblRotationConnectorStyle.

View source — packages/core/src/lib/manipulation/handles.ts:251

PibblRotationArcStyle

Supported geometry and presentation properties for RotationArc.

interface PibblRotationArcStyle

Related API: PibblRotationArcStyle.

Properties and methods

color (optional)

readonly color?: string | undefined

Color used by the mark or effect. See PibblRotationArcStyle.

View source — packages/core/src/lib/manipulation/handles.ts:260

sweep (optional)

readonly sweep?: number | undefined

Angular extent of the arc. See PibblRotationArcStyle.

View source — packages/core/src/lib/manipulation/handles.ts:262

strokeWidth (optional)

readonly strokeWidth?: number | undefined

Width of the painted outline. See PibblRotationArcStyle.

View source — packages/core/src/lib/manipulation/handles.ts:264

opacity (optional)

readonly opacity?: number | undefined

Related API: opacity.

Opacity of the painted result. See PibblRotationArcStyle.

View source — packages/core/src/lib/manipulation/handles.ts:266

PibblManipulableProps

Authored inputs for Manipulable, including the declared data and presentation options.

interface PibblManipulableProps extends Pick<
  PibblManipulationOptions,
  "rotation" | "onStart" | "onChange" | "onCommit" | "onCancel"
>

Properties and methods

style

readonly style: WritableSignal<PibblManipulationBox>

Related API: WritableSignal, PibblManipulationBox.

Declared presentation and layout properties. See WritableSignal, PibblManipulationBox.

View source — packages/core/src/lib/manipulation/manipulable.ts:47

draggable (optional)

readonly draggable?: boolean | PibblManipulationMoveInput | undefined

Related API: PibblManipulationMoveInput.

Enables or configures translation of the target. See PibblManipulationMoveInput.

View source — packages/core/src/lib/manipulation/manipulable.ts:49

resizable (optional)

readonly resizable?: boolean | PibblManipulationResizeInput | undefined

Related API: PibblManipulationResizeInput.

Enables or configures resizing of the target. See PibblManipulationResizeInput.

View source — packages/core/src/lib/manipulation/manipulable.ts:51

rotatable (optional)

readonly rotatable?: boolean | PibblManipulationRotateInput | undefined

Related API: PibblManipulationRotateInput.

Enables or configures rotation of the target. See PibblManipulationRotateInput.

View source — packages/core/src/lib/manipulation/manipulable.ts:53

resizeHandles (optional)

readonly resizeHandles?: "corners" | "edges-and-corners" | Omit<PibblResizeHandlesProps, "controller"> | readonly PibblResizePosition[] | undefined

Configuration of the target’s resize handles. See PibblResizeHandlesProps.

View source — packages/core/src/lib/manipulation/manipulable.ts:55

rotationHandle (optional)

readonly rotationHandle?: (Omit<PibblRotationHandleProps, "children" | "controller"> & { readonly style?: PibblRotationHandleStyle; }) | undefined

Configuration of the target’s rotation handle. See PibblRotationHandleProps, PibblRotationHandleStyle.

View source — packages/core/src/lib/manipulation/manipulable.ts:61

dragHandle (optional)

readonly dragHandle?: (Omit<PibblDragHandleProps, "children" | "controller"> & { readonly style?: PibblDragHandleStyle; }) | undefined

Configuration of the target’s drag handle. See PibblDragHandleProps, PibblDragHandleStyle.

View source — packages/core/src/lib/manipulation/manipulable.ts:69

children (optional)

readonly children?: PibblNode

Related API: PibblNode.

Descendant content or the callback that supplies it. See PibblNode.

View source — packages/core/src/lib/manipulation/manipulable.ts:74

rotation (optional)

readonly rotation?: WritableSignal<number> | undefined

Related API: WritableSignal.

Rotation applied to the containing geometry. See WritableSignal.

View source — packages/core/src/lib/manipulation/controller-types.ts:217

onStart (optional)

readonly onStart?: ((event: PibblManipulationEvent) => void) | undefined

Related API: PibblManipulationEvent.

Receives the initial state when a manipulation begins. See PibblManipulationEvent.

Parameters

event — Current manipulation session and proposed geometry. See PibblManipulationEvent .

View source — packages/core/src/lib/manipulation/controller-types.ts:238

onChange (optional)

readonly onChange?: ((event: PibblManipulationEvent) => void) | undefined

Related API: PibblManipulationEvent.

Receives geometry changes during an active manipulation. See PibblManipulationEvent.

Parameters

event — Current manipulation session and proposed geometry. See PibblManipulationEvent .

View source — packages/core/src/lib/manipulation/controller-types.ts:244

onCommit (optional)

readonly onCommit?: ((event: PibblManipulationCommitEvent) => void) | undefined

Related API: PibblManipulationCommitEvent.

Receives the final state of a committed manipulation. See PibblManipulationCommitEvent.

Parameters

event — Successfully committed manipulation state. See PibblManipulationCommitEvent .

View source — packages/core/src/lib/manipulation/controller-types.ts:250

onCancel (optional)

readonly onCancel?: ((event: PibblManipulationCancelEvent) => void) | undefined

Related API: PibblManipulationCancelEvent.

Receives the reason and state of a cancelled manipulation. See PibblManipulationCancelEvent.

Parameters

event — Canceled manipulation state and cancellation reason. See PibblManipulationCancelEvent .

View source — packages/core/src/lib/manipulation/controller-types.ts:257

Implementation guidance for agents

Read the Input, focus, and native HTML companion for ownership, adaptation, failure modes, and verification. Agent start provides the version-selection workflow.

Complete minimal examples

Typed event target: A geometric Canvas target routes pointer, mouse, touch, wheel, keyboard, input, clipboard, and drag events. Plain source
Own a manipulation controller: Compose a drag surface and one resize handle, inspect gesture state, and cancel explicitly. Plain source
Style resize and rotation handles: Add corner handles, a rotation connector, an angle arc, and gesture readouts. Plain source
Focus and arrow navigation: Two logical targets participate in Tab focus and directional keyboard navigation. Plain source
Drag, resize, and rotate: Use the convenience component with a writable geometry box. Plain source

Documentation version

Documentation built with @pibbl/core 0.0.2, revision 2dccb19. ALPHA — NOT FOR PRODUCTION USE.

Event types

PibblClipboardEvent

PibblCompositionEvent

PibblDragEvent

PibblDragHandleProps

PibblDragHandleStyle

PibblEvent

PibblEventCapturePropName

PibblEventHandler

PibblEventHandlers

PibblEventMap

PibblEventParticipationOptions

PibblEventPhase

PibblEventPropName

PibblEventTarget

PibblEventTargetOptions

PibblEventTargetSnapshot

PibblEventType

PibblFocusEvent

PibblInputEvent

PibblKeyboardEvent

PibblKeyboardNavigationOptions

PibblLogicalMouseEvent

PibblManipulableProps

PibblManipulationActive

PibblManipulationBox

PibblManipulationCancelEvent

PibblManipulationCancelReason

PibblManipulationCommitEvent

PibblManipulationController

PibblManipulationEvent

PibblManipulationFrameProps

PibblManipulationGeometry

PibblManipulationMoveInput

PibblManipulationOperation

PibblManipulationOptions

PibblManipulationPoint

PibblManipulationReadoutStateStyle

PibblManipulationReadoutStyle

PibblManipulationResizeInput

PibblManipulationRotateInput

PibblManipulationSnapshot

PibblManipulationWhen

PibblPointerEvent

PibblPointerEvents

PibblResizeHandleProps

PibblResizeHandlesProps

PibblResizeHandleStyle

PibblResizePosition

PibblRotationArcStyle

PibblRotationConnectorStyle

PibblRotationHandleProps

PibblRotationHandleStyle

PibblTouchEvent

PibblWheelEvent

API details from source

PibblKeyboardNavigationOptions

See also

Properties and methods

PibblClipboardEvent

See also

Properties and methods

Returns

PibblCompositionEvent

See also

Properties and methods

Returns

PibblDragEvent

See also

Properties and methods

Returns

PibblEvent

See also

Properties and methods

Returns

PibblEventCapturePropName

See also

PibblEventHandler

Parameters

See also