API Referencev1.0.2
@eigenpal/docx-editor-core/utils/reportIssue
Framework-agnostic helper to open a pre-filled GitHub "new issue" URL for the Help Report issue action. GitHub doesn't allow file attachments via URL params, so the body asks the user to drag-drop their DOCX onto the issue after it opens.
Lifted from packages/react/src/components/reportIssue.ts so the Vue adapter can re-use it without re-implementing.
Functions(2)
fn
packages/core/src/utils/reportIssue.ts:21buildReportIssueUrl
declare function buildReportIssueUrl(env?: ReportIssueEnv): string;fn
packages/core/src/utils/reportIssue.ts:56openReportIssue
declare function openReportIssue(env?: ReportIssueEnv): void;Interfaces(1)
interface
packages/core/src/utils/reportIssue.ts:15ReportIssueEnv
Framework-agnostic helper to open a pre-filled GitHub "new issue" URL for the Help Report issue action. GitHub doesn't allow file attachments via URL params, so the body asks the user to drag-drop their DOCX onto the issue after it opens.
Lifted from packages/react/src/components/reportIssue.ts so the Vue adapter can re-use it without re-implementing.
interface ReportIssueEnv| Member | Type | Summary |
|---|---|---|
| pageUrl? | string | |
| userAgent? | string | |
| viewport? | {
width: number;
height: number;
} |