-
Notifications
You must be signed in to change notification settings - Fork 1.6k
feat: replace translate boilerplate with extension in editor #10054
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
Merged
Merged
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Some comments aren't visible on the classic Files Changed page.
There are no files selected for viewing
This file contains hidden or 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 hidden or 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
92 changes: 92 additions & 0 deletions
92
plugins/text-editor-resources/src/components/extension/i18nPlaceholder.ts
This file contains hidden or 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,92 @@ | ||
| // | ||
| // Copyright © 2025 Hardcore Engineering Inc. | ||
| // | ||
| // Licensed under the Eclipse Public License, Version 2.0 (the "License"); | ||
| // you may not use this file except in compliance with the License. You may | ||
| // obtain a copy of the License at https://www.eclipse.org/legal/epl-2.0 | ||
| // | ||
| // Unless required by applicable law or agreed to in writing, software | ||
| // distributed under the License is distributed on an "AS IS" BASIS, | ||
| // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
| // | ||
| // See the License for the specific language governing permissions and | ||
| // limitations under the License. | ||
| // | ||
|
|
||
| import { type IntlString, translate } from '@hcengineering/platform' | ||
| import { type ThemeOptions } from '@hcengineering/theme' | ||
| import { type PlaceholderOptions, Placeholder } from '@tiptap/extension-placeholder' | ||
| import { type Readable, get } from 'svelte/store' | ||
|
|
||
| export interface I18nPlaceholderOptions extends PlaceholderOptions { | ||
| placeholderIntl: IntlString | ||
| placeholderIntlParams?: Record<string, any> | ||
| themeStore: Readable<ThemeOptions> | ||
| } | ||
|
|
||
| export interface I18nPlaceholderStorage { | ||
| placeholder: string | ||
| unsubscribe?: () => void | ||
| } | ||
|
|
||
| export const I18nPlaceholderExtension = Placeholder.extend<I18nPlaceholderOptions, I18nPlaceholderStorage>({ | ||
| name: 'i18n-placeholder', | ||
|
|
||
| addOptions () { | ||
| return { | ||
| ...this.parent?.(), | ||
| placeholderIntl: '' as IntlString, | ||
| placeholderIntlParams: {}, | ||
| themeStore: undefined as any | ||
| } | ||
| }, | ||
|
|
||
| addStorage () { | ||
| return { | ||
| placeholder: '', | ||
| unsubscribe: undefined | ||
| } | ||
| }, | ||
|
|
||
| onCreate () { | ||
| const options = this.options | ||
| const storage = this.storage | ||
|
|
||
| const placeholderIntl = options.placeholderIntl | ||
| const placeholderIntlParams = options.placeholderIntlParams | ||
|
|
||
| // Set the placeholder function before any rendering happens | ||
| this.options.placeholder = (): string => storage.placeholder | ||
|
|
||
| // Get initial translation | ||
| const theme = get(options.themeStore) | ||
| if (placeholderIntl !== undefined) { | ||
| void translate(placeholderIntl, placeholderIntlParams, theme?.language ?? 'en').then((translated) => { | ||
| storage.placeholder = translated | ||
| // Force initial update | ||
| if (this.editor !== undefined && this.editor !== null) { | ||
| this.editor.view.dispatch(this.editor.state.tr) | ||
| } | ||
| }) | ||
| } | ||
|
|
||
| // Subscribe to theme store changes | ||
| if (options.themeStore !== undefined && options.themeStore !== null) { | ||
| storage.unsubscribe = options.themeStore.subscribe((theme) => { | ||
| if (placeholderIntl !== undefined) { | ||
| void translate(placeholderIntl, placeholderIntlParams, theme.language).then((translated) => { | ||
aonnikov marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| storage.placeholder = translated | ||
| // Force editor update to show new translation | ||
| if (this.editor !== undefined && this.editor !== null) { | ||
| this.editor.view.dispatch(this.editor.state.tr) | ||
| } | ||
| }) | ||
| } | ||
| }) | ||
| } | ||
| }, | ||
|
|
||
| onDestroy () { | ||
| this.storage.unsubscribe?.() | ||
| } | ||
| }) | ||
This file contains hidden or 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.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.