feat: add translations prop to search button

[slorber]

Summary

Ability to translate DocSearch placeholder label, a low hanging fruit as it's the most visible one, but there are probably other labels to allow translating (including aria attributes).

This is a pseudo code suggestion, not sure it works yet :)

You may be happy to know about ComponentProps in TS :)

Result

[lex111]

@francoischalifour please take a look at this.

[francoischalifour]

Thank you @slorber!

There will be other texts that we want to translate like the aria-label of the button. So I think we should rather pass a translations prop with a few keys:

type Translations = Partial<{
  buttonText: string;
  buttonAriaLabel: string;
}>

Wdyt?

(Thanks for letting us know about React.ComponentProps.)

[slorber]

sure, just updated

[francoischalifour]

Thanks!

[francoischalifour]

Released in @docsearch/[email protected].

[slorber]

thanks :)

[meteorlxy]

Seems that this prop is not available in the <DocSearch> component?

[francoischalifour]

@meteorlxy This prop is only available on the DocSearchButton component, exported from the package. It's not yet on the DocSearch component itself. We plan to add it in the future.

[slorber]

@francoischalifour was wondering if you could create an issue to track i18n support?

Some Docusaurus users asked about this and want to have a link to give them ;)

facebook/docusaurus#3643 (comment)

[shortcuts]

Hi @slorber,

Here's some resources you can share with your users:

As DocSearch v3 rely on Autocomplete v1 (which has just been released), we are re-thinking the way we would like to ship a stable version of it.

The next steps are:

• Implement the translations API in Autocomplete
• Package DocSearch v3 directly with Autocomplete (which would offer more flexibility/features and in this case, the translations API)

We will start working on it in the coming months, and will make sure to let you know what's the progress on it!

[slorber]

thanks :)

[stnor]

@shortcuts Any progress on this yet? Estimated arrival? Thanks.

[shortcuts]

Hey @stnor, this task has been delayed for DocSearch but is done on Autocomplete.

I'll tackle it in the next two weeks!