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

Publicly expose a method for opening Instant Results. #2987

Merged
merged 14 commits into from
Oct 12, 2022
Merged

Conversation

JakePT
Copy link
Contributor

@JakePT JakePT commented Sep 6, 2022

Description of the Change

Publicly expose a method for opening Instant Results, allowing third parties to open Instant Results manually.

I originally implemented this as a custom action hook, but I anticipate some refactoring for #2978 and didn't want to commit to an API just yet. For now this just makes openModal() publicly available.

Closes #2507

How to test the Change

Calling the following code to a theme or plugin should cause Instant Results to open when the button is clicked:

<button id="search-blocks" type="button">Search "Blocks"</button>

<script>
window.addEventListener('DOMContentLoaded', () => {
	document.getElementById('search-blocks').addEventListener('click', () => {
		window.epInstantResults.openModal({ search: "blocks" });
	});
});
</script>

Changelog Entry

Added a method for developers to manually open Instant Results, window.epInstantResults.openModal().

Credits

Props @JakePT

Checklist:

  • I agree to follow this project's Code of Conduct.
  • I have updated the documentation accordingly.
  • I have added tests to cover my change.
  • All new and existing tests pass.

@JakePT JakePT added needs documentation needs tests module:instant-results Issues related to the Instant Results functionality labels Sep 6, 2022
@JakePT JakePT added this to the 4.4.0 milestone Sep 6, 2022
@JakePT JakePT self-assigned this Sep 6, 2022
@JakePT JakePT changed the title WIP: Open Instant Results with an action. WIP: Publicly expose a method for opening Instant Results. Oct 9, 2022
@JakePT JakePT requested a review from felipeelia October 9, 2022 17:06
@JakePT JakePT changed the title WIP: Publicly expose a method for opening Instant Results. Publicly expose a method for opening Instant Results. Oct 9, 2022
@JakePT JakePT marked this pull request as ready for review October 9, 2022 17:07
@felipeelia
Copy link
Member

@JakePT It seems the e2e test is not passing (I've triggered it several times now.) Do you mind fixing it before we merge this one? Thanks!

@felipeelia felipeelia merged commit 2a8cfde into develop Oct 12, 2022
@felipeelia felipeelia deleted the feature/2507 branch October 12, 2022 19:20
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
module:instant-results Issues related to the Instant Results functionality
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Allow more control over which forms trigger Instant Results
2 participants