mirror of https://github.com/toeverything/AFFiNE.git synced 2026-02-12 04:18:54 +00:00

Files

JimmFly ddd7cab414 feat(core): support share edgeless mode (#4856 )

Close #3287

<!--
copilot:all
-->
### <samp>🤖 Generated by Copilot at d3fdf86</samp>

### Summary
📄🚀🔗

<!--
1.  📄 - This emoji represents the page and edgeless modes of sharing a page, as well as the GraphQL operations and types related to public pages.
2.  🚀 - This emoji represents the functionality of publishing and revoking public pages, as well as the confirmation modal and the notifications for the user.
3.  🔗 - This emoji represents the sharing URL and the query parameter for the share mode, as well as the hooks and functions that generate and use the URL.
-->
This pull request adds a feature to the frontend component of AFFiNE that allows the user to share a page in either `page` or `edgeless` mode, which affects the appearance and functionality of the page. It also adds the necessary GraphQL operations, types, and schema to support this feature in the backend, and updates the tests and the storybook stories accordingly.

*  Modify the `useIsSharedPage` hook to accept an optional `shareMode` argument and use the `getWorkspacePublicPagesQuery`, `publishPageMutation`, and `revokePublicPageMutation` from `@affine/graphql`

2023-11-15 16:02:58 +08:00

src

feat(core): support share edgeless mode (#4856 )

2023-11-15 16:02:58 +08:00

.gitignore

refactor(infra): directory structure (#4615 )

2023-10-18 15:30:08 +00:00

build.mjs

refactor(infra): directory structure (#4615 )

2023-10-18 15:30:08 +00:00

dev.mjs

refactor(infra): directory structure (#4615 )

2023-10-18 15:30:08 +00:00

package.json

v0.10.0

2023-11-10 11:42:04 +08:00

project.json

refactor(infra): directory structure (#4615 )

2023-10-18 15:30:08 +00:00

README.md

refactor(infra): directory structure (#4615 )

2023-10-18 15:30:08 +00:00

tsconfig.json

refactor(infra): directory structure (#4615 )

2023-10-18 15:30:08 +00:00

tsconfig.node.json

refactor(infra): directory structure (#4615 )

2023-10-18 15:30:08 +00:00

tsconfig.resources.json

refactor(infra): directory structure (#4615 )

2023-10-18 15:30:08 +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 { useAFFiNEI18N } from '@affine/i18n/hooks';
import { LOCALES, useI18N } 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 t = useAFFiNEI18N();
  const i18n = useI18N();
  const changeLanguage = (language: string) => {
    i18n.changeLanguage(language);
  };

  return (
    <div>
      <div>{t['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