Documentation Issue: cancel button type and missing ToolbarButton interface docs
Category: Accuracy + Completeness
Severity: Error + Warning
Found by: docs-updater review mode (2026-02-25)
SDK: MRZ Scanner JavaScript Edition
Finding IDs: A3, C6
Problem
- The
cancel property in MRZResultViewToolbarButtonsConfig is documented as ToolbarButtonConfig, but in the SDK source it is ToolbarButton (the full interface with id, onClick, and isDisabled properties).
- The
ToolbarButton interface is not documented anywhere in the API reference — only ToolbarButtonConfig is documented.
Location
- Docs file:
api/mrz-scanner.md — MRZResultViewToolbarButtonsConfig section
- Source:
dist/mrz-scanner.d.ts
Expected (from source)
interface MRZResultViewToolbarButtonsConfig {
cancel?: ToolbarButton; // Full ToolbarButton, not ToolbarButtonConfig
rescan?: ToolbarButtonConfig;
done?: ToolbarButtonConfig;
}
interface ToolbarButton {
id: string;
icon: string;
label: string;
onClick?: () => void | Promise<void>;
className?: string;
isDisabled?: boolean;
isHidden?: boolean;
}
Actual (in docs)
cancel typed as ToolbarButtonConfig, and ToolbarButton interface is not documented.
Recommended Fix
- Change the type of
cancel from ToolbarButtonConfig to ToolbarButton.
- Add a new documentation section for the
ToolbarButton interface.
Documentation Issue: cancel button type and missing ToolbarButton interface docs
Category: Accuracy + Completeness
Severity: Error + Warning
Found by: docs-updater review mode (2026-02-25)
SDK: MRZ Scanner JavaScript Edition
Finding IDs: A3, C6
Problem
cancelproperty inMRZResultViewToolbarButtonsConfigis documented asToolbarButtonConfig, but in the SDK source it isToolbarButton(the full interface withid,onClick, andisDisabledproperties).ToolbarButtoninterface is not documented anywhere in the API reference — onlyToolbarButtonConfigis documented.Location
api/mrz-scanner.md— MRZResultViewToolbarButtonsConfig sectiondist/mrz-scanner.d.tsExpected (from source)
Actual (in docs)
canceltyped asToolbarButtonConfig, andToolbarButtoninterface is not documented.Recommended Fix
cancelfromToolbarButtonConfigtoToolbarButton.ToolbarButtoninterface.