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

Sidebar enhancements #861

Merged
merged 17 commits into from
Dec 9, 2024
Merged

Sidebar enhancements #861

merged 17 commits into from
Dec 9, 2024

Conversation

joshsadam
Copy link
Contributor

@joshsadam joshsadam commented Dec 5, 2024

What does this PR do and why?

Describe in detail what your merge request does and why.

  1. Updated the main sidebar with updated drop down label Go to that allows a user to go the main IRIDA categories.
  2. Updated the main sidebar to include the label for the current category (Project, Group, Workflow Executions, and Data Exports)
  3. Display the group or project name (and associated avatar) in the sidebar when viewing.

Screenshots or screen recordings

Screenshots are required for UI changes, and strongly recommended for all other pull requests.

Projects Page

Before

image

After

image

Project Page

Before

image

After

image

Group Page

Before

image

After

image

How to set up and validate locally

Numbered steps to set up and validate the change are strongly suggested.

PR acceptance checklist

This checklist encourages us to confirm any changes have been analyzed to reduce risks in quality, performance, reliability, security, and maintainability.

…play

- Consolidated class attributes in sidebar and header components for cleaner HTML.
- Removed unused attributes and streamlined initialization in SidebarComponent and HeaderComponent.
- Introduced item display in HeaderComponent to show relevant context.
- Updated sidebar rendering in various layout files to utilize new header structure.
- Improved indentation and formatting for better readability.
- Ensured consistent structure in the header component for enhanced maintainability.
…ency

- Changed text color classes from 'text-gray' to 'text-slate' for better visual coherence.
- Ensured consistent styling for item names in the sidebar header component.
…re and styling

- Updated header element from <p> to <h2> for better semantic structure.
- Adjusted spacing and alignment for item display to enhance visual clarity.
- Changed item name display from <p> to <span> for consistency in styling.
- Deleted the LabelComponent class as it is no longer needed in the sidebar structure.
…ved header rendering

- Enhanced the sidebar component's HTML structure for better readability and maintainability.
- Updated the sidebar header to use a turbo frame for dynamic content rendering.
- Modified turbo stream updates in group and project views to render the new sidebar header component with appropriate labels.
- Ensured consistent styling and structure across sidebar elements.
…ing keys

- Replaced single quotes with double quotes for consistency across various strings in the fr.yml locale file.
- Ensured uniformity in error messages and labels to enhance readability and maintainability.
- Updated multiple instances where text formatting was inconsistent, improving overall localization quality.
…ench locale with new keys

- Replaced single quotes with double quotes for consistency across various strings in the en.yml locale file.
- Updated error messages and labels to enhance readability and maintainability.
- Added missing keys in the fr.yml locale file to improve localization coverage.
- Ensured uniformity in text formatting across both locale files for better localization quality.
…rameters

- Updated tests for LayoutComponent and SidebarComponent to remove redundant label and icon_name parameters.
- Enhanced readability of test cases by focusing on essential rendering functionality.
- Ensured consistency in sidebar header rendering across different test scenarios.
- Changed test selectors in GroupsTest and ProjectsTest from '#sidebar' and '#sidebar_project_name' to 'aside#sidebar' for better specificity.
- Enhanced the readability and maintainability of the test cases by using more descriptive selectors.
… experience

- Updated button classes in the sidebar component to enhance visual feedback with transition effects.
- Changed background color for improved contrast and accessibility.
- Ensured consistency in styling across different themes (light and dark).

This comment has been minimized.

@joshsadam joshsadam marked this pull request as ready for review December 6, 2024 17:27
@joshsadam joshsadam self-assigned this Dec 6, 2024
@joshsadam joshsadam added enhancement New feature or request ready for review Pull request is ready for review labels Dec 6, 2024
Copy link
Member

@ericenns ericenns left a comment

Choose a reason for hiding this comment

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

This looks good to me and is working as expected.

Copy link
Contributor

@deepsidhu85 deepsidhu85 left a comment

Choose a reason for hiding this comment

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

This looks great, really helps with the context.

@deepsidhu85 deepsidhu85 merged commit 0483a39 into main Dec 9, 2024
4 checks passed
@deepsidhu85 deepsidhu85 deleted the sidebar-enhancements branch December 9, 2024 20:13
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request ready for review Pull request is ready for review
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants