-
Notifications
You must be signed in to change notification settings - Fork 621
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
feat(app-page-builder): add translations features
- Loading branch information
Showing
39 changed files
with
1,042 additions
and
210 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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,23 @@ | ||
import { useQuery } from "@apollo/react-hooks"; | ||
import { | ||
GET_PAGE, | ||
GetPageQueryResponse, | ||
GetPageQueryVariables, | ||
PageResponseData | ||
} from "~/admin/graphql/pages"; | ||
import { PbErrorResponse } from "~/types"; | ||
|
||
export type Page = PageResponseData & { settings: Record<string, any> }; | ||
|
||
export const usePage = ( | ||
pageId: string | ||
): { loading: boolean; page: Page | undefined; error: PbErrorResponse | undefined } => { | ||
const query = useQuery<GetPageQueryResponse, GetPageQueryVariables>(GET_PAGE, { | ||
variables: { id: String(pageId) }, | ||
skip: !pageId | ||
}); | ||
|
||
const { data, error } = query.data?.pageBuilder.getPage ?? { data: null, error: null }; | ||
|
||
return { loading: query.loading, page: (data as Page) || undefined, error: error || undefined }; | ||
}; |
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,7 @@ | ||
export * from "./hooks/usePage"; | ||
export * from "./hooks/useNavigatePage"; | ||
export * from "./hooks/usePreviewPage"; | ||
export * from "./hooks/usePageBuilderSettings"; | ||
export * from "./hooks/useConfigureWebsiteUrl"; | ||
export * from "./hooks/useSiteStatus"; | ||
export * from "./hooks/useAdminPageBuilder"; |
7 changes: 0 additions & 7 deletions
7
packages/app-page-builder/src/admin/views/Menus/validators.ts
This file was deleted.
Oops, something went wrong.
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
41 changes: 0 additions & 41 deletions
41
packages/app-page-builder/src/translations/CollectElementValues.tsx
This file was deleted.
Oops, something went wrong.
14 changes: 14 additions & 0 deletions
14
...p-page-builder/src/translations/ExtractTranslatableValues/AddTranslatableItemsContext.tsx
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,14 @@ | ||
import React from "react"; | ||
import { createDecorator } from "@webiny/react-composition"; | ||
import { EditorProvider } from "~/editor"; | ||
import { TranslationProvider } from "./TranslationContext"; | ||
|
||
export const AddTranslatableItemsContext = createDecorator(EditorProvider, Original => { | ||
return function EditorProvider(props) { | ||
return ( | ||
<TranslationProvider> | ||
<Original {...props} /> | ||
</TranslationProvider> | ||
); | ||
}; | ||
}); |
60 changes: 60 additions & 0 deletions
60
...ages/app-page-builder/src/translations/ExtractTranslatableValues/CollectElementValues.tsx
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,60 @@ | ||
import React, { useEffect } from "react"; | ||
import { ElementRendererInputs } from "@webiny/app-page-builder-elements/contexts/ElementRendererInputs"; | ||
import { usePage } from "~/pageEditor"; | ||
import { | ||
TranslatableItem, | ||
useTranslations | ||
} from "~/translations/ExtractTranslatableValues/TranslationContext"; | ||
import { PbEditorElement } from "~/types"; | ||
import { ElementInputType } from "@webiny/app-page-builder-elements"; | ||
|
||
export interface CreateTranslatableItemParams { | ||
value: any; | ||
element: PbEditorElement; | ||
input: { | ||
name: string; | ||
type: ElementInputType; | ||
}; | ||
} | ||
|
||
export interface CreateTranslatableItem { | ||
(params: CreateTranslatableItemParams): Omit<TranslatableItem, "collectionId">; | ||
} | ||
|
||
export const createElementRendererInputsDecorator = ( | ||
createTranslatableItem: CreateTranslatableItem | ||
) => { | ||
return ElementRendererInputs.createDecorator(Original => { | ||
return function CollectElementValues(props) { | ||
const translations = useTranslations(); | ||
const [page] = usePage(); | ||
const { element, inputs, values } = props; | ||
|
||
useEffect(() => { | ||
if (!inputs || !translations) { | ||
return; | ||
} | ||
|
||
Object.entries(props.values).forEach(([key, value]) => { | ||
if (!value || !inputs[key].isTranslatable()) { | ||
return; | ||
} | ||
|
||
translations.setTranslationItem({ | ||
collectionId: `page:${page.id}`, | ||
...createTranslatableItem({ | ||
element, | ||
value, | ||
input: { | ||
name: key, | ||
type: inputs[key].getType() | ||
} | ||
}) | ||
}); | ||
}); | ||
}, [element.id, values]); | ||
|
||
return <Original {...props} />; | ||
}; | ||
}); | ||
}; |
28 changes: 28 additions & 0 deletions
28
...app-page-builder/src/translations/ExtractTranslatableValues/ExtractTranslatableValues.tsx
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,28 @@ | ||
import React from "react"; | ||
import { AddTranslatableItemsContext } from "./AddTranslatableItemsContext"; | ||
import { SaveTranslatableValues } from "~/translations/ExtractTranslatableValues/SaveTranslatableValues"; | ||
import { PageEditorConfig } from "~/pageEditor"; | ||
import { | ||
createElementRendererInputsDecorator, | ||
CreateTranslatableItem | ||
} from "~/translations/ExtractTranslatableValues/CollectElementValues"; | ||
|
||
interface ExtractTranslatableValuesProps { | ||
createTranslatableItem: CreateTranslatableItem; | ||
} | ||
|
||
export const ExtractTranslatableValues = ({ | ||
createTranslatableItem | ||
}: ExtractTranslatableValuesProps) => { | ||
const CollectElementValues = createElementRendererInputsDecorator(createTranslatableItem); | ||
|
||
return ( | ||
<> | ||
<AddTranslatableItemsContext /> | ||
<PageEditorConfig> | ||
<CollectElementValues /> | ||
<SaveTranslatableValues /> | ||
</PageEditorConfig> | ||
</> | ||
); | ||
}; |
85 changes: 85 additions & 0 deletions
85
...ges/app-page-builder/src/translations/ExtractTranslatableValues/SaveTranslatableValues.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,85 @@ | ||
import { useEffect } from "react"; | ||
import debounce from "lodash/debounce"; | ||
import { PbEditorElement } from "~/types"; | ||
import { useEventActionHandler } from "~/editor"; | ||
import { PageEditorEventActionCallableState } from "~/pageEditor/types"; | ||
import { useSaveTranslatableCollection } from "~/translations"; | ||
import { ToggleSaveRevisionStateActionEvent } from "~/pageEditor/config/eventActions/saveRevision"; | ||
import { | ||
TranslatableItem, | ||
useTranslations | ||
} from "~/translations/ExtractTranslatableValues/TranslationContext"; | ||
|
||
const extractElementIds = (elements: PbEditorElement[]): string[] => { | ||
return [ | ||
...elements | ||
.map(element => [ | ||
element.id, | ||
...extractElementIds(element.elements as PbEditorElement[]) | ||
]) | ||
.flat() | ||
]; | ||
}; | ||
|
||
export const SaveTranslatableValues = () => { | ||
const eventActionHandler = useEventActionHandler<PageEditorEventActionCallableState>(); | ||
const translations = useTranslations(); | ||
const { saveTranslatableCollection } = useSaveTranslatableCollection(); | ||
|
||
const saveTranslations = debounce(async (orderedElementIds: string[]) => { | ||
if (!translations) { | ||
return; | ||
} | ||
|
||
const items = translations.getTranslationItems(); | ||
if (!items.length) { | ||
return; | ||
} | ||
|
||
const filteredAndSortedItems: TranslatableItem[] = []; | ||
orderedElementIds.forEach(elementId => { | ||
items | ||
.filter(item => item.itemId.startsWith(`element:${elementId}.`)) | ||
.forEach(item => filteredAndSortedItems.push(item)); | ||
}); | ||
|
||
const collection = { | ||
collectionId: items[0].collectionId, | ||
items: filteredAndSortedItems.map(item => ({ | ||
itemId: item.itemId, | ||
value: item.value, | ||
context: item.context | ||
})) | ||
}; | ||
|
||
await saveTranslatableCollection(collection); | ||
}, 1000); | ||
|
||
useEffect(() => { | ||
if (!translations) { | ||
return; | ||
} | ||
|
||
const offSaveRevisionAction = eventActionHandler.on( | ||
ToggleSaveRevisionStateActionEvent, | ||
async (_, context, meta) => { | ||
const tree = await context.eventActionHandler.getRawElementTree(); | ||
const orderedElementIds = extractElementIds([tree]); | ||
|
||
if (meta.saving) { | ||
saveTranslations(orderedElementIds); | ||
} | ||
|
||
return { | ||
actions: [] | ||
}; | ||
} | ||
); | ||
|
||
return () => { | ||
offSaveRevisionAction(); | ||
}; | ||
}, []); | ||
|
||
return null; | ||
}; |
3 changes: 2 additions & 1 deletion
3
...r/src/translations/TranslationContext.tsx → ...TranslatableValues/TranslationContext.tsx
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
63 changes: 0 additions & 63 deletions
63
packages/app-page-builder/src/translations/HeadlessCms.tsx
This file was deleted.
Oops, something went wrong.
Oops, something went wrong.