Add custom configuration to a macro

Configuration allows you to customize what the macro displays by adjusting settings in a form. To access these settings, you need to go into the edit mode for the macro, as demonstrated below. This gives you the ability to customize the macro's output according to your preferences.

Custom configuration can be used for more complex use cases, such as when you need to use specialised input components, or want more control over the rendering experience of configuring a macro. It also allows saving arbitrary configuration at runtime, instead of requiring you to predefine all possible configuration fields.

Custom configuration supports both UI Kit and custom UI.

You can add simple configuration to a macro using UI Kit components, as described here.

You can use rich text bodied macros, as described here.

You can also see a sample implementation of a macro with custom configuration in the rich-text-custom-config-macro sample app.

Before you begin

Make sure you have the following:

• A Forge app with a Confluence macro created using UI Kit or Custom UI.
• The latest version of Forge CLI. To update your CLI version, run npm install -g @forge/cli@latest on the command line.

Step 1: Configure the manifest

First, set the config property to the config object in the manifest.yml file.

For existing apps

If you already have a macro in your manifest.yml, add the config section to your existing macro definition:

Before:

1
2
modules:
  macro:
    - key: my-macro
      resource: main
      render: native
      resolver:
        function: resolver
      title: My Macro

After:

1
2
modules:
  macro:
    - key: my-macro
      resource: main
      render: native
      resolver:
        function: resolver
      title: My Macro
      config:
        resource: macro-config
        render: native # Only for UI Kit
        viewportSize: max # Optional
        title: Config # Optional

For new apps

If you're creating a new macro, use this complete structure:

1
2
modules:
  macro:
    - key: my-macro
      resource: main
      render: native
      resolver:
        function: resolver
      title: My Macro
      config:
        resource: macro-config
        render: native # Only for UI Kit
        viewportSize: max # Optional
        title: Config # Optional
  function:
    - key: resolver
      handler: index.handler
resources:
  - key: main
    path: src/frontend/index.jsx

Step 2: Declare resources for the custom editor

Next, define the resources property in the manifest.yml file according to the Resources page. The key prop should match the resource name in the config object, and the path prop should point to the config resource file that we will create in step 3.

1
2
resources:
  - key: main
    path: src/frontend/index.jsx
  - key: macro-config
    path: src/frontend/config.jsx

Step 3: Create the configuration resource

Define the config resource at the path specified in step 2.

1
2
import React, { useState, useEffect } from 'react';
import ForgeReconciler, { Button, Label, SectionMessage, Stack, Textfield, useConfig } from '@forge/react';
import { view } from "@forge/bridge";

// Submit functionality - handles configuration persistence
const useSubmit = () => {
  const [error, setError] = useState();
  const [message, setMessage] = useState('');

  const submit = async (fields) => {
    const payload = { config: fields };

    try {
      await view.submit(payload);
      setError(false);
      setMessage(`Submitted successfully.`);
    } catch (error) {
      setError(true);
      setMessage(`${error.code}: ${error.message}`);
    }
  };

  return {
    error,
    message,
    submit
  };
};

// Main configuration component
const Config = () => {
  const [value, setValue] = useState('');
  const config = useConfig();

  const {
    error,
    message,
    submit
  } = useSubmit();

  useEffect(() => {
    setValue(config?.myField);
  }, [config?.myField]);

  return (
    <Stack space="space.200">
      <Label labelFor="myField">Config field:</Label>
      <Textfield id="myField" value={value} onChange={(e) => setValue(e.target.value)} />
      <Button appearance="subtle" onClick={() => view.close()}>
        Close
      </Button>
      <Button appearance="primary" onClick={() => submit({ myField: value })}>
        Submit
      </Button>
      {typeof error !== 'undefined' && (
        <SectionMessage appearance={error ? 'error' : 'success'}>{message}</SectionMessage>
      )}
    </Stack>
  );
};

// Render the configuration modal
ForgeReconciler.render(
  <React.StrictMode>
    <Config />
  </React.StrictMode>
);

Step 4: Understanding configuration persistence

The configuration persistence functionality is already included in the complete config.jsx file from Step 3.

The useSubmit function handles configuration persistence using the view.submit() method. Here's how it works:

Configuration submission process:

1. User input: User enters data in the configuration form
2. Submit button: User clicks the "Submit" button
3. Payload creation: The submit function creates a payload with { config: fields }
4. Persistence: view.submit(payload) saves the configuration
5. Feedback: Success or error message is displayed to the user

Key functions:

• view.submit(payload): Saves configuration and closes the modal
• view.close(): Closes the modal without saving (cancels macro insert)

Error handling:

The function includes comprehensive error handling that:

• Shows success messages when configuration is saved
• Displays error codes and messages when submission fails
• Provides user feedback through the SectionMessage component

Validation: Test your configuration

Before proceeding to Step 5, validate that your configuration is working correctly:

1. Deploy your app: Run forge deploy to deploy your changes
2. Install/upgrade: Run forge install --upgrade if you've changed permissions
3. Test in Confluence:
   • Edit a Confluence page
   • Insert your macro using / command
   • Click the configuration button to open the config modal
   • Enter test data and click "Submit"
   • Verify the macro displays your configuration data

Step 5: Show changes on app

Finally, we can show the changes submitted from the config on our app.

1
2
import React from 'react';
import ForgeReconciler, { useConfig, CodeBlock, Text } from '@forge/react';

const App = () => {
  const config = useConfig();

  return (
    <>
      <Text>Macro configuration data:</Text>
      <CodeBlock language="json" text={JSON.stringify(config, null, 2)} />
    </>
  );
};

ForgeReconciler.render(
  <React.StrictMode>
    <App />
  </React.StrictMode>
);

Troubleshooting