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.

Sign up for GitHub

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

Jump to bottom

Remove taxon-list app component from collections #3844

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

Remove taxon-list app component from collections #3844

wants to merge 4 commits into from
+23 −241

Commits on Nov 27, 2024

  1. Remove taxon-list component 

    Remove all files relating to the taxon-list component the taxon-list component as it is no longer required.

The component was originally created for an AB Test on https://www.gov.uk/education/funding-and-finance-for-students#/education/student-grants-bursaries-scholarships

This page is now using the document-list component from the govuk_publishing_components gem
    @MartinJJones
    MartinJJones committed Nov 27, 2024
    Configuration menu
    Copy the full SHA
    2205cca View commit details
    Browse the repository at this point in the history

  2. Update taxon_list_helper to work for document-list 

    Update data structure returned from `taxon_list_params` method

Updated the structure to work with the document-list gem component, setting `full_size_description: true` ensures the font-size is set to 19px for the description when present - https://components.publishing.service.gov.uk/component-guide/document_list/with_full_size_description_text
    @MartinJJones
    MartinJJones committed Nov 27, 2024
    Configuration menu
    Copy the full SHA
    c3c182c View commit details
    Browse the repository at this point in the history

  3. Replace taxon-list with document-list gem component 

    - Use the `document-list` component from the gem instead of the `taxon-list` app component in the `tagged_content_list.html.erb` and `accordion.html.erb` view templates
- By using the document-list component, the list will change from an ordered list to an unordered list, this feels like a slight improvement as the content presented does not appear to be in order of sequence/importance
- `heading_level` variable removed from the `tagged_content_list.html.erb` template, the document-list component does not support headings and is not required here

This approach is also consistent with other places the document-list component is used, for example:

- [Education, training and skills - GOV.UK](https://www.gov.uk/education)  (collections)
- [Find contact details for services - GOV.UK](https://www.gov.uk/contact)  (feedback)
- [Travel or do business in Europe: Brexit guidance](https://www.gov.uk/government/collections/brexit-guidance) (government-frontend)
- set `disable_ga4: true` to disable GA4 tracking
  - in the accordion.html.erb this prevents duplicate events from firing as this is already built into the accordion component
  - GA4 was not enabled previously in the tagged_content_list.html.erb
    @MartinJJones
    MartinJJones committed Nov 27, 2024
    Configuration menu
    Copy the full SHA
    8d91669 View commit details
    Browse the repository at this point in the history

  4. Use list gem component for past role holders 

    Replace the `taxon-list` component with the `list` component from the govuk_publishing_components gem.

`list_type: "number"` has been used to ensure an ordered list is used to match the current HTML structure
    @MartinJJones
    MartinJJones committed Nov 27, 2024
    Configuration menu
    Copy the full SHA
    9832a2a View commit details
    Browse the repository at this point in the history