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

Add support for Accordions #81

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

Conversation

Netacci
Copy link

@Netacci Netacci commented Oct 4, 2024

Fixes

Description

This PR adds support for an accordion component on the FAQ page. The accordion allows sections to expand and collapse, improving the user experience by enabling users to view and hide content dynamically. I implemented the feature by creating a new faq-page.html file and adding the necessary accordion functionality in accordion.js

Technical details

  • I created a separate JavaScript file accordion.js to handle the accordion functionality.
  • The accordion is fully accessible and adheres to WCAG (Web Content Accessibility Guidelines) by providing keyboard accessibility. Users can navigate through the accordion using the Tab, Enter, and Space keys to open and close sections.
  • The accordion works by toggling the visibility of content panels based on the aria-expanded attribute of each button. The state of the accordion is controlled dynamically using JavaScript, and animations are applied via CSS for smooth transitions.
  • I ensured that the first accordion section is open by default, displaying its content immediately when the page loads.

Tests

  • Load the faq-page.html page.
  • Verify that the first accordion section is open and displaying content by default.
  • Click each accordion header to ensure the sections expand and collapse as expected.

Verify that keyboard accessibility works:

  • Use Tab to navigate through the accordion headers.
  • Press Enter or Space to toggle accordion sections.
  • Verify that the accordion transitions smoothly when opening and closing.

Screenshots

close
open

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.

Copy link

netlify bot commented Oct 4, 2024

Deploy Preview for vocabulary-docs ready!

Name Link
🔨 Latest commit 8fc600c
🔍 Latest deploy log https://app.netlify.com/sites/vocabulary-docs/deploys/66ffbeb451a9eb00081975c0
😎 Deploy Preview https://deploy-preview-81--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.

@Netacci Netacci marked this pull request as ready for review October 5, 2024 10:30
@Netacci Netacci requested review from a team as code owners October 5, 2024 10:30
@Netacci Netacci requested review from TimidRobot, Shafiya-Heena, possumbilities and nimishbongale and removed request for a team October 5, 2024 10:30
This was referenced Oct 5, 2024
@possumbilities
Copy link
Contributor

There's good work here, but for the time being see status of initial Issue.

After reviewing possible work directions here, it has become clear that more focused implementation specifications are needed for this to move stably forward. As such this Feature is now blocked by:

I'm leaving this PR open for now, and we'll revisit soon.

@Netacci
Copy link
Author

Netacci commented Oct 14, 2024

There's good work here, but for the time being see status of initial Issue.

After reviewing possible work directions here, it has become clear that more focused implementation specifications are needed for this to move stably forward. As such this Feature is now blocked by:

I'm leaving this PR open for now, and we'll revisit soon.

Okay noted

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 support for accordions
2 participants