Shumoku Docs

Search documentation

Shared docs and current release

Loading search…

日本語

@shumoku/core · 0.4.0 · function

findContainmentViolations

Source

Find member nodes whose box is not fully inside their container's bounds (shrunk by `pad` on each side). Unknown member ids are ignored — membership resolution is the caller's concern.

findContainmentViolations(boxes: readonly BoxSpec[], containers: readonly ContainerSpec[], pad?: number): ContainmentViolation[]

Parameters

Parameter Type Description Default
boxes readonly BoxSpec[] No additional description.
containers readonly ContainerSpec[] No additional description.
pad number No additional description. 0

Returns

ContainmentViolation[]

libs/@shumoku/core/src/layout/invariants.ts:110