Implement Element.scrollIntoView for scroll-behavior: smooth.

third_party/WebKit/Source/core/dom/Element.cpp

Index: third_party/WebKit/Source/core/dom/Element.cpp
diff --git a/third_party/WebKit/Source/core/dom/Element.cpp b/third_party/WebKit/Source/core/dom/Element.cpp
index 406ccfc9b05755070367a8ca7eaf22f6ba2fb7c2..7c193354cd99251dc1c13e3ca50e5d5f2aa47a18 100644
--- a/third_party/WebKit/Source/core/dom/Element.cpp
+++ b/third_party/WebKit/Source/core/dom/Element.cpp
@@ -30,6 +30,7 @@
 #include "bindings/core/v8/Dictionary.h"
 #include "bindings/core/v8/ExceptionMessages.h"
 #include "bindings/core/v8/ExceptionState.h"
+#include "bindings/core/v8/ScrollIntoViewOptionsOrBoolean.h"
 #include "bindings/core/v8/V8DOMActivityLogger.h"
 #include "core/CSSValueKeywords.h"
 #include "core/SVGNames.h"
@@ -94,6 +95,7 @@
 #include "core/frame/HostsUsingFeatures.h"
 #include "core/frame/LocalDOMWindow.h"
 #include "core/frame/LocalFrame.h"
+#include "core/frame/ScrollIntoViewOptions.h"
 #include "core/frame/ScrollToOptions.h"
 #include "core/frame/Settings.h"
 #include "core/frame/UseCounter.h"
@@ -141,6 +143,7 @@
 #include "platform/graphics/CompositorMutableProperties.h"
 #include "platform/graphics/CompositorMutation.h"
 #include "platform/scroll/ScrollableArea.h"
+#include "platform/scroll/SmoothScrollSequencer.h"
 #include "platform/wtf/BitVector.h"
 #include "platform/wtf/HashFunctions.h"
 #include "platform/wtf/text/CString.h"
@@ -430,27 +433,99 @@ AtomicString Element::LowercaseIfNecessary(const AtomicString& name) const {
                                                            : name;
 }
 
