Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Bug 1906899: fix offset in quick start highlight bounding box #7475

Merged
merged 2 commits into from Dec 11, 2020

Conversation

christianvogt
Copy link
Contributor

Fixes:
https://issues.redhat.com/browse/ODC-5234

Analysis / Root cause:
The bounding box of the target node to highlight gets calculated immediately after the highlight is rendered to the page. However, this occurs before popper has positioned the highlight. Since the Popper component rendered the content without any positional information, it ended up rendering the content at the bottom of the page below the fold. This results in a vertical scrollbar appearing on the body and shifting the content over to the left. This only occurs the browser / os has scrollbars always visible.

Solution Description:

The solution here is to default the popper wrapper with position: absolute, top: 0, left: 0 so that it begins rendering in the top left corner. Also changed the scroll behavior to be smooth as it helps guide the user to understand where the element came from it if happens to be offscreen.

To test all spotlight usage, I had to fix an issue where the guided tour menu item wasn't rendering because of a change to active perspective fetching. This fix required also addressing a circular dependency.

Screen shots / Gifs for design review:

image

Test Setup
Install the following Quick Start:

apiVersion: console.openshift.io/v1
kind: ConsoleQuickStart
metadata:
  name: test-highlight
spec:
  description: test desc
  displayName: test highlight
  durationMinutes: 1
  introduction: test intro
  tasks:
    - description: |
        1. [perspective]{{highlight tour-perspective-dropdown}}
        2. [masthead]{{highlight tour-help-button}}
        3. [search]{{highlight tour-search-nav}}
      title: test highlight

Browser conformance:

  • Chrome
  • Firefox
  • Safari
  • Edge

@openshift-ci-robot openshift-ci-robot added the component/core Related to console core functionality label Dec 8, 2020
@openshift-ci-robot openshift-ci-robot added component/shared Related to console-shared approved Indicates a PR has been approved by an approver from all required OWNERS files. labels Dec 8, 2020
@christianvogt
Copy link
Contributor Author

/test e2e-gcp-console

@christianvogt christianvogt changed the title fix offset in quick start highlight bounding box Bug 1906899: fix offset in quick start highlight bounding box Dec 11, 2020
@openshift-ci-robot openshift-ci-robot added bugzilla/severity-low Referenced Bugzilla bug's severity is low for the branch this PR is targeting. bugzilla/invalid-bug Indicates that a referenced Bugzilla bug is invalid for the branch this PR is targeting. labels Dec 11, 2020
@openshift-ci-robot
Copy link
Contributor

@christianvogt: This pull request references Bugzilla bug 1906899, which is invalid:

  • expected the bug to target the "4.7.0" release, but it targets "---" instead

Comment /bugzilla refresh to re-evaluate validity if changes to the Bugzilla bug are made, or edit the title of this pull request to link to a different bug.

In response to this:

Bug 1906899: fix offset in quick start highlight bounding box

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes/test-infra repository.

@christianvogt
Copy link
Contributor Author

/bugzilla refresh

@openshift-ci-robot openshift-ci-robot added the bugzilla/valid-bug Indicates that a referenced Bugzilla bug is valid for the branch this PR is targeting. label Dec 11, 2020
@openshift-ci-robot
Copy link
Contributor

@christianvogt: This pull request references Bugzilla bug 1906899, which is valid. The bug has been moved to the POST state. The bug has been updated to refer to the pull request using the external bug tracker.

3 validation(s) were run on this bug
  • bug is open, matching expected state (open)
  • bug target release (4.7.0) matches configured target release for branch (4.7.0)
  • bug is in the state NEW, which is one of the valid states (NEW, ASSIGNED, ON_DEV, POST, POST)

In response to this:

/bugzilla refresh

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes/test-infra repository.

@openshift-ci-robot openshift-ci-robot removed the bugzilla/invalid-bug Indicates that a referenced Bugzilla bug is invalid for the branch this PR is targeting. label Dec 11, 2020
Copy link
Contributor

@andrewballantyne andrewballantyne left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

/lgtm

One nit, doesn't make a difference if it's left.


const LAST_PERSPECTIVE_USER_SETTINGS_KEY = 'console.lastPerspective';

export const useValuesForPerspectiveContext = (): [
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
export const useValuesForPerspectiveContext = (): [
default export (): [

Named files should default export. Generic files utils... can export multiple/named.

@openshift-ci-robot openshift-ci-robot added the lgtm Indicates that a PR is ready to be merged. label Dec 11, 2020
@openshift-ci-robot
Copy link
Contributor

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: andrewballantyne, christianvogt

The full list of commands accepted by this bot can be found here.

The pull request process is described here

Needs approval from an approver in each of these files:

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

@openshift-merge-robot openshift-merge-robot merged commit 5870b39 into openshift:master Dec 11, 2020
@openshift-ci-robot
Copy link
Contributor

@christianvogt: All pull requests linked via external trackers have merged:

Bugzilla bug 1906899 has been moved to the MODIFIED state.

In response to this:

Bug 1906899: fix offset in quick start highlight bounding box

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes/test-infra repository.

@spadgett spadgett added this to the v4.7 milestone Dec 11, 2020
@christianvogt christianvogt deleted the qs-offset branch June 2, 2021 19:04
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
approved Indicates a PR has been approved by an approver from all required OWNERS files. bugzilla/severity-low Referenced Bugzilla bug's severity is low for the branch this PR is targeting. bugzilla/valid-bug Indicates that a referenced Bugzilla bug is valid for the branch this PR is targeting. component/core Related to console core functionality component/shared Related to console-shared lgtm Indicates that a PR is ready to be merged.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

5 participants