擴充功能模型
{align="center"}
AEM UI擴充功能模式提供一種將自訂UI附加至AEM UI擴充功能的方法。
模組是以React Spectrum為基礎的React應用程式,可以建立擴充功能所需的任何自訂UI,包括但不限於:
強制回應路由
強制回應體驗是由web-src
資料夾下定義的App Builder React應用程式擴充功能所定義。 和任何React應用程式一樣,完整體驗是使用🔗轉譯React元件的React路由來編排。
產生初始模組檢視至少需要一個路由。 此初始路由會在延伸註冊的onClick(..)
函式中叫用,如下所示。
./src/aem-ui-extension/web-src/src/components/App.js
import MyModal from './MyModal';
import MyModalResults from './MyModalResults';
...
function App(props) {
return (
<Router>
<ErrorBoundary onError={onError} FallbackComponent={fallbackComponent}>
<Routes>
...
{/*
Define the entry route to the modal.
For modals opened from Action Bar extensions.
Depending on the extension point, different parameters are passed to the modal.
This example illustrates a modal for the AEM Content Fragment Console (list view), where typically a :selection parameter is used to pass in the list of selected Content Fragments.
Where as Header Menu extensions do not use a selection parameter.
*/}
<Route
exact path="aem-ui-extension/:selection/my-modal"
element={<MyModal />}
/>
{/* Define any other routes the modal may need */}
<Route
exact path="aem-ui-extension/my-modal"
element={<MyOtherModalView />}
/>
</Routes>
</ErrorBoundary>
</Router>
)
...
}
擴充功能註冊
若要開啟強制回應視窗,會從擴充功能的onClick(..)
函式呼叫guestConnection.host.modal.showUrl(..)
。 showUrl(..)
傳遞的是具有索引鍵/值的JavaScript物件:
title
提供顯示給使用者的強制回應視窗標題名稱url
是叫用負責模組初始檢視的React路由的URL。
傳遞至guestConnection.host.modal.showUrl(..)
的url
必須解析成在擴充功能中路由,否則強制回應不會顯示任何內容。
./src/aem-ui-extension/web-src/src/components/ExtensionRegistration.js
function ExtensionRegistration() {
...
onClick() {
// Create a URL that maps to the React route to be rendered in the modal
const modalURL = "/index.html#/aem-ui-extension/my-modal";
// Open the modal and display the React route created above
guestConnection.host.modal.showUrl({
title: "My modal title",
url: modalURL
})
}
...
}...
模組元件
擴充功能的每個路由(不是index
路由🔗的)都對應到可在擴充功能模式中轉譯的React元件。
強制回應可由任意數量的React路徑組成,從簡單的單路徑強制回應到複雜的多路徑強制回應。
以下說明一個簡單的單路由模型,但此模型檢視可能包含叫用其他路由或行為的React連結。
./src/aem-ui-extension/web-src/src/components/MyModal.js
import React, { useState, useEffect } from 'react'
import { attach } from "@adobe/uix-guest"
import {
Flex,
Provider,
Content,
defaultTheme,
Text,
ButtonGroup,
Button
} from '@adobe/react-spectrum'
import Spinner from "./Spinner"
import { useParams } from "react-router-dom"
import { extensionId } from "./Constants"
export default function MyModal() {
// Initial modal views for Action Bar extensions typically pass in the list of selected Content Fragment Paths from ExtensionRegistration.js
// Get the paths from useParams() and split on delimiter used
let { selection } = useParams();
let contentFragmentPaths = selection?.split('|') || [];
// Asynchronously attach the extension to AEM.
// Wait or the guestConnection to be set before doing anything in the modal.
const [guestConnection, setGuestConnection] = useState()
useEffect(() => {
(async () => {
const guestConnection = await attach({ id: extensionId })
setGuestConnection(guestConnection);
})()
}, [])
if (!guestConnection) {
// If the guestConnection is not initialized, display a loading spinner
return <Spinner />
} else {
// Else the modal is ready to render!
return (
<Provider theme={defaultTheme} colorScheme='light'>
{/*
Use the React Spectrum components to render the modal UI.
Using React Spectrum ensures a consistent, accessible, future-proof look-and-feel and speeds up development.
*/}
<Content width="100%">
<Flex width="100%">
<Text>
This is the contents in the modal!
Anything can be created in this return statement!
The selected Content Fragments are: { contentFragmentPaths.join(', ') }
</Text>
{/*
Modals must provide their own Close button, by calling: guestConnection.host.modal.close()
*/}
<ButtonGroup align="end">
<Button variant="primary" onPress={() => guestConnection.host.modal.close()}>Close</Button>
</ButtonGroup>
</Flex>
</Content>
</Provider>
)
}
}
關閉強制回應視窗
{align="center"}
模組必須提供自己的緊密控制。 這是透過叫用guestConnection.host.modal.close()
完成的。
<ButtonGroup align="end">
<Button variant="primary" onPress={() => guestConnection.host.modal.close()}>Close</Button>
</ButtonGroup>
recommendation-more-help
4859a77c-7971-4ac9-8f5c-4260823c6f69