針對 SPA 實作 React元件

上次更新: 2023-12-04

單頁應用程式 (SPA) 可為網站使用者提供引人入勝的體驗。開發人員希望能使用SPA架構建立網站,而作者則想在Adobe Experience Manager (AEM)中為使用SPA架構建立的網站順暢地編輯內容。

SPA編寫功能提供全方位的解決方案,可支援AEM中的SPA。 本文將以範例說明如何改寫簡單的現有React元件來與AEM SPA編輯器搭配使用。

注意

對於需要以SPA框架為基礎的使用者端轉譯(例如React或Angular)專案,建議使用SPA編輯器解決方案。

簡介

由於AEM需要簡易且輕量的合約,且在SPA與SPA編輯器之間建立,採用現有的JavaScript應用程式並將其調整為可與AEM中的SPA搭配使用,是一件簡單明瞭的事。

本文說明We.Retail Journal範例SPA上的天氣元件範例。

您應熟悉 適用於AEM的SPA應用程式結構 閱讀本文之前。

注意

本檔案使用 We.Retail日誌應用程式 僅供示範之用。 請勿用於任何專案工作。

任何 AEM 專案都應使用 AEM 專案原型,它支援使用 React 或 Angular 的 SPA 專案並使用 SPA SDK。

天氣元件

氣象元件可在We.Retail Journal應用程式左上角找到。 它會顯示定義位置的目前氣象,以動態方式提取天氣資料。

使用天氣Widget

screen_shot_2018-06-08at143224

在SPA編輯器中編寫SPA的內容時,天氣元件會像任何其他AEM元件一樣顯示、使用工具列完成並可編輯。

screen_shot_2018-06-08at143304

城市可在對話方塊中更新,就像任何其他AEM元件一樣。

screen_shot_2018-06-08at143446

此變更會持續存在,而元件會自動以新的天氣資料更新。

screen_shot_2018-06-08at143524

天氣元件實施

天氣元件以公開可用的React元件為基礎,稱為 React Open Weather. 它已調整為可在We.Retail Journal範例SPA應用程式中作為元件使用。

以下是React Open Weather元件用途的NPM檔案片段。

screen_shot_2018-06-08at144723 screen_shot_2018-06-08at144215

檢閱自訂天氣元件的程式碼( Weather.js)在We.Retail日誌應用程式中:

  • 第16行:React Open Weather Widget會視需要載入。

  • 第46行:此 MapTo 函式將此React元件與對應的AEM元件建立關聯,以便在SPA編輯器中編輯它。

  • 第22-29行:此 EditConfig 定義,檢查是否已填入城市,如果空白,則定義值。

  • 第31-44行:天氣元件會延伸 Component 類別並針對React Open Weather元件提供NPM使用檔案中定義的必要資料,然後轉譯該元件。

/*~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 ~ Copyright 2018 Adobe Systems Incorporated
 ~
 ~ Licensed under the Apache 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.apache.org/licenses/LICENSE-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 React, {Component} from 'react';
import ReactWeather from 'react-open-weather';
import {MapTo} from '@adobe/aem-react-editable-components';

require('./Weather.css');

const WeatherEditConfig = {

    emptyLabel: 'Weather',

    isEmpty: function() {
        return !this.props || !this.props.cq_model || !this.props.cq_model.city || this.props.cq_model.city.trim().length < 1;
    }
};

class Weather extends Component {

    render() {
        let apiKey = "12345678901234567890";
        let city;

        if (this.props.cq_model) {
            city = this.props.cq_model.city;
            return <ReactWeather key={'react-weather' + Date.now()} forecast="today" apikey={apiKey} type="city" city={city} />
        }

        return null;
    }
}

MapTo('we-retail-journal/global/components/weather')(Weather, WeatherEditConfig);

雖然後端元件必須已存在,但前端開發人員可以在We.Retail Journal SPA中使用React Open Weather元件,且幾乎沒有程式碼。

下一步

如需有關為AEM開發SPA的詳細資訊,請參閱文章 為AEM開發SPA.

本頁內容