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

Map block: UI updates to inspector controls #40837

Merged
merged 2 commits into from
Jan 3, 2025
Merged

Conversation

ntsekouras
Copy link
Member

Part of: #40718

Some minor UI Improvements to the Map block inspector controls.
The issue suggests using the HeightControl, but for now I've updated to use the NumberControl.
HeightControl would require some upstream changes to probably allow defining the available units, as it's currently using the theme's available units and it seemed to me that we specifically only want to define this in pixels. We can do that in follow ups.

Other information:

  • Have you written new tests for your changes, if applicable?
  • Have you checked the E2E test CI results, and verified that your changes do not break them?
  • Have you tested your changes on WordPress.com, if applicable (if so, you'll see a generated comment below with a script to run)?

Testing instructions:

  1. insert a map block, open the inspector controls and observe the following
  2. "Map Settings" changed to "Settings"
  3. "Show street names" changed to "Show labels"
  4. "Marker Color" changed to "Marker"
  5. height in pixels uses HeightControl
  6. No regressions are introduced
Before After
bef after

@ntsekouras ntsekouras added [Type] Enhancement Changes to an existing feature — removing, adding, or changing parts of it [Block] Map [Feature] Maps labels Jan 3, 2025
@ntsekouras ntsekouras self-assigned this Jan 3, 2025
Copy link
Contributor

github-actions bot commented Jan 3, 2025

Are you an Automattician? Please test your changes on all WordPress.com environments to help mitigate accidental explosions.

  • To test on WoA, go to the Plugins menu on a WordPress.com Simple site. Click on the "Upload" button and follow the upgrade flow to be able to upload, install, and activate the Jetpack Beta plugin. Once the plugin is active, go to Jetpack > Jetpack Beta, select your plugin, and enable the map-block-ui-updates branch.

  • To test on Simple, run the following command on your sandbox:

    bin/jetpack-downloader test jetpack map-block-ui-updates
    

Interested in more tips and information?

  • In your local development environment, use the jetpack rsync command to sync your changes to a WoA dev blog.
  • Read more about our development workflow here: PCYsg-eg0-p2
  • Figure out when your changes will be shipped to customers here: PCYsg-eg5-p2

@github-actions github-actions bot added [Plugin] Jetpack Issues about the Jetpack plugin. https://wordpress.org/plugins/jetpack/ [Tests] Includes Tests labels Jan 3, 2025
Copy link
Contributor

github-actions bot commented Jan 3, 2025

Thank you for your PR!

When contributing to Jetpack, we have a few suggestions that can help us test and review your patch:

  • ✅ Include a description of your PR changes.
  • ✅ Add a "[Status]" label (In Progress, Needs Team Review, ...).
  • ✅ Add a "[Type]" label (Bug, Enhancement, Janitorial, Task).
  • ✅ Add testing instructions.
  • 🔴 Specify whether this PR includes any changes to data or privacy.
  • ✅ Add changelog entries to affected projects

This comment will be updated as you work on your PR and make changes. If you think that some of those checks are not needed for your PR, please explain why you think so. Thanks for cooperation 🤖


The e2e test report can be found here. Please note that it can take a few minutes after the e2e tests checks are complete for the report to be available.


🔴 Action required: We would recommend that you add a section to the PR description to specify whether this PR includes any changes to data or privacy, like so:

## Does this pull request change what data or activity we track or use?

My PR adds *x* and *y*.

Follow this PR Review Process:

  1. Ensure all required checks appearing at the bottom of this PR are passing.
  2. Choose a review path based on your changes:
    • A. Team Review: add the "[Status] Needs Team Review" label
      • For most changes, including minor cross-team impacts.
      • Example: Updating a team-specific component or a small change to a shared library.
    • B. Crew Review: add the "[Status] Needs Review" label
      • For significant changes to core functionality.
      • Example: Major updates to a shared library or complex features.
    • C. Both: Start with Team, then request Crew
      • For complex changes or when you need extra confidence.
      • Example: Refactor affecting multiple systems.
  3. Get at least one approval before merging.

Still unsure? Reach out in #jetpack-developers for guidance!


Jetpack plugin:

The Jetpack plugin has different release cadences depending on the platform:

  • WordPress.com Simple releases happen semi-continuously (PCYsg-Jjm-p2).
  • WoA releases happen weekly.
  • Releases to self-hosted sites happen monthly. The next release is scheduled for January 7, 2025 (scheduled code freeze on undefined).

If you have any questions about the release process, please ask in the #jetpack-releases channel on Slack.

@github-actions github-actions bot added the [Status] Needs Author Reply We would need you to make some changes or provide some more details about your PR. Thank you! label Jan 3, 2025
*
* @param {Event} event - The change event object.
*/
const onHeightChange = event => {
Copy link
Member Author

Choose a reason for hiding this comment

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

I might be missing something, but I'm not sure this is needed. I couldn't observe anything weird without this callback, which eventually just updates the mapHeight attribute.

setAttributes( { mapHeight: event.target.value } );
// If this input isn't focussed, the onBlur handler won't be triggered
// to commit the map size, so we need to check for that.
if ( event.target !== event.target.ownerDocument.activeElement ) {
Copy link
Member Author

Choose a reason for hiding this comment

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

Similar to the onHeightChange comment, I'm not sure if this is needed too since NumberControl should handle the onBlur too.

Copy link
Member

@manzoorwanijk manzoorwanijk 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 code-wise but I tried to test it and it asks me for the access token which I don't have

image

Copy link
Member

@manzoorwanijk manzoorwanijk left a comment

Choose a reason for hiding this comment

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

I found an API key in the Secret Store and it worked.

image

@ntsekouras ntsekouras merged commit e82934d into trunk Jan 3, 2025
62 checks passed
@ntsekouras ntsekouras deleted the map-block-ui-updates branch January 3, 2025 11:59
@github-actions github-actions bot added this to the jetpack/14.2 milestone Jan 3, 2025
@github-actions github-actions bot removed [Status] Needs Author Reply We would need you to make some changes or provide some more details about your PR. Thank you! [Status] Needs Team Review labels Jan 3, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
[Block] Map [Feature] Maps [Plugin] Jetpack Issues about the Jetpack plugin. https://wordpress.org/plugins/jetpack/ [Tests] Includes Tests [Type] Enhancement Changes to an existing feature — removing, adding, or changing parts of it
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants