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

Added text and link properties to menu-item.model.ts #3750

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Added text and link properties to menu-item.model.ts #3750

wants to merge 1 commit into from

Conversation

otuoma
Copy link

@otuoma otuoma commented Dec 16, 2024 •
edited
Loading

References

Description

In strongly typed typescript setups, using the properties 'link' and 'text' on instances of MenuItemModel fails with the following error

Object literal may only specify known properties, and 'text' does not exist in type 'MenuItemModel'.

List of changes in this PR:

  • Added link and text properties to MenuItemModel only. From other usage examples, an optional 'icon' property may also be required.

Checklist

This checklist provides a reminder of what we are going to look for when reviewing your PR. You do not need to complete this checklist prior creating your PR (draft PRs are always welcome).
However, reviewers may request that you complete any actions in this list if you have not done so. If you are unsure about an item in the checklist, don't hesitate to ask. We're here to help!

  • My PR is created against the main branch of code (unless it is a backport or is fixing an issue specific to an older branch).
  • My PR is small in size (e.g. less than 1,000 lines of code, not including comments & specs/tests), or I have provided reasons as to why that's not possible.
  • My PR passes ESLint validation using npm run lint
  • My PR doesn't introduce circular dependencies (verified via npm run check-circ-deps)
  • My PR includes TypeDoc comments for all new (or modified) public methods and classes. It also includes TypeDoc for large or complex private methods.
  • My PR passes all specs/tests and includes new/updated specs or tests based on the Code Testing Guide.
  • My PR aligns with Accessibility guidelines if it makes changes to the user interface.
  • My PR uses i18n (internationalization) keys instead of hardcoded English text, to allow for translations.
  • My PR includes details on how to test it. I've provided clear instructions to reviewers on how to successfully test this fix or feature.
  • If my PR includes new libraries/dependencies (in package.json), I've made sure their licenses align with the DSpace BSD License based on the Licensing of Contributions documentation.
  • If my PR includes new features or configurations, I've provided basic technical documentation in the PR itself.
  • If my PR fixes an issue ticket, I've linked them together.

This was referenced Dec 16, 2024
Closed
Open
@tdonohue tdonohue added bug code task 1 APPROVAL pull request only requires a single approval to merge labels Dec 16, 2024
nwoodward
nwoodward approved these changes Jan 6, 2025
View reviewed changes
Copy link
Contributor

@nwoodward nwoodward left a comment

Choose a reason for hiding this comment

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

👍 Thanks @otuoma! I tested this locally, and with those two optional properties I can define a menu item as in your example. In fact, I wasn't able to compile the frontend without them.

@tdonohue
Copy link
Member

tdonohue commented Jan 6, 2025

@otuoma : Took at look at this myself today, and I think the original code you were using may have been wrong.

In #3748 you noted you found this bug by using this code:

@Component({
  selector: 'ds-navbar',
  styleUrls: ['./navbar.component.scss'],
  templateUrl: './navbar.component.html',
  animations: [slideMobileNav]
})
export class NavbarComponent extends BaseComponent implements OnInit {
  scholarsMenu: MenuSection = {
    id: 'scholars_menu',
    visible: true,
    active: false,
    model: { type: MenuItemType.LINK, disabled: false, text: 'Scholar Profiles', link: '/communities/fb79-513', },
    index: 0,
    shouldPersistOnRouteChange: true,
  };

  ngOnInit() {
    super.ngOnInit();
    this.menuService.addSection(this.menuID, this.scholarsMenu);
  }
}

However, I think you have a bug in that code. In order to specify a MenuItemType.LINK you MUST use LinkMenuItemModel like this:

model: { type: MenuItemType.LINK, disabled: false, text: 'Scholar Profiles', link: '/communities/fb79-513', } as LinkMenuItemModel,

If you look in the DSpace codebase, that's how MenuItemType.LINK is always used. A few examples:

So, I believe this PR is unnecessary if you use the code snippet that I've described above.

tdonohue
tdonohue requested changes Jan 10, 2025
View reviewed changes
Copy link
Member

@tdonohue tdonohue left a comment •
edited
Loading

Choose a reason for hiding this comment

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

@otuoma : Please see my comment above. I'm not sure this code change is necessary. Marking this as "Request Changes" until someone has a chance to verify my comment.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@tdonohue tdonohue tdonohue requested changes

@nwoodward nwoodward nwoodward approved these changes

Requested changes must be addressed to merge this pull request.

Assignees

@otuoma otuoma

Labels
1 APPROVAL pull request only requires a single approval to merge bug code task
Projects
DSpace 9.0 Release
Status: 👀 Under Review
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

MenuItemModel lacks text and link properties
3 participants
@otuoma @tdonohue @nwoodward