Parsely / wp-parsely

The official WordPress plugin for Parse.ly - makes it a snap to add the required tracking code to enable Parse.ly on your WordPress site.
https://wordpress.org/plugins/wp-parsely/
GNU General Public License v2.0
64 stars 32 forks source link

Dashboard: Implement React Routing and Page Navigation #2940

Closed vaurdan closed 1 week ago

vaurdan commented 1 week ago

Description

This PR extends the work on #2937, by converting the dashboard in a sort of SPA, using React Router to handle the hash routing, and adds some barebones components and effects to handle the navigation.

Motivation and context

Be able to extend the dashboard in different pages, and still being able to navigate to those pages using the native WordPress sidebar menu.

How has this been tested?

Tested locally on my environment by playing the the different pages.

Screenshots (if appropriate)

https://github.com/user-attachments/assets/56e5cde7-c6fd-4778-8e2d-94c1229ad0fc

Summary by CodeRabbit

Release Notes

coderabbitai[bot] commented 1 week ago

[!CAUTION]

Review failed

The pull request is closed.

πŸ“ Walkthrough
πŸ“ Walkthrough ## Walkthrough The pull request introduces several changes to the `wp-parsely` project, focusing on enhancing the dashboard functionality and navigation. A new dependency, `react-router-dom`, is added to the `package.json` file. The `Dashboard_Page` class is updated to improve submenu highlighting and includes additional submenu items. Multiple new React components are created to facilitate routing within the dashboard, including `ParselyDashboard`, `DashboardPage`, `TrafficBoostPage`, and `SettingsPage`, each providing a basic structure for their respective views. ## Changes | File Path | Change Summary | |-----------------------------------------------------------|-----------------------------------------------------------------------------------------------------| | `package.json` | Added new dependencies: `"@types/react-router-dom": "^5.3.3"` and `"react-router-dom": "^6.28.0"`; `"lodash.debounce": "^4.0.8"` unchanged. | | `src/UI/class-dashboard-page.php` | Added method `fix_submenu_highlighting`; updated `add_dashboard_page_to_menu` to include three submenus. | | `src/content-helper/dashboard-page/dashboard-page.tsx` | Introduced `ParselyDashboard` component; integrated React Router; added routing and submenu highlighting logic. | | `src/content-helper/dashboard-page/pages/dashboard/page-component.tsx` | Added new component `DashboardPage` for the dashboard view. | | `src/content-helper/dashboard-page/pages/index.tsx` | Exported new components: `DashboardPage`, `TrafficBoostPage`, `SettingsPage`. | | `src/content-helper/dashboard-page/pages/settings/page-component.tsx` | Added new component `SettingsPage` for settings view. | | `src/content-helper/dashboard-page/pages/traffic-boost/page-component.tsx` | Added new component `TrafficBoostPage` for traffic boost view. | ## Possibly related PRs - **#2841**: This PR updates the `package.json` file, which is relevant as it also involves changes to dependencies, although it focuses on different packages. - **#2940**: This PR adds the same new dependency `"react-router-dom": "^6.28.0"` to the `package.json`, directly relating to the changes made in the main PR. - **#2937**: This PR introduces a `Dashboard_Page` class in `src/UI/class-dashboard-page.php`, which is relevant as it enhances the dashboard functionality, similar to the changes in the main PR. - **#2939**: This PR modifies the `Dashboard_Page` class in `src/UI/class-dashboard-page.php` to include user permissions for the Traffic Boost feature, which is related to the dashboard functionality discussed in the main PR. - **#2940**: This PR implements React Router for navigation within the dashboard, which aligns with the changes made in the main PR regarding the integration of React Router. ## Suggested labels `Feature: Traffic Boost`, `javascript`

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

❀️ Share - [X](https://twitter.com/intent/tweet?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A&url=https%3A//coderabbit.ai) - [Mastodon](https://mastodon.social/share?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A%20https%3A%2F%2Fcoderabbit.ai) - [Reddit](https://www.reddit.com/submit?title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&text=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code.%20Check%20it%20out%3A%20https%3A//coderabbit.ai) - [LinkedIn](https://www.linkedin.com/sharing/share-offsite/?url=https%3A%2F%2Fcoderabbit.ai&mini=true&title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&summary=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code)
πŸͺ§ Tips ### Chat There are 3 ways to chat with [CodeRabbit](https://coderabbit.ai): - Review comments: Directly reply to a review comment made by CodeRabbit. Example: - `I pushed a fix in commit , please review it.` - `Generate unit testing code for this file.` - `Open a follow-up GitHub issue for this discussion.` - Files and specific lines of code (under the "Files changed" tab): Tag `@coderabbitai` in a new review comment at the desired location with your query. Examples: - `@coderabbitai generate unit testing code for this file.` - `@coderabbitai modularize this function.` - PR comments: Tag `@coderabbitai` in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples: - `@coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.` - `@coderabbitai read src/utils.ts and generate unit testing code.` - `@coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.` - `@coderabbitai help me debug CodeRabbit configuration file.` Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. ### CodeRabbit Commands (Invoked using PR comments) - `@coderabbitai pause` to pause the reviews on a PR. - `@coderabbitai resume` to resume the paused reviews. - `@coderabbitai review` to trigger an incremental review. This is useful when automatic reviews are disabled for the repository. - `@coderabbitai full review` to do a full review from scratch and review all the files again. - `@coderabbitai summary` to regenerate the summary of the PR. - `@coderabbitai resolve` resolve all the CodeRabbit review comments. - `@coderabbitai configuration` to show the current CodeRabbit configuration for the repository. - `@coderabbitai help` to get help. ### Other keywords and placeholders - Add `@coderabbitai ignore` anywhere in the PR description to prevent this PR from being reviewed. - Add `@coderabbitai summary` to generate the high-level summary at a specific location in the PR description. - Add `@coderabbitai` anywhere in the PR title to generate the title automatically. ### Documentation and Community - Visit our [Documentation](https://coderabbit.ai/docs) for detailed information on how to use CodeRabbit. - Join our [Discord Community](http://discord.gg/coderabbit) to get help, request features, and share feedback. - Follow us on [X/Twitter](https://twitter.com/coderabbitai) for updates and announcements.
acicovic commented 1 week ago

@vaurdan, my messaging app is down, I've sent you an email. Will look into this soon! πŸ™‚