Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
feat(algolia-search): allow translating search modal (#7666)
Co-authored-by: Joshua Chen <sidachen2003@gmail.com>
- Loading branch information
Showing
27 changed files
with
759 additions
and
11 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
172 changes: 172 additions & 0 deletions
172
packages/docusaurus-theme-search-algolia/src/theme/SearchTranslations/index.ts
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,172 @@ | ||
| /** | ||
| * Copyright (c) Facebook, Inc. and its affiliates. | ||
| * | ||
| * This source code is licensed under the MIT license found in the | ||
| * LICENSE file in the root directory of this source tree. | ||
| */ | ||
|
|
||
| import {translate} from '@docusaurus/Translate'; | ||
|
|
||
| import type {DocSearchTranslations} from '@docsearch/react'; | ||
|
|
||
| const translations: DocSearchTranslations & {placeholder: string} = { | ||
| button: { | ||
| buttonText: translate({ | ||
| id: 'theme.SearchBar.label', | ||
| message: 'Search', | ||
| description: 'The ARIA label and placeholder for search button', | ||
| }), | ||
| buttonAriaLabel: translate({ | ||
| id: 'theme.SearchBar.label', | ||
| message: 'Search', | ||
| description: 'The ARIA label and placeholder for search button', | ||
| }), | ||
| }, | ||
| modal: { | ||
| searchBox: { | ||
| resetButtonTitle: translate({ | ||
| id: 'theme.SearchModal.searchBox.resetButtonTitle', | ||
| message: 'Clear the query', | ||
| description: 'The label and ARIA label for search box reset button', | ||
| }), | ||
| resetButtonAriaLabel: translate({ | ||
| id: 'theme.SearchModal.searchBox.resetButtonTitle', | ||
| message: 'Clear the query', | ||
| description: 'The label and ARIA label for search box reset button', | ||
| }), | ||
| cancelButtonText: translate({ | ||
| id: 'theme.SearchModal.searchBox.cancelButtonText', | ||
| message: 'Cancel', | ||
| description: 'The label and ARIA label for search box cancel button', | ||
| }), | ||
| cancelButtonAriaLabel: translate({ | ||
| id: 'theme.SearchModal.searchBox.cancelButtonText', | ||
| message: 'Cancel', | ||
| description: 'The label and ARIA label for search box cancel button', | ||
| }), | ||
| }, | ||
| startScreen: { | ||
| recentSearchesTitle: translate({ | ||
| id: 'theme.SearchModal.startScreen.recentSearchesTitle', | ||
| message: 'Recent', | ||
| description: 'The title for recent searches', | ||
| }), | ||
| noRecentSearchesText: translate({ | ||
| id: 'theme.SearchModal.startScreen.noRecentSearchesText', | ||
| message: 'No recent searches', | ||
| description: 'The text when no recent searches', | ||
| }), | ||
| saveRecentSearchButtonTitle: translate({ | ||
| id: 'theme.SearchModal.startScreen.saveRecentSearchButtonTitle', | ||
| message: 'Save this search', | ||
| description: 'The label for save recent search button', | ||
| }), | ||
| removeRecentSearchButtonTitle: translate({ | ||
| id: 'theme.SearchModal.startScreen.removeRecentSearchButtonTitle', | ||
| message: 'Remove this search from history', | ||
| description: 'The label for remove recent search button', | ||
| }), | ||
| favoriteSearchesTitle: translate({ | ||
| id: 'theme.SearchModal.startScreen.favoriteSearchesTitle', | ||
| message: 'Favorite', | ||
| description: 'The title for favorite searches', | ||
| }), | ||
| removeFavoriteSearchButtonTitle: translate({ | ||
| id: 'theme.SearchModal.startScreen.removeFavoriteSearchButtonTitle', | ||
| message: 'Remove this search from favorites', | ||
| description: 'The label for remove favorite search button', | ||
| }), | ||
| }, | ||
| errorScreen: { | ||
| titleText: translate({ | ||
| id: 'theme.SearchModal.errorScreen.titleText', | ||
| message: 'Unable to fetch results', | ||
| description: 'The title for error screen of search modal', | ||
| }), | ||
| helpText: translate({ | ||
| id: 'theme.SearchModal.errorScreen.helpText', | ||
| message: 'You might want to check your network connection.', | ||
| description: 'The help text for error screen of search modal', | ||
| }), | ||
| }, | ||
| footer: { | ||
| selectText: translate({ | ||
| id: 'theme.SearchModal.footer.selectText', | ||
| message: 'to select', | ||
| description: 'The explanatory text of the action for the enter key', | ||
| }), | ||
| selectKeyAriaLabel: translate({ | ||
| id: 'theme.SearchModal.footer.selectKeyAriaLabel', | ||
| message: 'Enter key', | ||
| description: | ||
| 'The ARIA label for the Enter key button that makes the selection', | ||
| }), | ||
| navigateText: translate({ | ||
| id: 'theme.SearchModal.footer.navigateText', | ||
| message: 'to navigate', | ||
| description: | ||
| 'The explanatory text of the action for the Arrow up and Arrow down key', | ||
| }), | ||
| navigateUpKeyAriaLabel: translate({ | ||
| id: 'theme.SearchModal.footer.navigateUpKeyAriaLabel', | ||
| message: 'Arrow up', | ||
| description: | ||
| 'The ARIA label for the Arrow up key button that makes the navigation', | ||
| }), | ||
| navigateDownKeyAriaLabel: translate({ | ||
| id: 'theme.SearchModal.footer.navigateDownKeyAriaLabel', | ||
| message: 'Arrow down', | ||
| description: | ||
| 'The ARIA label for the Arrow down key button that makes the navigation', | ||
| }), | ||
| closeText: translate({ | ||
| id: 'theme.SearchModal.footer.closeText', | ||
| message: 'to close', | ||
| description: 'The explanatory text of the action for Escape key', | ||
| }), | ||
| closeKeyAriaLabel: translate({ | ||
| id: 'theme.SearchModal.footer.closeKeyAriaLabel', | ||
| message: 'Escape key', | ||
| description: | ||
| 'The ARIA label for the Escape key button that close the modal', | ||
| }), | ||
| searchByText: translate({ | ||
| id: 'theme.SearchModal.footer.searchByText', | ||
| message: 'Search by', | ||
| description: 'The text explain that the search is making by Algolia', | ||
| }), | ||
| }, | ||
| noResultsScreen: { | ||
| noResultsText: translate({ | ||
| id: 'theme.SearchModal.noResultsScreen.noResultsText', | ||
| message: 'No results for', | ||
| description: | ||
| 'The text explains that there are no results for the following search', | ||
| }), | ||
| suggestedQueryText: translate({ | ||
| id: 'theme.SearchModal.noResultsScreen.suggestedQueryText', | ||
| message: 'Try searching for', | ||
| description: | ||
| 'The text for the suggested query when no results are found for the following search', | ||
| }), | ||
| reportMissingResultsText: translate({ | ||
| id: 'theme.SearchModal.noResultsScreen.reportMissingResultsText', | ||
| message: 'Believe this query should return results?', | ||
| description: | ||
| 'The text for the question where the user thinks there are missing results', | ||
| }), | ||
| reportMissingResultsLinkText: translate({ | ||
| id: 'theme.SearchModal.noResultsScreen.reportMissingResultsLinkText', | ||
| message: 'Let us know.', | ||
| description: 'The text for the link to report missing results', | ||
| }), | ||
| }, | ||
| }, | ||
| placeholder: translate({ | ||
| id: 'theme.SearchModal.placeholder', | ||
| message: 'Search docs', | ||
| description: 'The placeholder of the input of the DocSearch pop-up modal', | ||
| }), | ||
| }; | ||
|
|
||
| export default translations; |
23 changes: 23 additions & 0 deletions
23
packages/docusaurus-theme-translations/locales/ar/theme-search-algolia.json
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
23 changes: 23 additions & 0 deletions
23
packages/docusaurus-theme-translations/locales/bn/theme-search-algolia.json
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
23 changes: 23 additions & 0 deletions
23
packages/docusaurus-theme-translations/locales/cs/theme-search-algolia.json
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.