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

feat(docsearch): allow to set component props individually and inherit undefined ones from the config #178

Merged
merged 4 commits into from
Oct 23, 2023
Merged

feat(docsearch): allow to set component props individually and inherit undefined ones from the config #178

merged 4 commits into from
Oct 23, 2023

Conversation

Lehoczky
Copy link
Contributor

@Lehoczky Lehoczky commented Sep 28, 2023

Types of changes

  • Bug fix (a non-breaking change which fixes an issue)
  • New feature (a non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to change)

Description

Resolves #172

  1. The <AlgoliaDocSearch /> component now accepts every configuration option as different prop instead of one options object:
<template>
  <AlgoliaDocSearch 
    applicationId="appId" 
    apiKey="key" 
    indexName="indexName" 
    placeholder="Search"
    :searchParameters="{}"
    :disableUserPersonalization="false"
    initialQuery=""
    :translations="{}"
    :transform-items=":transform-items"
    ...
  />
</template>
  1. Function options has also been removed from nuxt.config.ts
  2. The documentation has been updated to match the official docs
  3. Several new pages have been added to the playground which showcases different usage scenarios for the <AlgoliaDocSearch /> component

Note

I wasn't able to start the docs locally on Windows, so I made the changes there blindly. If you could confirm everything looks right, that would be wonderful.

Checklist:

  • My change requires a change to the documentation.
  • I have updated the documentation accordingly.
  • I have added tests to cover my changes (if not applicable, please state why)

@nuxt-studio
Copy link

nuxt-studio bot commented Oct 4, 2023

Live Preview ready!

Name Edit Preview Latest Commit
Algolia Edit on Studio ↗︎ View Live Preview 2683cae

@Lehoczky Lehoczky marked this pull request as ready for review October 4, 2023 17:17
@Baroshem
Copy link
Collaborator

Really nice work @Lehoczky Thanks for that! 💚

@Baroshem Baroshem merged commit e5bd791 into nuxt-modules:chore/1.10.0 Oct 23, 2023
@Lehoczky Lehoczky deleted the fix/172-only-use-function-options-at-component-level branch October 23, 2023 10:09
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants