Function PaperView

React component for rendering a customizable paper view.

The component props.

The CSS class name for the paper view.

Specifies whether the paper view should have an outline.

Specifies whether the paper view should be transparent.

The ref to be forwarded to the underlying HTML element.

The rendered paper view component.

  • NOTE: Exotic components are not callable.

    Parameters

    • props: Pick<IPaperViewProps,
          | "defaultValue"
          | "hidden"
          | "inputMode"
          | "tabIndex"
          | "outlinePaper"
          | "transparentPaper"
          | "className"
          | "style"
          | "title"
          | "placeholder"
          | "sx"
          | "prefix"
          | "onChange"
          | "color"
          | "translate"
          | "id"
          | "onFocus"
          | "onTouchStart"
          | "onContextMenu"
          | "onLoadStart"
          | "children"
          | "classes"
          | "component"
          | "slot"
          | "key"
          | "defaultChecked"
          | "suppressContentEditableWarning"
          | "suppressHydrationWarning"
          | "accessKey"
          | "contentEditable"
          | "contextMenu"
          | "dir"
          | "draggable"
          | "lang"
          | "spellCheck"
          | "radioGroup"
          | "role"
          | "about"
          | "datatype"
          | "inlist"
          | "property"
          | "resource"
          | "typeof"
          | "vocab"
          | "autoCapitalize"
          | "autoCorrect"
          | "autoSave"
          | "itemProp"
          | "itemScope"
          | "itemType"
          | "itemID"
          | "itemRef"
          | "results"
          | "security"
          | "unselectable"
          | "is"
          | "aria-activedescendant"
          | "aria-atomic"
          | "aria-autocomplete"
          | "aria-busy"
          | "aria-checked"
          | "aria-colcount"
          | "aria-colindex"
          | "aria-colspan"
          | "aria-controls"
          | "aria-current"
          | "aria-describedby"
          | "aria-details"
          | "aria-disabled"
          | "aria-dropeffect"
          | "aria-errormessage"
          | "aria-expanded"
          | "aria-flowto"
          | "aria-grabbed"
          | "aria-haspopup"
          | "aria-hidden"
          | "aria-invalid"
          | "aria-keyshortcuts"
          | "aria-label"
          | "aria-labelledby"
          | "aria-level"
          | "aria-live"
          | "aria-modal"
          | "aria-multiline"
          | "aria-multiselectable"
          | "aria-orientation"
          | "aria-owns"
          | "aria-placeholder"
          | "aria-posinset"
          | "aria-pressed"
          | "aria-readonly"
          | "aria-relevant"
          | "aria-required"
          | "aria-roledescription"
          | "aria-rowcount"
          | "aria-rowindex"
          | "aria-rowspan"
          | "aria-selected"
          | "aria-setsize"
          | "aria-sort"
          | "aria-valuemax"
          | "aria-valuemin"
          | "aria-valuenow"
          | "aria-valuetext"
          | "dangerouslySetInnerHTML"
          | "onCopy"
          | "onCopyCapture"
          | "onCut"
          | "onCutCapture"
          | "onPaste"
          | "onPasteCapture"
          | "onCompositionEnd"
          | "onCompositionEndCapture"
          | "onCompositionStart"
          | "onCompositionStartCapture"
          | "onCompositionUpdate"
          | "onCompositionUpdateCapture"
          | "onFocusCapture"
          | "onBlur"
          | "onBlurCapture"
          | "onChangeCapture"
          | "onBeforeInput"
          | "onBeforeInputCapture"
          | "onInput"
          | "onInputCapture"
          | "onReset"
          | "onResetCapture"
          | "onSubmit"
          | "onSubmitCapture"
          | "onInvalid"
          | "onInvalidCapture"
          | "onLoad"
          | "onLoadCapture"
          | "onError"
          | "onErrorCapture"
          | "onKeyDown"
          | "onKeyDownCapture"
          | "onKeyPress"
          | "onKeyPressCapture"
          | "onKeyUp"
          | "onKeyUpCapture"
          | "onAbort"
          | "onAbortCapture"
          | "onCanPlay"
          | "onCanPlayCapture"
          | "onCanPlayThrough"
          | "onCanPlayThroughCapture"
          | "onDurationChange"
          | "onDurationChangeCapture"
          | "onEmptied"
          | "onEmptiedCapture"
          | "onEncrypted"
          | "onEncryptedCapture"
          | "onEnded"
          | "onEndedCapture"
          | "onLoadedData"
          | "onLoadedDataCapture"
          | "onLoadedMetadata"
          | "onLoadedMetadataCapture"
          | "onLoadStartCapture"
          | "onPause"
          | "onPauseCapture"
          | "onPlay"
          | "onPlayCapture"
          | "onPlaying"
          | "onPlayingCapture"
          | "onProgress"
          | "onProgressCapture"
          | "onRateChange"
          | "onRateChangeCapture"
          | "onSeeked"
          | "onSeekedCapture"
          | "onSeeking"
          | "onSeekingCapture"
          | "onStalled"
          | "onStalledCapture"
          | "onSuspend"
          | "onSuspendCapture"
          | "onTimeUpdate"
          | "onTimeUpdateCapture"
          | "onVolumeChange"
          | "onVolumeChangeCapture"
          | "onWaiting"
          | "onWaitingCapture"
          | "onAuxClick"
          | "onAuxClickCapture"
          | "onClick"
          | "onClickCapture"
          | "onContextMenuCapture"
          | "onDoubleClick"
          | "onDoubleClickCapture"
          | "onDrag"
          | "onDragCapture"
          | "onDragEnd"
          | "onDragEndCapture"
          | "onDragEnter"
          | "onDragEnterCapture"
          | "onDragExit"
          | "onDragExitCapture"
          | "onDragLeave"
          | "onDragLeaveCapture"
          | "onDragOver"
          | "onDragOverCapture"
          | "onDragStart"
          | "onDragStartCapture"
          | "onDrop"
          | "onDropCapture"
          | "onMouseDown"
          | "onMouseDownCapture"
          | "onMouseEnter"
          | "onMouseLeave"
          | "onMouseMove"
          | "onMouseMoveCapture"
          | "onMouseOut"
          | "onMouseOutCapture"
          | "onMouseOver"
          | "onMouseOverCapture"
          | "onMouseUp"
          | "onMouseUpCapture"
          | "onSelect"
          | "onSelectCapture"
          | "onTouchCancel"
          | "onTouchCancelCapture"
          | "onTouchEnd"
          | "onTouchEndCapture"
          | "onTouchMove"
          | "onTouchMoveCapture"
          | "onTouchStartCapture"
          | "onPointerDown"
          | "onPointerDownCapture"
          | "onPointerMove"
          | "onPointerMoveCapture"
          | "onPointerUp"
          | "onPointerUpCapture"
          | "onPointerCancel"
          | "onPointerCancelCapture"
          | "onPointerEnter"
          | "onPointerEnterCapture"
          | "onPointerLeave"
          | "onPointerLeaveCapture"
          | "onPointerOver"
          | "onPointerOverCapture"
          | "onPointerOut"
          | "onPointerOutCapture"
          | "onGotPointerCapture"
          | "onGotPointerCaptureCapture"
          | "onLostPointerCapture"
          | "onLostPointerCaptureCapture"
          | "onScroll"
          | "onScrollCapture"
          | "onWheel"
          | "onWheelCapture"
          | "onAnimationStart"
          | "onAnimationStartCapture"
          | "onAnimationEnd"
          | "onAnimationEndCapture"
          | "onAnimationIteration"
          | "onAnimationIterationCapture"
          | "onTransitionEnd"
          | "onTransitionEndCapture"
          | "variant"
          | "elevation"
          | "square"> & RefAttributes<HTMLDivElement>

    Returns null | ReactElement<any, string | JSXElementConstructor<any>>

