Implement Element.scrollIntoView for scroll-behavior: smooth.

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

 /*
  * Copyright (C) 1999 Lars Knoll (knoll@kde.org)
  *           (C) 1999 Antti Koivisto (koivisto@kde.org)
  *           (C) 2001 Peter Kelly (pmk@post.com)
  *           (C) 2001 Dirk Mueller (mueller@kde.org)
  *           (C) 2007 David Smith (catfish.man@gmail.com)
  * Copyright (C) 2004, 2005, 2006, 2007, 2008, 2009, 2010, 2012, 2013 Apple Inc.
  * All rights reserved.
  *           (C) 2007 Eric Seidel (eric@webkit.org)
  *
@@ skipping 12 matching lines @@
  * the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
  * Boston, MA 02110-1301, USA.
  */
 
 #include "core/dom/Element.h"
 
 #include <memory>
 #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"
 #include "core/XMLNames.h"
 #include "core/animation/AnimationTimeline.h"
 #include "core/animation/CustomCompositorAnimations.h"
 #include "core/animation/css/CSSAnimations.h"
 #include "core/css/CSSIdentifierValue.h"
 #include "core/css/CSSPrimitiveValue.h"
 #include "core/css/CSSStyleSheet.h"
@@ skipping 44 matching lines @@
 #include "core/editing/EditingUtilities.h"
 #include "core/editing/FrameSelection.h"
 #include "core/editing/iterators/TextIterator.h"
 #include "core/editing/serializers/Serialization.h"
 #include "core/events/EventDispatcher.h"
 #include "core/events/FocusEvent.h"
 #include "core/frame/FrameView.h"
 #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"
 #include "core/frame/VisualViewport.h"
 #include "core/frame/csp/ContentSecurityPolicy.h"
 #include "core/html/ClassList.h"
 #include "core/html/HTMLCanvasElement.h"
 #include "core/html/HTMLCollection.h"
 #include "core/html/HTMLDocument.h"
 #include "core/html/HTMLElement.h"
@@ skipping 27 matching lines @@
 #include "core/svg/SVGElement.h"
 #include "core/svg/SVGTreeScopeResources.h"
 #include "platform/EventDispatchForbiddenScope.h"
 #include "platform/RuntimeEnabledFeatures.h"
 #include "platform/bindings/DOMDataStore.h"
 #include "platform/bindings/V8DOMWrapper.h"
 #include "platform/bindings/V8PerContextData.h"
 #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"
 #include "platform/wtf/text/StringBuilder.h"
 #include "platform/wtf/text/TextPosition.h"
 
 namespace blink {
 
 namespace {
 
@@ skipping 269 matching lines @@
   if (const Attribute* attribute = GetElementData()->Attributes().Find(name))
     return attribute->Value();
   return g_null_atom;
 }
 
 AtomicString Element::LowercaseIfNecessary(const AtomicString& name) const {
   return IsHTMLElement() && GetDocument().IsHTMLDocument() ? name.LowerASCII()
                                                            : 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);
 }
 
 void Element::scrollIntoViewIfNeeded(bool center_if_needed) {
   GetDocument().EnsurePaintLocationDataValidForNode(this);
 
   if (!GetLayoutObject())
     return;
 
@@ skipping 3873 matching lines @@
 }
 
 DEFINE_TRACE_WRAPPERS(Element) {
   if (HasRareData()) {
     visitor->TraceWrappers(GetElementRareData());
   }
   ContainerNode::TraceWrappers(visitor);
 }
 
 }  // namespace blink