IssueAction

A modal dialog triggered from the more actions (...) menu in Jira.

This is an example of an IssueAction button:

Example of an Issue action button

This is an example of the triggered modal dialog:

Example of an Issue action with the above sample code

Usage notes

IssueAction is the top-level component required for the jira:issueAction module.

Import statement

1
2
import ForgeUI, { IssueAction } from '@forge/ui';

Props

Name	Type	Required	Description
`children`	`Array<ForgeComponent>`	Yes	A container for displaying multiple components. Can only contain ModalDialog.

Example

1
2
import ForgeUI, {render, Text, IssueAction, ModalDialog, useState} from '@forge/ui';

const App = () => {
    const [isOpen, setOpen] = useState(true)

    if (!isOpen) {
        return null;
    }

    return (
        <ModalDialog header="Hello" onClose={() => setOpen(false)}>
            <Text>Hello world</Text>
        </ModalDialog>
    );
};

export const run = render(
    <IssueAction>
        <App/>
    </IssueAction>
);