mirror of https://github.com/toeverything/AFFiNE.git synced 2026-02-14 13:25:12 +00:00

Files

donteatfriedrice a828c74f87 feat(editor): add experimental feature adapter panel to AFFiNE canary (#12489 )

Closes: [BS-2539](https://linear.app/affine-design/issue/BS-2539/为-affine-添加-ef，并且支持在-affine-预览对应的功能)

> [!warning]
> This feature is only available in the canary build and is intended for debugging purposes.

<!-- This is an auto-generated comment: release notes by coderabbit.ai -->
## Summary by CodeRabbit

- **New Features**
  - Introduced an "Adapter Panel" feature with a new sidebar tab for previewing document content in multiple formats (Markdown, PlainText, HTML, Snapshot), controllable via a feature flag.
  - Added a fully integrated adapter panel component with reactive UI elements for selecting adapters, toggling HTML preview modes, and updating content.
  - Provided a customizable adapter panel for both main app and playground environments, supporting content transformation pipelines and export previews.
  - Enabled seamless toggling and live updating of adapter panel content through intuitive menus and controls.

- **Localization**
  - Added English translations and descriptive settings for the Adapter Panel feature.

- **Chores**
  - Added new package and workspace dependencies along with TypeScript project references to support the Adapter Panel modules and components.
<!-- end of auto-generated comment: release notes by coderabbit.ai -->

2025-05-23 14:08:12 +00:00

src

feat(editor): add experimental feature adapter panel to AFFiNE canary (#12489 )

2025-05-23 14:08:12 +00:00

.gitignore

refactor(i18n): lazy load languages (#8456 )

2024-10-10 09:03:06 +00:00

.i18n-codegen.json

chore: add monorepo tools (#9196 )

2024-12-24 15:29:48 +08:00

build.ts

feat(i18n): introduce server error i18n (#9953 )

2025-02-05 12:30:19 +00:00

cleanup.mjs

chore(i18n): cleanup i18n file (#8318 )

2024-09-20 06:25:17 +00:00

crowdin.yml

feat: sync i18n with crowdin (#8293 )

2024-09-19 05:30:18 +00:00

package.json

chore: bump up all non-major npm dependencies (#12151 )

2025-05-06 14:47:24 +00:00

README.md

refactor(i18n): new hook api (#7273 )

2024-06-20 02:19:41 +00:00

tsconfig.json

chore(server): stdout is enough for collecting server logging (#9964 )

2025-02-05 13:25:11 +00:00

README.md

i18n

Usages

Update missing translations into the base resources, a.k.a the src/resources/en.json
Replace literal text with translation keys

import { useI18n, LOCALES } from '@affine/i18n';
// src/resources/en.json
// {
//     'Text': 'some text',
//     'Switch to language': 'Switch to {{language}}', // <- you can interpolation by curly brackets
// };

const App = () => {
  const i18n = useI18n();
  const changeLanguage = (language: string) => {
    i18n.changeLanguage(language);
  };

  return (
    <div>
      <div>{i18n['Workspace Settings']()}</div>
      <>
        {LOCALES.map(option => {
          return (
            <button
              key={option.name}
              onClick={() => {
                changeLanguage(option.tag);
              }}
            >
              {option.originalName}
            </button>
          );
        })}
      </>
    </div>
  );
};

How the i18n workflow works?

When the src/resources/en.json(base language) updated and merged to the develop branch, will trigger the languages-sync action.
The languages-sync action will check the base language and add missing translations to the Tolgee platform.
This way, partners from the community can update the translations.

How to sync translations manually

Set token as environment variable

export TOLGEE_API_KEY=tgpak_XXXXXXX

Run the sync-languages:check to check all languages
Run the sync-languages script to add new keys to the Tolgee platform
Run the download-resources script to download the latest full-translation translation resources from the Tolgee platform

README.md

i18n

Usages

How the i18n workflow works?

How to sync translations manually

References