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

refactor(v2): add more translatable strings #4219

Merged
merged 6 commits into from
Feb 18, 2021
Merged

Conversation

lex111
Copy link
Contributor

@lex111 lex111 commented Feb 12, 2021

Motivation

Basically adding support for translating arial-label / title attributes.

Have you read the Contributing Guidelines on pull requests?

Yes

Test Plan

Preview.

Related PRs

(If this PR adds or changes functionality, please take some time to update the docs at https://github.com/facebook/docusaurus, and link to your PR here.)

@lex111 lex111 requested a review from slorber as a code owner February 12, 2021 11:12
@facebook-github-bot facebook-github-bot added the CLA Signed Signed Facebook CLA label Feb 12, 2021
@lex111
Copy link
Contributor Author

lex111 commented Feb 12, 2021

@slorber could you confirm the correctness of these changes? After that I will add the Russian translation (and you will provide the translation for the new messages).

And also, please write in the to-do list that we need pluralization/number localization support and of course the ability to passing parameters to the translation API (allow using interpolation, I mean).

@netlify
Copy link

netlify bot commented Feb 12, 2021

[V1] Deploy preview success

Built with commit 09794cc

https://deploy-preview-4219--docusaurus-1.netlify.app

@github-actions
Copy link

github-actions bot commented Feb 12, 2021

Size Change: +6 B (0%)

Total Size: 158 kB

ℹ️ View Unchanged
Filename Size Change
website/build/assets/css/styles.********.css 17.6 kB +8 B (0%)
website/build/assets/js/main.********.js 111 kB -5 B (0%)
website/build/blog/2017/12/14/introducing-docusaurus/index.html 21.7 kB +1 B (0%)
website/build/docs/introduction/index.html 180 B 0 B
website/build/index.html 6.96 kB +2 B (0%)

compressed-size-action

@netlify
Copy link

netlify bot commented Feb 12, 2021

Deploy preview for docusaurus-2 ready!

Built with commit 09794cc

https://deploy-preview-4219--docusaurus-2.netlify.app

@github-actions
Copy link

github-actions bot commented Feb 12, 2021

⚡️ Lighthouse report for the changes in this PR:

Category Score
🟠 Performance 68
🟢 Accessibility 96
🟢 Best practices 100
🟢 SEO 100
🟢 PWA 95

Lighthouse ran on https://deploy-preview-4219--docusaurus-2.netlify.app/classic/

Copy link
Collaborator

@slorber slorber left a comment

Choose a reason for hiding this comment

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

Great thanks, that looks fine to me.
Just think we should find good translation ids, and ".ariaLabel" may not be explicit enough IMHO

I plan to look for a solution for string interpolations soon.

@@ -112,6 +112,7 @@ function DocItem(props: Props): JSX.Element {
<div className="col text--right">
<em>
<small>
{/* TODO: wait for using interpolation in translation function */}
Copy link
Collaborator

Choose a reason for hiding this comment

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

Yes, this is a missing piece that I'd like to add, not sure how yet.

React-intl has this feature to handle these kind of cases, and allow to even inject components into a translated string (like a link). But I want to add a very minimal runtime, not something too heavy with many features we don't need. If you know a good lib for that let me know

Copy link
Collaborator

Choose a reason for hiding this comment

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

not 100% related but kind of the same problem if you want to interleave links in a translated string.

On Jest website I used a markdown parser on the client (v1 had a MarkdownBlock component), and it allows to wire the Docusaurus link for the markdown links somehow.

image

image

image

But if we make all this possible through the Translate component, I'd like to avoid the cost of shipping a full md parser to the client.

lex111 and others added 3 commits February 12, 2021 17:10
Co-authored-by: Sébastien Lorber <slorber@users.noreply.github.com>
@slorber
Copy link
Collaborator

slorber commented Feb 18, 2021

LGTM thanks 👍

Good enough to merge, and we'll keep improving this in the next PRs

@slorber slorber merged commit 08fa318 into master Feb 18, 2021
@slorber slorber added the pr: polish This PR adds a very minor behavior improvement that users will enjoy. label Feb 18, 2021
@lex111 lex111 deleted the lex111/extend-trans branch February 19, 2021 18:20
@lex111 lex111 added this to the v2.0.0-alpha.71 milestone Mar 1, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
CLA Signed Signed Facebook CLA pr: polish This PR adds a very minor behavior improvement that users will enjoy.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants