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

[Feature] Implements a scroll-to-top element for longer page contexts #97

Open
wants to merge 8 commits into
base: main
Choose a base branch
from

Conversation

egbadon-victor
Copy link
Contributor

@egbadon-victor egbadon-victor commented Oct 5, 2024

Fixes

Description

This PR implements a scroll-to-top element, which fixes the accessibility issue of going back to the top on a long page.

Technical details

  • Implements scroll-to-top class in the vocabulary.css file
  • Implementation is demoed on the archive-page.html file in the context folder

Tests

  • Launch the archive-page.html file on your preferred browser and scroll
  • Test that the scroll-to-top button is hidden until you scroll some distance
  • Test that the scroll-to-top button is not visible on screens less than 700px
  • Verify that there is no JS involved in this implementation

Screenshots

Checklist

  • My pull request has a descriptive title (not a vague title like Update index.md).
  • My pull request targets the default branch of the repository (main or master).
  • My commit messages follow best practices.
  • My code follows the established code style of the repository.
  • I added or updated tests for the changes I made (if applicable).
  • I added or updated documentation (if applicable).
  • I tried running the project locally and verified that there are no
    visible errors.

Developer Certificate of Origin

For the purposes of this DCO, "license" is equivalent to "license or public domain dedication," and "open source license" is equivalent to "open content license or public domain dedication."

Developer Certificate of Origin
Developer Certificate of Origin
Version 1.1

Copyright (C) 2004, 2006 The Linux Foundation and its contributors.
1 Letterman Drive
Suite D4700
San Francisco, CA, 94129

Everyone is permitted to copy and distribute verbatim copies of this
license document, but changing it is not allowed.


Developer's Certificate of Origin 1.1

By making a contribution to this project, I certify that:

(a) The contribution was created in whole or in part by me and I
    have the right to submit it under the open source license
    indicated in the file; or

(b) The contribution is based upon previous work that, to the best
    of my knowledge, is covered under an appropriate open source
    license and I have the right under that license to submit that
    work with modifications, whether created in whole or in part
    by me, under the same open source license (unless I am
    permitted to submit under a different license), as indicated
    in the file; or

(c) The contribution was provided directly to me by some other
    person who certified (a), (b) or (c) and I have not modified
    it.

(d) I understand and agree that this project and the contribution
    are public and that a record of the contribution (including all
    personal information I submit with it, including my sign-off) is
    maintained indefinitely and may be redistributed consistent with
    this project or the open source license(s) involved.

@egbadon-victor egbadon-victor requested review from a team as code owners October 5, 2024 00:50
@egbadon-victor egbadon-victor requested review from TimidRobot, possumbilities, Dhruvi16 and dhruvkb and removed request for a team October 5, 2024 00:50
Copy link

netlify bot commented Oct 5, 2024

Deploy Preview for vocabulary-docs ready!

Name Link
🔨 Latest commit 4d89019
🔍 Latest deploy log https://app.netlify.com/sites/vocabulary-docs/deploys/671be45eddbc2a000816dd44
😎 Deploy Preview https://deploy-preview-97--vocabulary-docs.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 configuration.

@possumbilities
Copy link
Contributor

Hi and thanks for this!

In addition to the changes listed above, the button is flush to the right edge and should instead be aligned further into and possibly over the content area.

The button also needs to be an element that could occur within the HTML of every page, but only become visible on longer pages. Please see the original Issue on the mention of pseudo classes to obscure the element.

CSS pseudo elements using z-index stack positions and variable percentage based heights would offer a means to "reveal" the button after a degree of scrolling, and to visually hide the element on pages which do not reach a particular length.

@egbadon-victor
Copy link
Contributor Author

@possumbilities thank you for taking your time to review this PR. I have noted all changes and concerns. I will get to work on implementing them Immedidately

@egbadon-victor
Copy link
Contributor Author

@possumbilities I have implemented all feedback given.

I have also implemented it in such a way to it can be added to any page implementing vocabulary. It is hidden on shorter pages, and appears on longer pages without the use of JS.

I have also implemented it in all specimens, and updated the docs/index.html file to reflect and addition of a new component.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Status: In review
Development

Successfully merging this pull request may close these issues.

[Feature] Add a scroll-to-top element to UX for longer page contexts
2 participants