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

docs: Add scroll behaviour smooth #16056

Merged
merged 2 commits into from Jul 5, 2022
Merged

Conversation

amareshsm
Copy link
Member

@amareshsm amareshsm commented Jun 25, 2022

Prerequisites checklist

What is the purpose of this pull request? (put an "X" next to an item)

[ ] Documentation update
[ ] Bug fix (template)
[ ] New rule (template)
[ ] Changes an existing rule (template)
[ ] Add autofix to a rule
[ ] Add a CLI option
[ ] Add something to the core
[x] Other, please explain:
Added scroll behaviour to smoothly animate the scroll position.

Before:

Screen.Recording.2022-06-30.at.1.25.28.AM.mov

After:

Screen.Recording.2022-06-30.at.1.25.55.AM.mov

@eslint-github-bot eslint-github-bot bot added triage An ESLint team member will look at this issue soon documentation Relates to ESLint's documentation labels Jun 25, 2022
@netlify
Copy link

netlify bot commented Jun 25, 2022

Deploy Preview for docs-eslint ready!

Name Link
🔨 Latest commit f4a48aa
🔍 Latest deploy log https://app.netlify.com/sites/docs-eslint/deploys/62c33bb4e40fd50009fd91df
😎 Deploy Preview https://deploy-preview-16056--docs-eslint.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site settings.

@amareshsm amareshsm changed the title docs: add scroll behaviour smooth docs: Add scroll behaviour smooth Jun 25, 2022
Copy link
Contributor

@snitin315 snitin315 left a comment

Why is it needed? Is there an issue with the current scroll behavior?

@amareshsm
Copy link
Member Author

amareshsm commented Jun 26, 2022

Why is it needed? Is there an issue with the current scroll behavior?

No issue with the current scroll behavior. Current scroll behavior (auto) scrolls to the position instantly so just set the value to smooth to scroll in a smooth fashion.

@snitin315
Copy link
Contributor

snitin315 commented Jun 27, 2022

I see. can you share a before/after screenshot/video?

@snitin315 snitin315 added evaluating The team will evaluate this issue to decide whether it meets the criteria for inclusion and removed triage An ESLint team member will look at this issue soon labels Jun 27, 2022
@amareshsm
Copy link
Member Author

amareshsm commented Jun 29, 2022

I see. can you share a before/after screenshot/video?

Updated in the PR.

@snitin315
Copy link
Contributor

snitin315 commented Jun 30, 2022

I see other documentation websites are also using the same current behavior. Scrolling can be a problem if the page is too long. So, I'm more inclined towards the current behavior. Let's wait to see what other team members feel.

Gatsby
Screen.Recording.2022-06-30.at.7.34.10.AM.mov
Vue
Screen.Recording.2022-06-30.at.7.36.01.AM.mov
Webpack
Screen.Recording.2022-06-30.at.7.40.41.AM.mov

@amareshsm
Copy link
Member Author

amareshsm commented Jun 30, 2022

Inspired from MDN docs.

@nzakas
Copy link
Member

nzakas commented Jul 2, 2022

I don’t have a strong opinion either way. I wouldn’t mind merging this to just see what feedback we get. It’s easy enough to undo if we get negative feedback.

@@ -1,5 +1,9 @@
/* docs layout styles */

