Implement ElementHandle.BoundingBoxAsync (#213)

Author: kblok

lib/PuppeteerSharp.Tests/ElementHandleTests/BoundingBoxTests.cs

@@ -0,0 +1,46 @@
+using System.Threading.Tasks;
+using Xunit;
+
+namespace PuppeteerSharp.Tests.ElementHandleTests
+{
+    [Collection("PuppeteerLoaderFixture collection")]
+    public class BoundingBoxTests : PuppeteerPageBaseTest
+    {
+        [Fact]
+        public async Task ShouldWork()
+        {
+            await Page.SetViewportAsync(new ViewPortOptions
+            {
+                Width = 500,
+                Height = 500
+            });
+            await Page.GoToAsync(TestConstants.ServerUrl + "/grid.html");
+            var elementHandle = await Page.QuerySelectorAsync(".box:nth-of-type(13)");
+            var box = await elementHandle.BoundingBoxAsync();
+            Assert.Equal(new BoundingBox(100, 50, 50, 50), box);
+        }
+
+        [Fact]
+        public async Task ShouldHandleNestedFrames()
+        {
+            await Page.SetViewportAsync(new ViewPortOptions
+            {
+                Width = 500,
+                Height = 500
+            });
+            await Page.GoToAsync(TestConstants.ServerUrl + "/frames/nested-frames.html");
+            var nestedFrame = Page.Frames[1].ChildFrames[1];
+            var elementHandle = await nestedFrame.QuerySelectorAsync("div");
+            var box = await elementHandle.BoundingBoxAsync();
+            Assert.Equal(new BoundingBox(28, 260, 264, 18), box);
+        }
+
+        [Fact]
+        public async Task ShouldReturnNullForInvisibleElements()
+        {
+            await Page.SetContentAsync("<div style='display:none'>hi</div>");
+            var elementHandle = await Page.QuerySelectorAsync("div");
+            Assert.Null(await elementHandle.BoundingBoxAsync());
+        }
+    }
+}

lib/PuppeteerSharp/BoundingBox.cs

@@ -0,0 +1,67 @@
+using System;
+namespace PuppeteerSharp
+{
+    public class BoundingBox
+    {
+        /// <summary>
+        /// The x coordinate of the element in pixels.
+        /// </summary>
+        /// <value>The x.</value>
+        public decimal X { get; set; }
+        /// <summary>
+        /// The y coordinate of the element in pixels.
+        /// </summary>
+        /// <value>The y.</value>
+        public decimal Y { get; set; }
+        /// <summary>
+        /// The width of the element in pixels.
+        /// </summary>
+        /// <value>The width.</value>
+        public decimal Width { get; set; }
+        /// <summary>
+        /// The height of the element in pixels.
+        /// </summary>
+        /// <value>The height.</value>
+        public decimal Height { get; set; }
+
+        public BoundingBox(decimal x, decimal y, decimal width, decimal height)
+        {
+            X = x;
+            Y = y;
+            Width = width;
+            Height = height;
+        }
+
+        internal Clip ToClip()
+        {
+            return new Clip
+            {
+                X = X,
+                Y = Y,
+                Width = Width,
+                Height = Height
+            };
+        }
+
+        public override bool Equals(object obj)
+        {
+            if (obj == null && GetType() != obj.GetType())
+            {
+                return false;
+            }
+
+            var boundingBox = obj as BoundingBox;
+
+            return boundingBox.X == X &&
+               boundingBox.Y == Y &&
+               boundingBox.Height == Height &&
+               boundingBox.Width == Width;
+        }
+
+        public override int GetHashCode()
+            => X.GetHashCode() * 397
+                ^ Y.GetHashCode() * 397
+                ^ Width.GetHashCode() * 397
+                ^ Height.GetHashCode() * 397;
+    }
+}

lib/PuppeteerSharp/ElementHandle.cs

@@ -271,7 +271,12 @@ private async Task ScrollIntoViewIfNeededAsync()
             }
         }
 
-        private async Task<BoundingBox> BoundingBoxAsync()
+        /// <summary>
+        /// This method returns the bounding box of the element (relative to the main frame), 
+        /// or null if the element is not visible.
+        /// </summary>
+        /// <returns>The BoundingBox task.</returns>
+        public async Task<BoundingBox> BoundingBoxAsync()
         {
             dynamic result = null;
 
@@ -301,32 +306,5 @@ private async Task<BoundingBox> BoundingBoxAsync()
 
             return new BoundingBox(x, y, width, height);
         }
-
-        private class BoundingBox
-        {
-            public decimal X { get; set; }
-            public decimal Y { get; set; }
-            public decimal Width { get; }
-            public decimal Height { get; }
-
-            public BoundingBox(decimal x, decimal y, decimal width, decimal height)
-            {
-                X = x;
-                Y = y;
-                Width = width;
-                Height = height;
-            }
-
-            internal Clip ToClip()
-            {
-                return new Clip
-                {
-                    X = X,
-                    Y = Y,
-                    Width = Width,
-                    Height = Height
-                };
-            }
-        }
     }
 }