+void Element::scrollIntoView(ScrollIntoViewOptionsOrBoolean arg) {
+  GetDocument().EnsurePaintLocationDataValidForNode(this);
+
+  ScrollIntoViewOptions options;
+  if (arg.isBoolean()) {
+    if (arg.getAsBoolean())
+      options.setBlock("start");
+    else
+      options.setBlock("end");
+    options.setInlinePosition("nearest");
+  } else if (arg.isScrollIntoViewOptions()) {
+    options = arg.getAsScrollIntoViewOptions();
+    if (!RuntimeEnabledFeatures::cssomSmoothScrollEnabled() &&
+        options.behavior() == "smooth") {
+      options.setBehavior("instant");
+    }
+  }
+  scrollIntoViewWithOptions(options);
+}
+
 void Element::scrollIntoView(bool align_to_top) {
   GetDocument().EnsurePaintLocationDataValidForNode(this);

[bokan, 2017/05/15 17:15:27]

The call to EnsurePaintLocationDataValidForNode should be moved from this and
the above method into the method that takes a ScrollIntoViewOptions.

[sunyunjia, 2017/05/19 16:24:28]

Done.

 
+  ScrollIntoViewOptions options;
+  if (align_to_top)
+    options.setBlock("start");
+  else
+    options.setBlock("end");
+  options.setInlinePosition("nearest");
+  scrollIntoViewWithOptions(options);

[bokan, 2017/05/15 17:15:27]

Can we just call the ScrollIntoViewOptionsOrBoolean method by casting the
parameter? That way we're not duplicating this block.

[sunyunjia, 2017/05/19 16:24:28]

Done.

+}
+
+static ScrollAlignment InputAlignmentToXYAlignment(

[bokan, 2017/05/15 17:15:27]

IMHO, ToPhysicalAlignment would be a better name.

[sunyunjia, 2017/05/19 16:24:28]

Done.

+    const ScrollIntoViewOptions& options,
+    bool is_x,

[bokan, 2017/05/15 17:15:28]

Add an enum in ScrollTypes called ScrollOrientation { kHorizontal, kVertical };
and use that instead of a bool, more readable.

[sunyunjia, 2017/05/19 16:24:28]

Done.

+    bool is_horizontal) {
+  String alignment = options.block();
+  if ((is_x && is_horizontal) || ((!is_x) && (!is_horizontal)))
+    alignment = options.inlinePosition();

[bokan, 2017/05/15 17:15:28]

Nit: newline after this `if`

[sunyunjia, 2017/05/19 16:24:28]

Done.

+  if (alignment == "center")
+    return ScrollAlignment::kAlignCenterAlways;
+  if (alignment == "nearest")
+    return ScrollAlignment::kAlignToEdgeIfNeeded;
+  if (alignment == "start") {
+    return is_x ? ScrollAlignment::kAlignLeftAlways
+                : ScrollAlignment::kAlignTopAlways;
+  }
+  if (alignment == "end") {
+    return is_x ? ScrollAlignment::kAlignRightAlways
+                : ScrollAlignment::kAlignBottomAlways;
+  }
+
+  // Default values
+  if (is_horizontal) {
+    if (is_x)

[bokan, 2017/05/15 17:15:27]

Nit: use ? : operator like above.

[sunyunjia, 2017/05/19 16:24:28]

Done.

+      return ScrollAlignment::kAlignToEdgeIfNeeded;
+    return ScrollAlignment::kAlignTopAlways;
+  }
+  // if (is_vertical)

[bokan, 2017/05/15 17:15:27]

Remove

[sunyunjia, 2017/05/19 16:24:28]

Done.

+  if (is_x)
+    return ScrollAlignment::kAlignLeftAlways;
+  return ScrollAlignment::kAlignToEdgeIfNeeded;
+}
+
+void Element::scrollIntoViewWithOptions(const ScrollIntoViewOptions& options) {
+  GetDocument().UpdateStyleAndLayoutIgnorePendingStylesheetsForNode(this);

[bokan, 2017/05/15 17:15:28]

This should probably just be EnsurePaintLocationDataValidForNode, as mentioned
in my comment above.

[sunyunjia, 2017/05/19 16:24:28]

Done.

+
   if (!GetLayoutObject())
     return;
 
   bool make_visible_in_visual_viewport =
       !GetDocument().GetPage()->GetSettings().GetInertVisualViewport();
 
+  ScrollBehavior behavior = kScrollBehaviorAuto;
+  if (options.behavior() == "smooth") {

[bokan, 2017/05/15 17:15:27]

Nit: no braces

[sunyunjia, 2017/05/19 16:24:28]

Done.

+    behavior = kScrollBehaviorSmooth;
+  }
+
+  bool is_horizontal = GetComputedStyle()->IsHorizontalWritingMode();
+  ScrollAlignment align_x =
+      InputAlignmentToXYAlignment(options, true, is_horizontal);
+  ScrollAlignment align_y =
+      InputAlignmentToXYAlignment(options, false, is_horizontal);
+
+  if (GetDocument().GetPage())

[bokan, 2017/05/15 17:15:27]

We should probably abort at the top if we don't have a page.

[sunyunjia, 2017/05/19 16:24:28]

Done.

+    GetDocument().GetPage()->GetSmoothScrollSequencer()->AbortAnimations();
   LayoutRect bounds = BoundingBox();
-  // Align to the top / bottom and to the closest edge.
-  if (align_to_top)
-    GetLayoutObject()->ScrollRectToVisible(
-        bounds, ScrollAlignment::kAlignToEdgeIfNeeded,
-        ScrollAlignment::kAlignTopAlways, kProgrammaticScroll,
-        make_visible_in_visual_viewport);
-  else
-    GetLayoutObject()->ScrollRectToVisible(
-        bounds, ScrollAlignment::kAlignToEdgeIfNeeded,
-        ScrollAlignment::kAlignBottomAlways, kProgrammaticScroll,
-        make_visible_in_visual_viewport);
+  GetLayoutObject()->ScrollRectToVisible(
+      bounds, align_x, align_y, kProgrammaticScroll,
+      make_visible_in_visual_viewport, behavior);
+
+  if (GetDocument().GetPage())
+    GetDocument().GetPage()->GetSmoothScrollSequencer()->RunQueuedAnimations();
 
   GetDocument().SetSequentialFocusNavigationStartingPoint(this);
 }