Properties

$$typeof: symbol
defaultProps?: Partial<Pick<IPaperViewProps,
    | "defaultValue"
    | "hidden"
    | "inputMode"
    | "tabIndex"
    | "outlinePaper"
    | "transparentPaper"
    | "className"
    | "style"
    | "title"
    | "placeholder"
    | "sx"
    | "prefix"
    | "onChange"
    | "color"
    | "translate"
    | "id"
    | "onFocus"
    | "onTouchStart"
    | "onContextMenu"
    | "onLoadStart"
    | "children"
    | "classes"
    | "component"
    | "slot"
    | "key"
    | "defaultChecked"
    | "suppressContentEditableWarning"
    | "suppressHydrationWarning"
    | "accessKey"
    | "contentEditable"
    | "contextMenu"
    | "dir"
    | "draggable"
    | "lang"
    | "spellCheck"
    | "radioGroup"
    | "role"
    | "about"
    | "datatype"
    | "inlist"
    | "property"
    | "resource"
    | "typeof"
    | "vocab"
    | "autoCapitalize"
    | "autoCorrect"
    | "autoSave"
    | "itemProp"
    | "itemScope"
    | "itemType"
    | "itemID"
    | "itemRef"
    | "results"
    | "security"
    | "unselectable"
    | "is"
    | "aria-activedescendant"
    | "aria-atomic"
    | "aria-autocomplete"
    | "aria-busy"
    | "aria-checked"
    | "aria-colcount"
    | "aria-colindex"
    | "aria-colspan"
    | "aria-controls"
    | "aria-current"
    | "aria-describedby"
    | "aria-details"
    | "aria-disabled"
    | "aria-dropeffect"
    | "aria-errormessage"
    | "aria-expanded"
    | "aria-flowto"
    | "aria-grabbed"
    | "aria-haspopup"
    | "aria-hidden"
    | "aria-invalid"
    | "aria-keyshortcuts"
    | "aria-label"
    | "aria-labelledby"
    | "aria-level"
    | "aria-live"
    | "aria-modal"
    | "aria-multiline"
    | "aria-multiselectable"
    | "aria-orientation"
    | "aria-owns"
    | "aria-placeholder"
    | "aria-posinset"
    | "aria-pressed"
    | "aria-readonly"
    | "aria-relevant"
    | "aria-required"
    | "aria-roledescription"
    | "aria-rowcount"
    | "aria-rowindex"
    | "aria-rowspan"
    | "aria-selected"
    | "aria-setsize"
    | "aria-sort"
    | "aria-valuemax"
    | "aria-valuemin"
    | "aria-valuenow"
    | "aria-valuetext"
    | "dangerouslySetInnerHTML"
    | "onCopy"
    | "onCopyCapture"
    | "onCut"
    | "onCutCapture"
    | "onPaste"
    | "onPasteCapture"
    | "onCompositionEnd"
    | "onCompositionEndCapture"
    | "onCompositionStart"
    | "onCompositionStartCapture"
    | "onCompositionUpdate"
    | "onCompositionUpdateCapture"
    | "onFocusCapture"
    | "onBlur"
    | "onBlurCapture"
    | "onChangeCapture"
    | "onBeforeInput"
    | "onBeforeInputCapture"
    | "onInput"
    | "onInputCapture"
    | "onReset"
    | "onResetCapture"
    | "onSubmit"
    | "onSubmitCapture"
    | "onInvalid"
    | "onInvalidCapture"
    | "onLoad"
    | "onLoadCapture"
    | "onError"
    | "onErrorCapture"
    | "onKeyDown"
    | "onKeyDownCapture"
    | "onKeyPress"
    | "onKeyPressCapture"
    | "onKeyUp"
    | "onKeyUpCapture"
    | "onAbort"
    | "onAbortCapture"
    | "onCanPlay"
    | "onCanPlayCapture"
    | "onCanPlayThrough"
    | "onCanPlayThroughCapture"
    | "onDurationChange"
    | "onDurationChangeCapture"
    | "onEmptied"
    | "onEmptiedCapture"
    | "onEncrypted"
    | "onEncryptedCapture"
    | "onEnded"
    | "onEndedCapture"
    | "onLoadedData"
    | "onLoadedDataCapture"
    | "onLoadedMetadata"
    | "onLoadedMetadataCapture"
    | "onLoadStartCapture"
    | "onPause"
    | "onPauseCapture"
    | "onPlay"
    | "onPlayCapture"
    | "onPlaying"
    | "onPlayingCapture"
    | "onProgress"
    | "onProgressCapture"
    | "onRateChange"
    | "onRateChangeCapture"
    | "onSeeked"
    | "onSeekedCapture"
    | "onSeeking"
    | "onSeekingCapture"
    | "onStalled"
    | "onStalledCapture"
    | "onSuspend"
    | "onSuspendCapture"
    | "onTimeUpdate"
    | "onTimeUpdateCapture"
    | "onVolumeChange"
    | "onVolumeChangeCapture"
    | "onWaiting"
    | "onWaitingCapture"
    | "onAuxClick"
    | "onAuxClickCapture"
    | "onClick"
    | "onClickCapture"
    | "onContextMenuCapture"
    | "onDoubleClick"
    | "onDoubleClickCapture"
    | "onDrag"
    | "onDragCapture"
    | "onDragEnd"
    | "onDragEndCapture"
    | "onDragEnter"
    | "onDragEnterCapture"
    | "onDragExit"
    | "onDragExitCapture"
    | "onDragLeave"
    | "onDragLeaveCapture"
    | "onDragOver"
    | "onDragOverCapture"
    | "onDragStart"
    | "onDragStartCapture"
    | "onDrop"
    | "onDropCapture"
    | "onMouseDown"
    | "onMouseDownCapture"
    | "onMouseEnter"
    | "onMouseLeave"
    | "onMouseMove"
    | "onMouseMoveCapture"
    | "onMouseOut"
    | "onMouseOutCapture"
    | "onMouseOver"
    | "onMouseOverCapture"
    | "onMouseUp"
    | "onMouseUpCapture"
    | "onSelect"
    | "onSelectCapture"
    | "onTouchCancel"
    | "onTouchCancelCapture"
    | "onTouchEnd"
    | "onTouchEndCapture"
    | "onTouchMove"
    | "onTouchMoveCapture"
    | "onTouchStartCapture"
    | "onPointerDown"
    | "onPointerDownCapture"
    | "onPointerMove"
    | "onPointerMoveCapture"
    | "onPointerUp"
    | "onPointerUpCapture"
    | "onPointerCancel"
    | "onPointerCancelCapture"
    | "onPointerEnter"
    | "onPointerEnterCapture"
    | "onPointerLeave"
    | "onPointerLeaveCapture"
    | "onPointerOver"
    | "onPointerOverCapture"
    | "onPointerOut"
    | "onPointerOutCapture"
    | "onGotPointerCapture"
    | "onGotPointerCaptureCapture"
    | "onLostPointerCapture"
    | "onLostPointerCaptureCapture"
    | "onScroll"
    | "onScrollCapture"
    | "onWheel"
    | "onWheelCapture"
    | "onAnimationStart"
    | "onAnimationStartCapture"
    | "onAnimationEnd"
    | "onAnimationEndCapture"
    | "onAnimationIteration"
    | "onAnimationIterationCapture"
    | "onTransitionEnd"
    | "onTransitionEndCapture"
    | "variant"
    | "elevation"
    | "square"> & RefAttributes<HTMLDivElement>>
