-
-
Notifications
You must be signed in to change notification settings - Fork 8.7k
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
fix(algolia): add insights property on Algolia Theme Config object TS definition #10048
fix(algolia): add insights property on Algolia Theme Config object TS definition #10048
Conversation
Hi @Virgil993! Thank you for your pull request and welcome to our community. Action RequiredIn order to merge any pull request (code, docs, etc.), we require contributors to sign our Contributor License Agreement, and we don't seem to have one on file for you. ProcessIn order for us to review and merge your suggested changes, please sign at https://code.facebook.com/cla. If you are contributing on behalf of someone else (eg your employer), the individual CLA may not be sufficient and your employer may need to sign the corporate CLA. Once the CLA is signed, our tooling will perform checks and validations. Afterwards, the pull request will be tagged with If you have received this in error or have any questions, please contact us at [email protected]. Thanks! |
✅ [V2]
To edit notification comments on pull requests, go to your Netlify site configuration. |
⚡️ Lighthouse report for the deploy preview of this PR
|
Unfortunately your prettier format probably didn't use the right config 😅 all those are unexpected changes |
This reverts commit 0af2583.
|
Is there any way I can help with this Lint AutoFix workflow? |
Thanks, I'll handle the rest 👍 |
Thank you, hope I could be of help |
Pre-flight checklist
Motivation
I was working with the Docsearch integration and i noticed that the Algolia Theme Config object defined in
@docusaurus/theme-search-algolia
did not have theinsights
property that allows Docsearch to send click events to the Algolia DashboardTest Plan
I added an optional attribute to the Algolia Config Object called
insights
. Because there is no strict validation on the object. This change should allow the user to add theinsights
option and because the props are passed to the docsearch modal it should work as intended. i already tested it on my project and even though i get an IDE error regarding the type, the events are sent to the algolia Dashboard
Test links
The link to the
insights
property as described by docsearchhttps://docsearch.algolia.com/docs/docsearch-v3/#sending-events
The link to the documentation where the algolia object is defined
https://docusaurus.io/docs/search#connecting-algolia
Deploy preview: https://deploy-preview-_____--docusaurus-2.netlify.app/
Related issues/PRs