[1.16] Allow choosing the box model in Node::getPosition()

CHANGELOG.md

@@ -4,6 +4,7 @@
 ## 1.16.0 (UPCOMING)
 
 * Add `disableJavascript` option
+* Allow choosing the box model in `Node::getPosition()`
 
 
 ## 1.15.0 (2025-12-27)

src/Dom/Node.php

@@ -128,16 +128,23 @@ public function getAttribute(string $name): ?string
         return $this->getAttributes()->get($name);
     }
 
-    public function getPosition(): ?NodePosition
+    /**
+     * @param 'content'|'padding'|'border'|'margin' $boxModel
+     */
+    public function getPosition(string $boxModel = 'content'): ?NodePosition
     {
+        if (!\in_array($boxModel, ['content', 'padding', 'border', 'margin'], true)) {
+            throw new \InvalidArgumentException('Invalid box model "'.$boxModel.'" for node position. Box model must be "content", "padding", "border" or "margin".');
+        }
+
         $message = new Message('DOM.getBoxModel', [
             'nodeId' => $this->getNodeIdForRequest(),
         ]);
         $response = $this->page->getSession()->sendMessageSync($message);
 
         $this->assertNotError($response);
 
-        $points = $response->getResultData('model')['content'];
+        $points = $response->getResultData('model')[$boxModel] ?? null;
 
         if (null !== $points) {
             return new NodePosition($points);

tests/DomTest.php

@@ -2,6 +2,7 @@
 
 namespace HeadlessChromium\Test;
 
+use Generator;
 use HeadlessChromium\Browser;
 use HeadlessChromium\BrowserFactory;
 use HeadlessChromium\Exception\StaleElementException;
@@ -140,6 +141,51 @@ public function testSetAttribute(): void
         self::assertSame('hello', $value);
     }
 
+    /**
+     * @dataProvider providerGetPosition
+     */
+    public function testGetPosition(?string $boxModel, float $expectedX, float $expectedY, float $expectedWidth, float $expectedHeight): void
+    {
+        $page = $this->openSitePage('boxModel.html');
+
+        $element = $page->dom()->querySelector('#elem');
+
+        if (null !== $boxModel) {
+            $position = $element->getPosition($boxModel);
+        } else {
+            $position = $element->getPosition();
+        }
+
+        self::assertNotNull($position);
+        self::assertSame($expectedX, $position->getX());
+        self::assertSame($expectedY, $position->getY());
+        self::assertSame($expectedWidth, $position->getWidth());
+        self::assertSame($expectedHeight, $position->getHeight());
+    }
+
+    /**
+     * @return Generator<string, array{?string, float, float, float, float}>
+     */
+    public static function providerGetPosition(): Generator
+    {
+        yield 'margin' => ['margin', 0.0, 0.0, 310.0, 360.0];
+        yield 'border' => ['border', 20.0, 10.0, 270.0, 340.0];
+        yield 'padding' => ['padding', 25.0, 15.0, 260.0, 330.0];
+        yield 'content' => ['content', 55.0, 30.0, 200.0, 300.0];
+        yield 'default' => [null, 55.0, 30.0, 200.0, 300.0];
+    }
+
+    public function testGetPositionWithInvalidBoxModel(): void
+    {
+        $page = $this->openSitePage('boxModel.html');
+
+        $element = $page->dom()->querySelector('#elem');
+
+        $this->expectException(\InvalidArgumentException::class);
+
+        $element->getPosition('-invalid-');
+    }
+
     public function testUploadFile(): void
     {
         $page = $this->openSitePage('domForm.html');

tests/resources/static-web/boxModel.html

@@ -0,0 +1,27 @@
+<html>
+<head>
+    <title>box model - test</title>
+
+    <style>
+        html, body{
+            width: 500px;
+            height: 500px;
+            margin: 0;
+            padding: 0;
+        }
+
+        div {
+            width: 200px;
+            height: 300px;
+            margin: 10px 20px;
+            padding: 15px 30px;
+            border: 5px solid red;
+        }
+    </style>
+</head>
+<body>
+<div id="elem">
+    some content
+</div>
+</body>
+</html>