html, body {
Copy link
Member

@nzakas nzakas Jul 2, 2022

Choose a reason for hiding this comment

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

I think we only need html here

Suggested change
html, body {
html {

Copy link
Member Author

@amareshsm amareshsm Jul 4, 2022

Choose a reason for hiding this comment

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

done.

Copy link
Contributor

@snitin315 snitin315 left a comment

Let's try this.

@snitin315 snitin315 added accepted There is consensus among the team that this change meets the criteria for inclusion and removed evaluating The team will evaluate this issue to decide whether it meets the criteria for inclusion labels Jul 5, 2022
@snitin315 snitin315 requested a review from nzakas Jul 5, 2022
@nzakas nzakas merged commit 32a6b2a into eslint:main Jul 5, 2022
20 checks passed
crapStone pushed a commit to Calciumdibromid/CaBr2 that referenced this pull request Jul 18, 2022
This PR contains the following updates:

| Package | Type | Update | Change |
|---|---|---|---|
| [eslint](https://eslint.org) ([source](https://github.com/eslint/eslint)) | devDependencies | minor | [`8.19.0` -> `8.20.0`](https://renovatebot.com/diffs/npm/eslint/8.19.0/8.20.0) |

---

### Release Notes

<details>
<summary>eslint/eslint</summary>

### [`v8.20.0`](https://github.com/eslint/eslint/releases/tag/v8.20.0)

[Compare Source](eslint/eslint@v8.19.0...v8.20.0)

#### Features

-   [`ca83178`](eslint/eslint@ca83178) feat: catch preprocess errors ([#&#8203;16105](eslint/eslint#16105)) (JounQin)

#### Bug Fixes

-   [`30be0ed`](eslint/eslint@30be0ed) fix: no-warning-comments rule escapes special RegEx characters in terms ([#&#8203;16090](eslint/eslint#16090)) (Lachlan Hunt)
-   [`bfe5e88`](eslint/eslint@bfe5e88) fix: ignore spacing before `]` and `}` in comma-spacing ([#&#8203;16113](eslint/eslint#16113)) (Milos Djermanovic)

#### Documentation

-   [`845c4f4`](eslint/eslint@845c4f4) docs: Add website team details ([#&#8203;16115](eslint/eslint#16115)) (Nicholas C. Zakas)
-   [`5a0dfdb`](eslint/eslint@5a0dfdb) docs: Link to blog post in no-constant-binary-expression ([#&#8203;16112](eslint/eslint#16112)) (Jordan Eldredge)
-   [`bc692a9`](eslint/eslint@bc692a9) docs: remove install command ([#&#8203;16084](eslint/eslint#16084)) (Strek)
-   [`49ca3f0`](eslint/eslint@49ca3f0) docs: don't show toc when content not found ([#&#8203;16095](eslint/eslint#16095)) (Amaresh  S M)
-   [`ba19e3f`](eslint/eslint@ba19e3f) docs: enhance 404 page UI ([#&#8203;16097](eslint/eslint#16097)) (Amaresh  S M)
-   [`a75d3b4`](eslint/eslint@a75d3b4) docs: remove unused meta.docs.category field in working-with-rules page ([#&#8203;16109](eslint/eslint#16109)) (Brandon Scott)
-   [`cdc0206`](eslint/eslint@cdc0206) docs: add formatters page edit link ([#&#8203;16094](eslint/eslint#16094)) (Amaresh  S M)
-   [`4d1ed22`](eslint/eslint@4d1ed22) docs: preselect default theme ([#&#8203;16098](eslint/eslint#16098)) (Strek)
-   [`4b79612`](eslint/eslint@4b79612) docs: add missing correct/incorrect containers ([#&#8203;16087](eslint/eslint#16087)) (Milos Djermanovic)
-   [`09f6acb`](eslint/eslint@09f6acb) docs: fix UI bug on rules index and details pages ([#&#8203;16082](eslint/eslint#16082)) (Deepshika S)
-   [`f5db264`](eslint/eslint@f5db264) docs: remove remaining duplicate rule descriptions ([#&#8203;16093](eslint/eslint#16093)) (Milos Djermanovic)
-   [`32a6b2a`](eslint/eslint@32a6b2a) docs: Add scroll behaviour smooth ([#&#8203;16056](eslint/eslint#16056)) (Amaresh  S M)

#### Chores

-   [`bbf8df4`](eslint/eslint@bbf8df4) chore: Mark autogenerated release blog post as draft ([#&#8203;16130](eslint/eslint#16130)) (Nicholas C. Zakas)
-   [`eee4306`](eslint/eslint@eee4306) chore: update internal lint dependencies ([#&#8203;16088](eslint/eslint#16088)) (Bryan Mishkin)
-   [`9615a42`](eslint/eslint@9615a42) chore: update formatter examples template to avoid markdown lint error ([#&#8203;16085](eslint/eslint#16085)) (Milos Djermanovic)
-   [`62541ed`](eslint/eslint@62541ed) chore: fix markdown linting error ([#&#8203;16083](eslint/eslint#16083)) (唯然)

</details>

---

### Configuration

📅 **Schedule**: Branch creation - At any time (no schedule defined), Automerge - At any time (no schedule defined).

🚦 **Automerge**: Disabled by config. Please merge this manually once you are satisfied.

 **Rebasing**: Whenever PR becomes conflicted, or you tick the rebase/retry checkbox.

🔕 **Ignore**: Close this PR and you won't be reminded about this update again.

---

 - [ ] <!-- rebase-check -->If you want to rebase/retry this PR, click this checkbox.

---

This PR has been generated by [Renovate Bot](https://github.com/renovatebot/renovate).
<!--renovate-debug:eyJjcmVhdGVkSW5WZXIiOiIzMi4xMTcuMSIsInVwZGF0ZWRJblZlciI6IjMyLjExNy4xIn0=-->

Co-authored-by: cabr2-bot <cabr2.help@gmail.com>
Reviewed-on: https://codeberg.org/Calciumdibromid/CaBr2/pulls/1466
Reviewed-by: Epsilon_02 <epsilon_02@noreply.codeberg.org>
Co-authored-by: Calciumdibromid Bot <cabr2_bot@noreply.codeberg.org>
Co-committed-by: Calciumdibromid Bot <cabr2_bot@noreply.codeberg.org>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
accepted There is consensus among the team that this change meets the criteria for inclusion documentation Relates to ESLint's documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

4 participants