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

Deprecate NavGroup and move all functionality into NavItem #101

Open
joshuadavidthomas opened this issue Jul 16, 2024 · 3 comments
Open
Labels
🚨 breaking Breaking changes

Comments

@joshuadavidthomas
Copy link
Member

I started out this library in a private repo and went with the simple naive approach of having a NavGroup and NavItem, one being able to have sub-items. But as this library has evolved, it's making less sense to keep them apart.

Recent changes (that have not been published in a new version, yet) have brought them even further together, with NavGroup only differing in a few ways.

@joshuadavidthomas joshuadavidthomas added 🚨 breaking Breaking changes 🧁 needs baking Requires more time for consideration or development before further action labels Jul 16, 2024
@joshuadavidthomas
Copy link
Member Author

This would get rid of the need for the slightly hacky "items": None in NavItem.get_context_data.

@joshuadavidthomas
Copy link
Member Author

I think this is probably the correct way forward, but it will need to be handled gracefully. It's probably too much of a change for the upcoming release (it already has a ton of changes), so we can plan it for the next release.

Let's split it across two releases though:

  1. Move all the functionality within NavItem and have a shell NavGroup that logs a warning about the deprecation when used.
  2. Remove from the library after a bit of time has passed.

If time permits, a Django check might be nice. But that may be overkill and a warning on the NavGroup would probably suffice.

@joshuadavidthomas joshuadavidthomas removed the 🧁 needs baking Requires more time for consideration or development before further action label Jul 16, 2024
@joshuadavidthomas
Copy link
Member Author

joshuadavidthomas commented Jul 20, 2024

This approach would not work if we went down the road of using widgets (#102) so one or the other should be chosen

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
🚨 breaking Breaking changes
Projects
None yet
Development

No branches or pull requests

1 participant