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(highlighting): support array syntax for nested attributes #418

Merged
merged 6 commits into from
Jan 29, 2021

Conversation

shortcuts
Copy link
Member

Summary
Allow attribute key to receive a string[] containing the path of the highlighted element in the hit.

TypeScript
I couldn't find a good way to implement deep object pathing, so it's not typed for now. It also looks like that a PathOf type is
still discussed.

@codesandbox-ci
Copy link

codesandbox-ci bot commented Jan 28, 2021

This pull request is automatically built and testable in CodeSandbox.

To see build info of the built libraries, click here or the icon next to each commit SHA.

Latest deployment of this branch, based on commit 7f9a2f6:

Sandbox Source
@algolia/js-example Configuration
@algolia/react-renderer-example Configuration

Copy link
Member

@francoischalifour francoischalifour left a comment

Choose a reason for hiding this comment

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

Can we add a test with an attribute that contains a . to make sure that it works? It's a recurrent problem for our customers.

Example

const hit = {
  translations: {
    'fr.EN': 'Muggle',
    'fr.CA': 'Muggle',
    'fr.FR': 'Moldu',
  }
}

highlightHit({
  hit,
  attribute: ['translations', 'fr.FR']
})

A successful test and a test that warns would be great!

@francoischalifour francoischalifour changed the title feat(highlighting): Implements array syntax for attributes feat(highlighting): support array syntax for nested attributes Jan 28, 2021
Copy link
Member

@francoischalifour francoischalifour left a comment

Choose a reason for hiding this comment

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

Nice–good to go with these last changes!

packages/website/docs/highlightHit.md Outdated Show resolved Hide resolved
packages/website/docs/highlightHit.md Outdated Show resolved Hide resolved
packages/website/docs/highlightHit.md Outdated Show resolved Hide resolved
@shortcuts shortcuts merged commit 4ad4e41 into next Jan 29, 2021
@shortcuts shortcuts deleted the feat/highlightingArrayAttribute branch January 29, 2021 09:06
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