ScreenCaptureUpload
When to use
Section titled “When to use”Incident attachments, audit evidence, or support tickets needing screen captures.
When NOT to use
Section titled “When NOT to use”General file upload — use FileUpload.
Podium primitives composed
Section titled “Podium primitives composed”- Podium
Button - Podium
Text
Auto-generated from
src/components/ScreenCaptureUpload/ScreenCaptureUpload.types.ts. Do not edit by hand. Runpnpm docs:propsafter changing source JSDoc.
ScreenCaptureUploadProps
Section titled “ScreenCaptureUploadProps”| Prop | Type | Required | Description |
|---|---|---|---|
className |
string |
No | — |
description |
ReactNode |
No | Defaults to helper text listing accepted file types. |
disabled |
boolean |
No | — |
id |
string |
No | — |
label |
ReactNode |
No | Defaults to “Screen Capture”. |
maxFileSizeBytes |
number |
No | Maximum file size in bytes. Defaults to 10 MB. |
onFileChange |
(file: File | null) => void |
Yes | Fires whenever the selected file changes. Returns null when the file is removed or cleared. |
Examples
Section titled “Examples”Attach screenshot
Section titled “Attach screenshot”import { ScreenCaptureUpload } from '@nike/whisker-component-library';
<ScreenCaptureUpload onCapture={(file) => attachToIncident(file)} />;