- a (?) button next to the Code label on the step and snippet create/edit pages opens a reference of the script runtime: globals, every context member with examples, and pitfalls such as awaiting getStepOutput and assert - the reference lives in components/modals/code-help.md and is rendered as markdown - Modal takes size="lg" for document-like content; the dialog is capped to the viewport and its body scrolls, focusable when lg so the keyboard can scroll it - docs/scenario.md notes that getStepOutput is async and points to the in-app reference to keep in sync
55 lines
1.4 KiB
TypeScript
55 lines
1.4 KiB
TypeScript
import { useState } from 'react';
|
|
import { useTranslation } from 'react-i18next';
|
|
import { CircleHelp, X } from 'lucide-react';
|
|
import { Modal, Button, MarkdownContent } from '../../ui';
|
|
import content from './code-help.md?raw';
|
|
import styles from './CodeHelpModal.module.css';
|
|
|
|
export interface CodeHelpModalProps {
|
|
open: boolean;
|
|
onClose: () => void;
|
|
}
|
|
|
|
/** Reference for the script runtime (`context`, `expect`, ...) available to step and snippet code. */
|
|
export function CodeHelpModal({ open, onClose }: CodeHelpModalProps) {
|
|
const { t } = useTranslation();
|
|
|
|
return (
|
|
<Modal
|
|
open={open}
|
|
size="lg"
|
|
title={t('code_help.title')}
|
|
onClose={onClose}
|
|
footer={
|
|
<Button variant="secondary" onClick={onClose}>
|
|
<X size={14} />
|
|
{t('code_help.close')}
|
|
</Button>
|
|
}
|
|
>
|
|
<MarkdownContent content={content} />
|
|
</Modal>
|
|
);
|
|
}
|
|
|
|
/** A (?) button that opens the {@link CodeHelpModal}; place it next to a code field label. */
|
|
export function CodeHelpButton() {
|
|
const { t } = useTranslation();
|
|
const [open, setOpen] = useState(false);
|
|
|
|
return (
|
|
<>
|
|
<button
|
|
type="button"
|
|
className={styles.helpButton}
|
|
onClick={() => setOpen(true)}
|
|
aria-label={t('code_help.open')}
|
|
title={t('code_help.open')}
|
|
>
|
|
<CircleHelp size={16} />
|
|
</button>
|
|
<CodeHelpModal open={open} onClose={() => setOpen(false)} />
|
|
</>
|
|
);
|
|
}
|