displayName?: string
propTypes?: WeakValidationMap<Pick<IPaperViewProps,
    | "defaultValue"
    | "hidden"
    | "inputMode"
    | "tabIndex"
    | "outlinePaper"
    | "transparentPaper"
    | "className"
    | "style"
    | "title"
    | "placeholder"
    | "sx"
    | "prefix"
    | "onChange"
    | "color"
    | "translate"
    | "id"
    | "onFocus"
    | "onTouchStart"
    | "onContextMenu"
    | "onLoadStart"
    | "children"
    | "classes"
    | "component"
    | "slot"
    | "key"
    | "defaultChecked"
    | "suppressContentEditableWarning"
    | "suppressHydrationWarning"
    | "accessKey"
    | "contentEditable"
    | "contextMenu"
    | "dir"
    | "draggable"
    | "lang"
    | "spellCheck"
    | "radioGroup"
    | "role"
    | "about"
    | "datatype"
    | "inlist"
    | "property"
    | "resource"
    | "typeof"
    | "vocab"
    | "autoCapitalize"
    | "autoCorrect"
    | "autoSave"
    | "itemProp"
    | "itemScope"
    | "itemType"
    | "itemID"
    | "itemRef"
    | "results"
    | "security"
    | "unselectable"
    | "is"
    | "aria-activedescendant"
    | "aria-atomic"
    | "aria-autocomplete"
    | "aria-busy"
    | "aria-checked"
    | "aria-colcount"
    | "aria-colindex"
    | "aria-colspan"
    | "aria-controls"
    | "aria-current"
    | "aria-describedby"
    | "aria-details"
    | "aria-disabled"
    | "aria-dropeffect"
    | "aria-errormessage"
    | "aria-expanded"
    | "aria-flowto"
    | "aria-grabbed"
    | "aria-haspopup"
    | "aria-hidden"
    | "aria-invalid"
    | "aria-keyshortcuts"
    | "aria-label"
    | "aria-labelledby"
    | "aria-level"
    | "aria-live"
    | "aria-modal"
    | "aria-multiline"
    | "aria-multiselectable"
    | "aria-orientation"
    | "aria-owns"
    | "aria-placeholder"
    | "aria-posinset"
    | "aria-pressed"
    | "aria-readonly"
    | "aria-relevant"
    | "aria-required"
    | "aria-roledescription"
    | "aria-rowcount"
    | "aria-rowindex"
    | "aria-rowspan"
    | "aria-selected"
    | "aria-setsize"
    | "aria-sort"
    | "aria-valuemax"
    | "aria-valuemin"
    | "aria-valuenow"
    | "aria-valuetext"
    | "dangerouslySetInnerHTML"
    | "onCopy"
    | "onCopyCapture"
    | "onCut"
    | "onCutCapture"
    | "onPaste"
    | "onPasteCapture"
    | "onCompositionEnd"
    | "onCompositionEndCapture"
    | "onCompositionStart"
    | "onCompositionStartCapture"
    | "onCompositionUpdate"
    | "onCompositionUpdateCapture"
    | "onFocusCapture"
    | "onBlur"
    | "onBlurCapture"
    | "onChangeCapture"
    | "onBeforeInput"
    | "onBeforeInputCapture"
    | "onInput"
    | "onInputCapture"
    | "onReset"
    | "onResetCapture"
    | "onSubmit"
    | "onSubmitCapture"
    | "onInvalid"
    | "onInvalidCapture"
    | "onLoad"
    | "onLoadCapture"
    | "onError"
    | "onErrorCapture"
    | "onKeyDown"
    | "onKeyDownCapture"
    | "onKeyPress"
    | "onKeyPressCapture"
    | "onKeyUp"
    | "onKeyUpCapture"
    | "onAbort"
    | "onAbortCapture"
    | "onCanPlay"
    | "onCanPlayCapture"
    | "onCanPlayThrough"
    | "onCanPlayThroughCapture"
    | "onDurationChange"
    | "onDurationChangeCapture"
    | "onEmptied"
    | "onEmptiedCapture"
    | "onEncrypted"
    | "onEncryptedCapture"
    | "onEnded"
    | "onEndedCapture"
    | "onLoadedData"
    | "onLoadedDataCapture"
    | "onLoadedMetadata"
    | "onLoadedMetadataCapture"
    | "onLoadStartCapture"
    | "onPause"
    | "onPauseCapture"
    | "onPlay"
    | "onPlayCapture"
    | "onPlaying"
    | "onPlayingCapture"
    | "onProgress"
    | "onProgressCapture"
    | "onRateChange"
    | "onRateChangeCapture"
    | "onSeeked"
    | "onSeekedCapture"
    | "onSeeking"
    | "onSeekingCapture"
    | "onStalled"
    | "onStalledCapture"
    | "onSuspend"
    | "onSuspendCapture"
    | "onTimeUpdate"
    | "onTimeUpdateCapture"
    | "onVolumeChange"
    | "onVolumeChangeCapture"
    | "onWaiting"
    | "onWaitingCapture"
    | "onAuxClick"
    | "onAuxClickCapture"
    | "onClick"
    | "onClickCapture"
    | "onContextMenuCapture"
    | "onDoubleClick"
    | "onDoubleClickCapture"
    | "onDrag"
    | "onDragCapture"
    | "onDragEnd"
    | "onDragEndCapture"
    | "onDragEnter"
    | "onDragEnterCapture"
    | "onDragExit"
    | "onDragExitCapture"
    | "onDragLeave"
    | "onDragLeaveCapture"
    | "onDragOver"
    | "onDragOverCapture"
    | "onDragStart"
    | "onDragStartCapture"
    | "onDrop"
    | "onDropCapture"
    | "onMouseDown"
    | "onMouseDownCapture"
    | "onMouseEnter"
    | "onMouseLeave"
    | "onMouseMove"
    | "onMouseMoveCapture"
    | "onMouseOut"
    | "onMouseOutCapture"
    | "onMouseOver"
    | "onMouseOverCapture"
    | "onMouseUp"
    | "onMouseUpCapture"
    | "onSelect"
    | "onSelectCapture"
    | "onTouchCancel"
    | "onTouchCancelCapture"
    | "onTouchEnd"
    | "onTouchEndCapture"
    | "onTouchMove"
    | "onTouchMoveCapture"
    | "onTouchStartCapture"
    | "onPointerDown"
    | "onPointerDownCapture"
    | "onPointerMove"
    | "onPointerMoveCapture"
    | "onPointerUp"
    | "onPointerUpCapture"
    | "onPointerCancel"
    | "onPointerCancelCapture"
    | "onPointerEnter"
    | "onPointerEnterCapture"
    | "onPointerLeave"
    | "onPointerLeaveCapture"
    | "onPointerOver"
    | "onPointerOverCapture"
    | "onPointerOut"
    | "onPointerOutCapture"
    | "onGotPointerCapture"
    | "onGotPointerCaptureCapture"
    | "onLostPointerCapture"
    | "onLostPointerCaptureCapture"
    | "onScroll"
    | "onScrollCapture"
    | "onWheel"
    | "onWheelCapture"
    | "onAnimationStart"
    | "onAnimationStartCapture"
    | "onAnimationEnd"
    | "onAnimationEndCapture"
    | "onAnimationIteration"
    | "onAnimationIterationCapture"
    | "onTransitionEnd"
    | "onTransitionEndCapture"
    | "variant"
    | "elevation"
    | "square"> & RefAttributes<HTMLDivElement>>