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(react-instantsearch-hooks web): rename <Stats> translation #5756

Merged
merged 4 commits into from
Jul 18, 2023

Conversation

sarahdayan
Copy link
Member

The <Stats> widget was introduced in #5427 but the translation name isn't consistent with the convention we agreed on in the Translations RFC.

This changes the name for something more consistent and conventional.

The change is breaking for anyone already using the <Stats> widget.

@sarahdayan sarahdayan requested review from a team, dhayab, aymeric-giraudet and Haroenv and removed request for a team July 17, 2023 09:00
@codesandbox-ci
Copy link

codesandbox-ci bot commented Jul 17, 2023

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 f3e81ef:

Sandbox Source
InstantSearch.js Configuration
react-instantsearch-app Configuration
example-react-instantsearch-hooks-default-theme Configuration
example-vue-instantsearch-default-theme Configuration

@aymeric-giraudet
Copy link
Member

It could also be added to the specs there : https://github.com/algolia/instantsearch/blob/master/specs/src/pages/widgets/stats.md

Just something like :

translations:
  - name: rootElementText
    default: ...
    description: ...

Copy link
Member

@dhayab dhayab left a comment

Choose a reason for hiding this comment

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

Thanks for fixing this!

I'm wondering, as it's breaking for current users of the widget, it might be safer to keep translations.stats as a fallback and, if its presence is detected:

  • display a deprecation warning on console
  • reassign to translations.rootElementText

Wdyt?

@sarahdayan sarahdayan requested a review from Haroenv July 17, 2023 12:51
@sarahdayan sarahdayan requested a review from Haroenv July 17, 2023 13:58
@sarahdayan sarahdayan requested a review from Haroenv July 17, 2023 15:24
@sarahdayan sarahdayan merged commit 6c70035 into master Jul 18, 2023
13 checks passed
@sarahdayan sarahdayan deleted the feat/stats-translation-rename branch July 18, 2023 09:14
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.

None yet

4 participants