Lägga till widgetar i RTF-redigeraren

Lär dig hur du lägger till widgetar i RTF-redigeraren i AEM Content Fragment Editor.

Om du vill lägga till det dynamiska innehållet i RTF-redigeraren kan du använda widgetfunktionen. Widgetarna hjälper dig att integrera det enkla eller komplexa användargränssnittet i RTE och användargränssnittet kan skapas med valfritt JS-ramverk. De kan betraktas som dialogrutor som öppnas genom att trycka på {-specialtangenten i textredigeraren.

I vanliga fall används widgetarna för att infoga det dynamiska innehållet som har ett externt systemberoende eller som kan ändras baserat på det aktuella sammanhanget.

widgetarna läggs till i RTE i redigeraren för innehållsfragment med tilläggspunkten rte. En eller flera widgetar läggs till med rte-tilläggets getWidgets()-metod. De aktiveras genom att du trycker på specialtangenten { för att öppna snabbmenyalternativet och sedan väljer önskad widget för att läsa in det anpassade dialogrutans användargränssnitt.

I det här exemplet visas hur du lägger till en widget med namnet Rabattkod för att hitta, välja och lägga till den WKND-äventyrsspecifika rabattkoden i ett RTE-innehåll. Dessa rabattkoder kan hanteras i externa system som Order Management System (OMS), Product Information Management (PIM), hemmabruk eller en Adobe AppBuilder-åtgärd.

I det här exemplet används ramverket Adobe React Spectrum för att utveckla widgetens eller dialogrutans gränssnitt och hårdkodade WKND-äventyernamn, rabattkodsdata för att göra det enkelt.

Tilläggspunkt

Det här exemplet utökas till tilläggspunkten rte för att lägga till en widget i textredigeraren i innehållets fragmentredigerare.

Exempel på tillägg

I följande exempel skapas widgeten Rabattlista. Genom att trycka på specialtangenten { i textredigeraren öppnas snabbmenyn och sedan öppnas användargränssnittet genom att välja alternativet Rabattlista på snabbmenyn.

WKND-innehållsförfattarna kan hitta, välja och lägga till aktuell Adventure-specifik rabattkod, om sådan finns.

Tillägg - registrering

ExtensionRegistration.js, mappad till index.html-vägen, är startpunkten för AEM och definierar:

  • Widgetdefinitionen i funktionen getWidgets() med attributen id, label and url.
  • Attributvärdet url, en relativ URL-sökväg (/index.html#/discountCodes) för att läsa in dialogrutans användargränssnitt.

src/aem-cf-editor-1/web-src/src/components/ExtensionRegistration.js

import React from "react";
import { Text } from "@adobe/react-spectrum";
import { register } from "@adobe/uix-guest";
import { extensionId } from "./Constants";

// This function is called when the extension is registered with the host and runs in an iframe in the Content Fragment Editor browser window.
function ExtensionRegistration() {
  const init = async () => {
    const guestConnection = await register({
      id: extensionId,
      methods: {
        rte: {
          // RTE Widgets
          getWidgets: () => [
            {
              id: "discountcode-list-widget", // Provide a unique ID for the widget
              label: "Discount Code List", // Provide a label for the widget
              url: "/index.html#/discountCodes", // Provide the "relative" URL to the widget content. It will be resolved as `/index.html#/discountCodes`
            },
          ],
        }, // Add a comma here
      },
    });
  };

  init().catch(console.error);

  return <Text>IFrame for integration with Host (AEM)...</Text>;
}

export default ExtensionRegistration;

Lägg till discountCodes-väg i App.js

Lägg till discountCodes-vägen i huvudkomponenten App.js för att återge gränssnittet för den relativa URL-sökvägen ovan.

src/aem-cf-editor-1/web-src/src/components/App.js

...

<Routes>
  <Route index element={<ExtensionRegistration />} />
  <Route
    exact path="index.html"
    element={<ExtensionRegistration />}
  />

  {/* Content Fragment RTE routes that support the Discount Codes Widget functionality*/}
  <Route path="/discountCodes" element={<DiscountCodes />} />
</Routes>
...

Skapa DiscountCodes-reaktionskomponent create-widget-react-component

Widgeten eller dialoggränssnittet skapas med ramverket Adobe React Spectrum. Komponentkoden för DiscountCodes är som nedan, här är viktiga högdagrar:

  • Gränssnittet återges med React Spectrum-komponenter, som ComboBox, ButtonGroup, Button
  • adventureDiscountCodes-matrisen har hårdkodad mappning av äventyrsnamn och rabattkod. I verkligheten kan dessa data hämtas från Adobe AppBuilder-åtgärd eller externa system som PIM, OMS eller hemmabruk eller molnproviderbaserad API-gateway.
  • guestConnection initieras med useEffect React-krok och hanteras som komponenttillstånd. Den används för att kommunicera med AEM.
  • Funktionen handleDiscountCodeChange hämtar rabattkoden för det valda äventyrsnamnet och uppdaterar lägesvariabeln.
  • Funktionen addDiscountCode som använder objektet guestConnection tillhandahåller RTE-instruktion att köra. I det här fallet ska insertContent-instruktionen och kodfragmentet HTML av den faktiska rabattkoden infogas i textredigeraren.

src/aem-cf-editor-1/web-src/src/components/DiscountCodes.js

import {
  Button,
  ButtonGroup,
  ComboBox,
  Content,
  Divider,
  Flex, Form,
  Item,
  Provider,
  Text,
  defaultTheme
} from '@adobe/react-spectrum';
import { attach } from '@adobe/uix-guest';
import React, { useEffect, useState } from 'react';
import { extensionId } from './Constants';

const DiscountCodes = () => {

  // The Adventure Discount Code list
  // In this example its hard coded, however you can call an Adobe AppBuilder Action or even make an AJAX call to load it from 3rd party system
  const adventureDiscountCodes = [
    { id: 1, adventureName: 'BALI SURF CAMP', discountCode: 'BALI2023' },
    { id: 2, adventureName: 'BEERVANA IN PORTLAND', discountCode: 'PORTFEST' },
    { id: 3, adventureName: 'NAPA WINE TASTING', discountCode: 'WINEINSPRING' },
    { id: 4, adventureName: 'RIVERSIDE CAMPING', discountCode: 'SUMMERSCAPE' },
    { id: 5, adventureName: 'TAHOE SKIING', discountCode: 'EPICPASS' },
  ];

  // Set up state used by the React component
  const [guestConnection, setGuestConnection] = useState();

  // State hooks to manage the component state
  const [discountCode, setDiscountCode] = useState(null);

  // Asynchronously attach the extension to AEM, we must wait or the guestConnection to be set before doing anything in the modal
  useEffect(() => {
    (async () => {
      const myGuestConnection = await attach({ id: extensionId });

      setGuestConnection(myGuestConnection);
    })();
  }, []);

  // Handle the `discountCodeList` Dropdown change
  const handleDiscountCodeChange = (key) => {

    if (key) {
      //console.log(`DiscountCode Key: ${key}`);
      //console.log(`DiscountCode Value: ${adventureDiscountCodes[key-1].discountCode}`);

      //Get discount code value using selected key/index
      let discountCodeValue = adventureDiscountCodes[key - 1].discountCode;

      //update the `discountCode` state
      setDiscountCode(discountCodeValue);
    }
  };

  // Add the selected Adventure's Discount Code into the RTE
  const addDiscountCode = () => {

    if (discountCode) {
      // Use `guestConnection.host.rte.applyInstructions` method and provide RTE instruction to execute.
      // The instructions are passed as an array of object, that has `type` and `value` keys
      guestConnection.host.rte.applyInstructions([{ type: "insertContent", value: `<strong>Discount Code: ${discountCode}</strong>` }]);
    }

  };

  // Adobe React Spectrum (HTML code) that renders the Discount Code dropdown list, see https://react-spectrum.adobe.com/react-spectrum/index.html
  return (
    <Provider theme={defaultTheme}>
      <Content width="100%">
        <Flex width="100%">

          <Form width="50%">

            <Text>Selected Discount Code: <strong>{discountCode}</strong></Text>

            <p />

            <Divider size="M" />


            <ComboBox
              name="discountCodeList"
              label="Type or Select an Adventure name"
              defaultItems={adventureDiscountCodes}
              onSelectionChange={handleDiscountCodeChange}>
              {item => <Item>{item.adventureName}</Item>}
            </ComboBox>

            <p />

            <ButtonGroup align="right">
              <Button variant="accent" onPress={addDiscountCode} autoFocus>Add</Button>
              <Button variant="secondary" onPress={() => setDiscountCode(null)}>Clear</Button>
            </ButtonGroup>

          </Form>
        </Flex>
      </Content>
    </Provider>
  );
}

export default DiscountCodes;
recommendation-more-help
4859a77c-7971-4ac9-8f5c-4260823c6f69