BarcodeScanner API

Scan barcodes from a Lightning web component.

The Syntax sections in the following topics use TypeScript formatting. We use this formatting to make the API syntax easier to understand. For example, functions can be described by the function name, parameter name and type, and a return type like this.

1createRecord(recordInput: Record): Promise<Record>

Optional parameters are appended with ? like objectInfo?: ObjectInfo. For more information, see the TypeScript Handbook.

TypeScript support is in developer preview. We’re working on adding type definitions for components and modules in the lightning namespace.

Note

For more information about how BarcodeScanner works, see Scan Barcodes on a Mobile Device.

Release Preview

This release is in preview. Features described here don't become generally available until the latest general availability date that Salesforce announces for this release. Before then, and where features are noted as beta, pilot, or developer preview, we can't guarantee general availability within any particular time frame or at all. Make your purchase decisions only on the basis of generally available products and features.