References / react-native-notion-markdown / native
native
Public API declarations exported by react-native-notion-markdown/native.
./nativeBrowse sourceFunctions
AcceptProofEvent
functionfunction AcceptProofEvent(current: ProofSnapshot, event: ProofEvent): ProofSnapshot Acknowledgements never replace the native composing buffer. Replacement changes epoch.
CreateProofDocument
functionfunction CreateProofDocument(epoch: number): ProofSnapshot Create the default three-block proof document for the requested epoch.
proofPointAt
functionfunction proofPointAt(blocks: unknown, position: number): ProofPoint Native buffer uses newline boundaries and U+2028 for within-block soft breaks.
Interfaces
NotionSelectionOverlayProps
interfaceinterface NotionSelectionOverlayProps Props accepted by the coordinator-owned cross-field selection overlay.
accessibilityActions
propertyproperty accessibilityActionsProvides an array of custom actions available for accessibility.
accessibilityHint
propertyproperty accessibilityHintAn accessibility hint helps users understand what will happen when they perform an action on the accessibility element when that result is not obvious from the accessibility label.
accessibilityIgnoresInvertColors
propertyproperty accessibilityIgnoresInvertColorsaccessibilityLabel
propertyproperty accessibilityLabelOverrides the text that's read by the screen reader when the user interacts with the element. By default, the label is constructed by traversing all the children and accumulating all the Text nodes separated by space.
accessibilityLabelledBy
propertyproperty accessibilityLabelledByIdentifies the element that labels the element it is applied to. When the assistive technology focuses on the component with this props, the text is read aloud. The value should should match the nativeID of the related element.
accessibilityLanguage
propertyproperty accessibilityLanguageBy using the accessibilityLanguage property, the screen reader will understand which language to use while reading the element's label, value and hint. The provided string value must follow the BCP 47 specification (https://www.rfc-editor.org/info/bcp47). https://reactnative.dev/docs/accessibility#accessibilitylanguage-ios
accessibilityLargeContentTitle
propertyproperty accessibilityLargeContentTitleWhen accessibilityShowsLargeContentViewer is set, this string will be used as title for the large content viewer.
https://reactnative.dev/docs/accessibility#accessibilitylargecontenttitle
accessibilityLiveRegion
propertyproperty accessibilityLiveRegionIndicates to accessibility services whether the user should be notified when this view changes. Works for Android API >= 19 only.
property accessibilityRespondsToUserInteractionBlocks the user from interacting with the component through keyboard while still allowing screen reader to interact with it if this View is still accessible.
accessibilityRole
propertyproperty accessibilityRoleAccessibility Role tells a person using either VoiceOver on iOS or TalkBack on Android the type of element that is focused on.
property accessibilityShowsLargeContentViewerA Boolean value that indicates whether or not to show the item in the large content viewer. Available on iOS 13.0+ https://reactnative.dev/docs/accessibility#accessibilityshowslargecontentviewer
accessibilityState
propertyproperty accessibilityStateAccessibility State tells a person using either VoiceOver on iOS or TalkBack on Android the state of the element currently focused on.
accessibilityValue
propertyproperty accessibilityValueRepresents the current value of a component. It can be a textual description of a component's value, or for range-based components, such as sliders and progress bars, it contains range information (minimum, current, and maximum).
accessibilityViewIsModal
propertyproperty accessibilityViewIsModalA Boolean value indicating whether VoiceOver should ignore the elements within views that are siblings of the receiver.
accessible
propertyproperty accessibleWhen true, indicates that the view is an accessibility element. By default, all the touchable elements are accessible.
aria-busy
propertyproperty aria-busyalias for accessibilityState
see https://reactnative.dev/docs/accessibility#accessibilitystate
aria-checked
propertyproperty aria-checkedaria-disabled
propertyproperty aria-disabledaria-expanded
propertyproperty aria-expandedaria-label
propertyproperty aria-labelAlias for accessibilityLabel https://reactnative.dev/docs/view#accessibilitylabel https://github.com/react/react-native/issues/34424
aria-labelledby
propertyproperty aria-labelledbyIdentifies the element that labels the element it is applied to. When the assistive technology focuses on the component with this props, the text is read aloud. The value should should match the nativeID of the related element.
aria-live
propertyproperty aria-liveIndicates to accessibility services whether the user should be notified when this view changes. Works for Android API >= 19 only.
aria-modal
propertyproperty aria-modalaria-selected
propertyproperty aria-selectedaria-valuemax
propertyproperty aria-valuemaxaria-valuemin
propertyproperty aria-valueminaria-valuenow
propertyproperty aria-valuenowaria-valuetext
propertyproperty aria-valuetextchildren
propertyproperty childrencollapsable
propertyproperty collapsableViews that are only used to layout their children or otherwise don't draw anything may be automatically removed from the native hierarchy as an optimization. Set this property to false to disable this optimization and ensure that this View exists in the native view hierarchy.
collapsableChildren
propertyproperty collapsableChildrenSetting to false prevents direct children of the view from being removed
from the native view hierarchy, similar to the effect of setting
collapsable={false} on each child.
dark
propertyproperty darkfocusable
propertyproperty focusableWhether this View should be focusable with a non-touch input device, eg. receive focus with a hardware keyboard.
hasTVPreferredFocus
propertyproperty hasTVPreferredFocus(Apple TV only) May be set to true to force the Apple TV focus engine to move focus to this view.
hitSlop
propertyproperty hitSlopThis defines how far a touch event can start away from the view. Typical interface guidelines recommend touch targets that are at least 30 - 40 points/density-independent pixels. If a Touchable view has a height of 20 the touchable height can be extended to 40 with hitSlop={{top: 10, bottom: 10, left: 0, right: 0}} NOTE The touch area never extends past the parent view bounds and the Z-index of sibling views always takes precedence if a touch hits two overlapping views.
importantForAccessibility
propertyproperty importantForAccessibility[Android] Controlling if a view fires accessibility events and if it is reported to accessibility services.
isTVSelectable
propertyproperty isTVSelectable(Apple TV only) When set to true, this view will be focusable and navigable using the Apple TV remote.
needsOffscreenAlphaCompositing
propertyproperty needsOffscreenAlphaCompositingWhether this view needs to rendered offscreen and composited with an alpha in order to preserve 100% correct colors and blending behavior. The default (false) falls back to drawing the component and its children with an alpha applied to the paint used to draw each element instead of rendering the full component offscreen and compositing it back with an alpha value. This default may be noticeable and undesired in the case where the View you are setting an opacity on has multiple overlapping elements (e.g. multiple overlapping Views, or text and a background).
Rendering offscreen to preserve correct alpha behavior is extremely expensive and hard to debug for non-native developers, which is why it is not turned on by default. If you do need to enable this property for an animation, consider combining it with renderToHardwareTextureAndroid if the view contents are static (i.e. it doesn't need to be redrawn each frame). If that property is enabled, this View will be rendered off-screen once, saved in a hardware texture, and then composited onto the screen with an alpha each frame without having to switch rendering targets on the GPU.
onAccessibilityAction
propertyproperty onAccessibilityActionWhen accessible is true, the system will try to invoke this function when the user performs an accessibility custom action.
onAccessibilityEscape
propertyproperty onAccessibilityEscapeWhen accessible is true, the system will invoke this function when the user performs the escape gesture (scrub with two fingers).
onAccessibilityTap
propertyproperty onAccessibilityTapWhen accessible is true, the system will try to invoke this function when the user performs accessibility tap gesture.
onAutoScroll
propertyproperty onAutoScrollonBlur
propertyproperty onBlurCallback that is called when the view is blurred.
Note: This will only be called if the view is focusable.
onFocus
propertyproperty onFocusCallback that is called when the view is focused.
Note: This will only be called if the view is focusable.
onLayout
propertyproperty onLayoutInvoked on mount and layout changes with
{nativeEvent: { layout: {x, y, width, height}}}.
onMagicTap
propertyproperty onMagicTapWhen accessible is true, the system will invoke this function when the user performs the magic tap gesture.
onMoveShouldSetResponder
propertyproperty onMoveShouldSetResponderCalled for every touch move on the View when it is not the responder: does this view want to "claim" touch responsiveness?
onMoveShouldSetResponderCapture
propertyproperty onMoveShouldSetResponderCaptureonStartShouldSetResponder and onMoveShouldSetResponder are called with a bubbling pattern, where the deepest node is called first. That means that the deepest component will become responder when multiple Views return true for *ShouldSetResponder handlers. This is desirable in most cases, because it makes sure all controls and buttons are usable.
However, sometimes a parent will want to make sure that it becomes responder. This can be handled by using the capture phase. Before the responder system bubbles up from the deepest component, it will do a capture phase, firing on*ShouldSetResponderCapture. So if a parent View wants to prevent the child from becoming responder on a touch start, it should have a onStartShouldSetResponderCapture handler which returns true.
onPointerCancel
propertyproperty onPointerCancelonPointerCancelCapture
propertyproperty onPointerCancelCaptureonPointerDown
propertyproperty onPointerDownonPointerDownCapture
propertyproperty onPointerDownCaptureonPointerEnter
propertyproperty onPointerEnteronPointerEnterCapture
propertyproperty onPointerEnterCaptureonPointerLeave
propertyproperty onPointerLeaveonPointerLeaveCapture
propertyproperty onPointerLeaveCaptureonPointerMove
propertyproperty onPointerMoveonPointerMoveCapture
propertyproperty onPointerMoveCaptureonPointerUp
propertyproperty onPointerUponPointerUpCapture
propertyproperty onPointerUpCaptureonResponderEnd
propertyproperty onResponderEndIf the View returns true and attempts to become the responder, one of the following will happen:
onResponderGrant
propertyproperty onResponderGrantThe View is now responding for touch events. This is the time to highlight and show the user what is happening
onResponderReject
propertyproperty onResponderRejectSomething else is the responder right now and will not release it
onResponderStart
propertyproperty onResponderStartonResponderTerminate
propertyproperty onResponderTerminateThe responder has been taken from the View. Might be taken by other views after a call to onResponderTerminationRequest, or might be taken by the OS without asking (happens with control center/ notification center on iOS)
onResponderTerminationRequest
propertyproperty onResponderTerminationRequestSomething else wants to become responder. Should this view release the responder? Returning true allows release
onSelectionChange
propertyproperty onSelectionChangeonStartShouldSetResponder
propertyproperty onStartShouldSetResponderDoes this view want to become responder on the start of a touch?
onStartShouldSetResponderCapture
propertyproperty onStartShouldSetResponderCaptureonStartShouldSetResponder and onMoveShouldSetResponder are called with a bubbling pattern, where the deepest node is called first. That means that the deepest component will become responder when multiple Views return true for *ShouldSetResponder handlers. This is desirable in most cases, because it makes sure all controls and buttons are usable.
However, sometimes a parent will want to make sure that it becomes responder. This can be handled by using the capture phase. Before the responder system bubbles up from the deepest component, it will do a capture phase, firing on*ShouldSetResponderCapture. So if a parent View wants to prevent the child from becoming responder on a touch start, it should have a onStartShouldSetResponderCapture handler which returns true.
onTouchCancel
propertyproperty onTouchCancelonTouchEnd
propertyproperty onTouchEndonTouchEndCapture
propertyproperty onTouchEndCaptureonTouchMove
propertyproperty onTouchMoveonTouchStart
propertyproperty onTouchStartpointerEvents
propertyproperty pointerEventsIn the absence of auto property, none is much like CSS's none value. box-none is as if you had applied the CSS class:
.box-none { pointer-events: none; } .box-none * { pointer-events: all; }
box-only is the equivalent of
.box-only { pointer-events: all; } .box-only * { pointer-events: none; }
But since pointerEvents does not affect layout/appearance, and we are already deviating from the spec by adding additional modes, we opt to not include pointerEvents on style. On some platforms, we would need to implement it as a className anyways. Using style or not is an implementation detail of the platform.
removeClippedSubviews
propertyproperty removeClippedSubviewsThis is a special performance property exposed by RCTView and is useful for scrolling content when there are many subviews, most of which are offscreen. For this property to be effective, it must be applied to a view that contains many subviews that extend outside its bound. The subviews must also have overflow: hidden, as should the containing view (or one of its superviews).
renderToHardwareTextureAndroid
propertyproperty renderToHardwareTextureAndroidWhether this view should render itself (and all of its children) into a single hardware texture on the GPU.
On Android, this is useful for animations and interactions that only modify opacity, rotation, translation, and/or scale: in those cases, the view doesn't have to be redrawn and display lists don't need to be re-executed. The texture can just be re-used and re-composited with different parameters. The downside is that this can use up limited video memory, so this prop should be set back to false at the end of the interaction/animation.
role
propertyproperty roleIndicates to accessibility services to treat UI component like a specific role.
screenReaderFocusable
propertyproperty screenReaderFocusableEnables the view to be screen reader focusable, not keyboard focusable.
selection
propertyproperty selectionsessionId
propertyproperty sessionIdshouldRasterizeIOS
propertyproperty shouldRasterizeIOSWhether this view should be rendered as a bitmap before compositing.
On iOS, this is useful for animations and interactions that do not modify this component's dimensions nor its children; for example, when translating the position of a static view, rasterization allows the renderer to reuse a cached bitmap of a static view and quickly composite it during each frame.
Rasterization incurs an off-screen drawing pass and the bitmap consumes memory. Test and measure when using this property.
style
propertyproperty styletabIndex
propertyproperty tabIndexIndicates whether this View should be focusable with a non-touch input device, eg. receive focus with a hardware keyboard.
See https://developer.mozilla.org/en-US/docs/Web/HTML/Global_attributes/tabindex
for more details.
Supports the following values:
- 0 (View is focusable)
- -1 (View is not focusable)
tvParallaxMagnification
propertyproperty tvParallaxMagnification(Apple TV only) May be used to change the appearance of the Apple TV parallax effect when this view goes in or out of focus. Defaults to 1.0.
tvParallaxShiftDistanceX
propertyproperty tvParallaxShiftDistanceX(Apple TV only) May be used to change the appearance of the Apple TV parallax effect when this view goes in or out of focus. Defaults to 2.0.
tvParallaxShiftDistanceY
propertyproperty tvParallaxShiftDistanceY(Apple TV only) May be used to change the appearance of the Apple TV parallax effect when this view goes in or out of focus. Defaults to 2.0.
tvParallaxTiltAngle
propertyproperty tvParallaxTiltAngle(Apple TV only) May be used to change the appearance of the Apple TV parallax effect when this view goes in or out of focus. Defaults to 0.05.
NotionTextFieldProps
interfaceinterface NotionTextFieldProps Props accepted by one native editable field.
accessibilityActions
propertyproperty accessibilityActionsProvides an array of custom actions available for accessibility.
accessibilityHint
propertyproperty accessibilityHintAn accessibility hint helps users understand what will happen when they perform an action on the accessibility element when that result is not obvious from the accessibility label.
accessibilityIgnoresInvertColors
propertyproperty accessibilityIgnoresInvertColorsaccessibilityLabel
propertyproperty accessibilityLabelOverrides the text that's read by the screen reader when the user interacts with the element. By default, the label is constructed by traversing all the children and accumulating all the Text nodes separated by space.
accessibilityLabelledBy
propertyproperty accessibilityLabelledByIdentifies the element that labels the element it is applied to. When the assistive technology focuses on the component with this props, the text is read aloud. The value should should match the nativeID of the related element.
accessibilityLanguage
propertyproperty accessibilityLanguageBy using the accessibilityLanguage property, the screen reader will understand which language to use while reading the element's label, value and hint. The provided string value must follow the BCP 47 specification (https://www.rfc-editor.org/info/bcp47). https://reactnative.dev/docs/accessibility#accessibilitylanguage-ios
accessibilityLargeContentTitle
propertyproperty accessibilityLargeContentTitleWhen accessibilityShowsLargeContentViewer is set, this string will be used as title for the large content viewer.
https://reactnative.dev/docs/accessibility#accessibilitylargecontenttitle
accessibilityLiveRegion
propertyproperty accessibilityLiveRegionIndicates to accessibility services whether the user should be notified when this view changes. Works for Android API >= 19 only.
property accessibilityRespondsToUserInteractionBlocks the user from interacting with the component through keyboard while still allowing screen reader to interact with it if this View is still accessible.
accessibilityRole
propertyproperty accessibilityRoleAccessibility Role tells a person using either VoiceOver on iOS or TalkBack on Android the type of element that is focused on.
property accessibilityShowsLargeContentViewerA Boolean value that indicates whether or not to show the item in the large content viewer. Available on iOS 13.0+ https://reactnative.dev/docs/accessibility#accessibilityshowslargecontentviewer
accessibilityState
propertyproperty accessibilityStateAccessibility State tells a person using either VoiceOver on iOS or TalkBack on Android the state of the element currently focused on.
accessibilityValue
propertyproperty accessibilityValueRepresents the current value of a component. It can be a textual description of a component's value, or for range-based components, such as sliders and progress bars, it contains range information (minimum, current, and maximum).
accessibilityViewIsModal
propertyproperty accessibilityViewIsModalA Boolean value indicating whether VoiceOver should ignore the elements within views that are siblings of the receiver.
accessible
propertyproperty accessibleWhen true, indicates that the view is an accessibility element. By default, all the touchable elements are accessible.
aria-busy
propertyproperty aria-busyalias for accessibilityState
see https://reactnative.dev/docs/accessibility#accessibilitystate
aria-checked
propertyproperty aria-checkedaria-disabled
propertyproperty aria-disabledaria-expanded
propertyproperty aria-expandedaria-label
propertyproperty aria-labelAlias for accessibilityLabel https://reactnative.dev/docs/view#accessibilitylabel https://github.com/react/react-native/issues/34424
aria-labelledby
propertyproperty aria-labelledbyIdentifies the element that labels the element it is applied to. When the assistive technology focuses on the component with this props, the text is read aloud. The value should should match the nativeID of the related element.
aria-live
propertyproperty aria-liveIndicates to accessibility services whether the user should be notified when this view changes. Works for Android API >= 19 only.
aria-modal
propertyproperty aria-modalaria-selected
propertyproperty aria-selectedaria-valuemax
propertyproperty aria-valuemaxaria-valuemin
propertyproperty aria-valueminaria-valuenow
propertyproperty aria-valuenowaria-valuetext
propertyproperty aria-valuetextchildren
propertyproperty childrencollapsable
propertyproperty collapsableViews that are only used to layout their children or otherwise don't draw anything may be automatically removed from the native hierarchy as an optimization. Set this property to false to disable this optimization and ensure that this View exists in the native view hierarchy.
collapsableChildren
propertyproperty collapsableChildrenSetting to false prevents direct children of the view from being removed
from the native view hierarchy, similar to the effect of setting
collapsable={false} on each child.
command
propertyproperty commanddark
propertyproperty darkfield
propertyproperty fieldfocusable
propertyproperty focusableWhether this View should be focusable with a non-touch input device, eg. receive focus with a hardware keyboard.
hasTVPreferredFocus
propertyproperty hasTVPreferredFocus(Apple TV only) May be set to true to force the Apple TV focus engine to move focus to this view.
hitSlop
propertyproperty hitSlopThis defines how far a touch event can start away from the view. Typical interface guidelines recommend touch targets that are at least 30 - 40 points/density-independent pixels. If a Touchable view has a height of 20 the touchable height can be extended to 40 with hitSlop={{top: 10, bottom: 10, left: 0, right: 0}} NOTE The touch area never extends past the parent view bounds and the Z-index of sibling views always takes precedence if a touch hits two overlapping views.
importantForAccessibility
propertyproperty importantForAccessibility[Android] Controlling if a view fires accessibility events and if it is reported to accessibility services.
isTVSelectable
propertyproperty isTVSelectable(Apple TV only) When set to true, this view will be focusable and navigable using the Apple TV remote.
needsOffscreenAlphaCompositing
propertyproperty needsOffscreenAlphaCompositingWhether this view needs to rendered offscreen and composited with an alpha in order to preserve 100% correct colors and blending behavior. The default (false) falls back to drawing the component and its children with an alpha applied to the paint used to draw each element instead of rendering the full component offscreen and compositing it back with an alpha value. This default may be noticeable and undesired in the case where the View you are setting an opacity on has multiple overlapping elements (e.g. multiple overlapping Views, or text and a background).
Rendering offscreen to preserve correct alpha behavior is extremely expensive and hard to debug for non-native developers, which is why it is not turned on by default. If you do need to enable this property for an animation, consider combining it with renderToHardwareTextureAndroid if the view contents are static (i.e. it doesn't need to be redrawn each frame). If that property is enabled, this View will be rendered off-screen once, saved in a hardware texture, and then composited onto the screen with an alpha each frame without having to switch rendering targets on the GPU.
onAccessibilityAction
propertyproperty onAccessibilityActionWhen accessible is true, the system will try to invoke this function when the user performs an accessibility custom action.
onAccessibilityEscape
propertyproperty onAccessibilityEscapeWhen accessible is true, the system will invoke this function when the user performs the escape gesture (scrub with two fingers).
onAccessibilityTap
propertyproperty onAccessibilityTapWhen accessible is true, the system will try to invoke this function when the user performs accessibility tap gesture.
onBlur
propertyproperty onBlurCallback that is called when the view is blurred.
Note: This will only be called if the view is focusable.
onBoundary
propertyproperty onBoundaryonEdit
propertyproperty onEditonFieldBlur
propertyproperty onFieldBluronFieldFocus
propertyproperty onFieldFocusonFocus
propertyproperty onFocusCallback that is called when the view is focused.
Note: This will only be called if the view is focusable.
onLayout
propertyproperty onLayoutInvoked on mount and layout changes with
{nativeEvent: { layout: {x, y, width, height}}}.
onMagicTap
propertyproperty onMagicTapWhen accessible is true, the system will invoke this function when the user performs the magic tap gesture.
onMoveShouldSetResponder
propertyproperty onMoveShouldSetResponderCalled for every touch move on the View when it is not the responder: does this view want to "claim" touch responsiveness?
onMoveShouldSetResponderCapture
propertyproperty onMoveShouldSetResponderCaptureonStartShouldSetResponder and onMoveShouldSetResponder are called with a bubbling pattern, where the deepest node is called first. That means that the deepest component will become responder when multiple Views return true for *ShouldSetResponder handlers. This is desirable in most cases, because it makes sure all controls and buttons are usable.
However, sometimes a parent will want to make sure that it becomes responder. This can be handled by using the capture phase. Before the responder system bubbles up from the deepest component, it will do a capture phase, firing on*ShouldSetResponderCapture. So if a parent View wants to prevent the child from becoming responder on a touch start, it should have a onStartShouldSetResponderCapture handler which returns true.
onPointerCancel
propertyproperty onPointerCancelonPointerCancelCapture
propertyproperty onPointerCancelCaptureonPointerDown
propertyproperty onPointerDownonPointerDownCapture
propertyproperty onPointerDownCaptureonPointerEnter
propertyproperty onPointerEnteronPointerEnterCapture
propertyproperty onPointerEnterCaptureonPointerLeave
propertyproperty onPointerLeaveonPointerLeaveCapture
propertyproperty onPointerLeaveCaptureonPointerMove
propertyproperty onPointerMoveonPointerMoveCapture
propertyproperty onPointerMoveCaptureonPointerUp
propertyproperty onPointerUponPointerUpCapture
propertyproperty onPointerUpCaptureonResponderEnd
propertyproperty onResponderEndIf the View returns true and attempts to become the responder, one of the following will happen:
onResponderGrant
propertyproperty onResponderGrantThe View is now responding for touch events. This is the time to highlight and show the user what is happening
onResponderReject
propertyproperty onResponderRejectSomething else is the responder right now and will not release it
onResponderStart
propertyproperty onResponderStartonResponderTerminate
propertyproperty onResponderTerminateThe responder has been taken from the View. Might be taken by other views after a call to onResponderTerminationRequest, or might be taken by the OS without asking (happens with control center/ notification center on iOS)
onResponderTerminationRequest
propertyproperty onResponderTerminationRequestSomething else wants to become responder. Should this view release the responder? Returning true allows release
onStartShouldSetResponder
propertyproperty onStartShouldSetResponderDoes this view want to become responder on the start of a touch?
onStartShouldSetResponderCapture
propertyproperty onStartShouldSetResponderCaptureonStartShouldSetResponder and onMoveShouldSetResponder are called with a bubbling pattern, where the deepest node is called first. That means that the deepest component will become responder when multiple Views return true for *ShouldSetResponder handlers. This is desirable in most cases, because it makes sure all controls and buttons are usable.
However, sometimes a parent will want to make sure that it becomes responder. This can be handled by using the capture phase. Before the responder system bubbles up from the deepest component, it will do a capture phase, firing on*ShouldSetResponderCapture. So if a parent View wants to prevent the child from becoming responder on a touch start, it should have a onStartShouldSetResponderCapture handler which returns true.
onTouchCancel
propertyproperty onTouchCancelonTouchEnd
propertyproperty onTouchEndonTouchEndCapture
propertyproperty onTouchEndCaptureonTouchMove
propertyproperty onTouchMoveonTouchStart
propertyproperty onTouchStartpointerEvents
propertyproperty pointerEventsIn the absence of auto property, none is much like CSS's none value. box-none is as if you had applied the CSS class:
.box-none { pointer-events: none; } .box-none * { pointer-events: all; }
box-only is the equivalent of
.box-only { pointer-events: all; } .box-only * { pointer-events: none; }
But since pointerEvents does not affect layout/appearance, and we are already deviating from the spec by adding additional modes, we opt to not include pointerEvents on style. On some platforms, we would need to implement it as a className anyways. Using style or not is an implementation detail of the platform.
removeClippedSubviews
propertyproperty removeClippedSubviewsThis is a special performance property exposed by RCTView and is useful for scrolling content when there are many subviews, most of which are offscreen. For this property to be effective, it must be applied to a view that contains many subviews that extend outside its bound. The subviews must also have overflow: hidden, as should the containing view (or one of its superviews).
renderToHardwareTextureAndroid
propertyproperty renderToHardwareTextureAndroidWhether this view should render itself (and all of its children) into a single hardware texture on the GPU.
On Android, this is useful for animations and interactions that only modify opacity, rotation, translation, and/or scale: in those cases, the view doesn't have to be redrawn and display lists don't need to be re-executed. The texture can just be re-used and re-composited with different parameters. The downside is that this can use up limited video memory, so this prop should be set back to false at the end of the interaction/animation.
role
propertyproperty roleIndicates to accessibility services to treat UI component like a specific role.
screenReaderFocusable
propertyproperty screenReaderFocusableEnables the view to be screen reader focusable, not keyboard focusable.
shouldRasterizeIOS
propertyproperty shouldRasterizeIOSWhether this view should be rendered as a bitmap before compositing.
On iOS, this is useful for animations and interactions that do not modify this component's dimensions nor its children; for example, when translating the position of a static view, rasterization allows the renderer to reuse a cached bitmap of a static view and quickly composite it during each frame.
Rasterization incurs an off-screen drawing pass and the bitmap consumes memory. Test and measure when using this property.
style
propertyproperty styletabIndex
propertyproperty tabIndexIndicates whether this View should be focusable with a non-touch input device, eg. receive focus with a hardware keyboard.
See https://developer.mozilla.org/en-US/docs/Web/HTML/Global_attributes/tabindex
for more details.
Supports the following values:
- 0 (View is focusable)
- -1 (View is not focusable)
tvParallaxMagnification
propertyproperty tvParallaxMagnification(Apple TV only) May be used to change the appearance of the Apple TV parallax effect when this view goes in or out of focus. Defaults to 1.0.
tvParallaxShiftDistanceX
propertyproperty tvParallaxShiftDistanceX(Apple TV only) May be used to change the appearance of the Apple TV parallax effect when this view goes in or out of focus. Defaults to 2.0.
tvParallaxShiftDistanceY
propertyproperty tvParallaxShiftDistanceY(Apple TV only) May be used to change the appearance of the Apple TV parallax effect when this view goes in or out of focus. Defaults to 2.0.
tvParallaxTiltAngle
propertyproperty tvParallaxTiltAngle(Apple TV only) May be used to change the appearance of the Apple TV parallax effect when this view goes in or out of focus. Defaults to 0.05.
NativePageReferencePressEvent
interfaceinterface NativePageReferencePressEvent Data emitted when a page reference is pressed in the native proof editor.
NativeProofEditorProps
interfaceinterface NativeProofEditorProps Native epoch/revision transport and proof editing events.
accessibilityActions
propertyproperty accessibilityActionsProvides an array of custom actions available for accessibility.
accessibilityHint
propertyproperty accessibilityHintAn accessibility hint helps users understand what will happen when they perform an action on the accessibility element when that result is not obvious from the accessibility label.
accessibilityIgnoresInvertColors
propertyproperty accessibilityIgnoresInvertColorsaccessibilityLabel
propertyproperty accessibilityLabelOverrides the text that's read by the screen reader when the user interacts with the element. By default, the label is constructed by traversing all the children and accumulating all the Text nodes separated by space.
accessibilityLabelledBy
propertyproperty accessibilityLabelledByIdentifies the element that labels the element it is applied to. When the assistive technology focuses on the component with this props, the text is read aloud. The value should should match the nativeID of the related element.
accessibilityLanguage
propertyproperty accessibilityLanguageBy using the accessibilityLanguage property, the screen reader will understand which language to use while reading the element's label, value and hint. The provided string value must follow the BCP 47 specification (https://www.rfc-editor.org/info/bcp47). https://reactnative.dev/docs/accessibility#accessibilitylanguage-ios
accessibilityLargeContentTitle
propertyproperty accessibilityLargeContentTitleWhen accessibilityShowsLargeContentViewer is set, this string will be used as title for the large content viewer.
https://reactnative.dev/docs/accessibility#accessibilitylargecontenttitle
accessibilityLiveRegion
propertyproperty accessibilityLiveRegionIndicates to accessibility services whether the user should be notified when this view changes. Works for Android API >= 19 only.
property accessibilityRespondsToUserInteractionBlocks the user from interacting with the component through keyboard while still allowing screen reader to interact with it if this View is still accessible.
accessibilityRole
propertyproperty accessibilityRoleAccessibility Role tells a person using either VoiceOver on iOS or TalkBack on Android the type of element that is focused on.
property accessibilityShowsLargeContentViewerA Boolean value that indicates whether or not to show the item in the large content viewer. Available on iOS 13.0+ https://reactnative.dev/docs/accessibility#accessibilityshowslargecontentviewer
accessibilityState
propertyproperty accessibilityStateAccessibility State tells a person using either VoiceOver on iOS or TalkBack on Android the state of the element currently focused on.
accessibilityValue
propertyproperty accessibilityValueRepresents the current value of a component. It can be a textual description of a component's value, or for range-based components, such as sliders and progress bars, it contains range information (minimum, current, and maximum).
accessibilityViewIsModal
propertyproperty accessibilityViewIsModalA Boolean value indicating whether VoiceOver should ignore the elements within views that are siblings of the receiver.
accessible
propertyproperty accessibleWhen true, indicates that the view is an accessibility element. By default, all the touchable elements are accessible.
aria-busy
propertyproperty aria-busyalias for accessibilityState
see https://reactnative.dev/docs/accessibility#accessibilitystate
aria-checked
propertyproperty aria-checkedaria-disabled
propertyproperty aria-disabledaria-expanded
propertyproperty aria-expandedaria-label
propertyproperty aria-labelAlias for accessibilityLabel https://reactnative.dev/docs/view#accessibilitylabel https://github.com/react/react-native/issues/34424
aria-labelledby
propertyproperty aria-labelledbyIdentifies the element that labels the element it is applied to. When the assistive technology focuses on the component with this props, the text is read aloud. The value should should match the nativeID of the related element.
aria-live
propertyproperty aria-liveIndicates to accessibility services whether the user should be notified when this view changes. Works for Android API >= 19 only.
aria-modal
propertyproperty aria-modalaria-selected
propertyproperty aria-selectedaria-valuemax
propertyproperty aria-valuemaxaria-valuemin
propertyproperty aria-valueminaria-valuenow
propertyproperty aria-valuenowaria-valuetext
propertyproperty aria-valuetextchildren
propertyproperty childrencollapsable
propertyproperty collapsableViews that are only used to layout their children or otherwise don't draw anything may be automatically removed from the native hierarchy as an optimization. Set this property to false to disable this optimization and ensure that this View exists in the native view hierarchy.
collapsableChildren
propertyproperty collapsableChildrenSetting to false prevents direct children of the view from being removed
from the native view hierarchy, similar to the effect of setting
collapsable={false} on each child.
command
propertyproperty commanddark
propertyproperty darkemptyTogglePlaceholder
propertyproperty emptyTogglePlaceholderHint shown inside the empty child created for a toggle heading.
focusable
propertyproperty focusableWhether this View should be focusable with a non-touch input device, eg. receive focus with a hardware keyboard.
hasTVPreferredFocus
propertyproperty hasTVPreferredFocus(Apple TV only) May be set to true to force the Apple TV focus engine to move focus to this view.
hitSlop
propertyproperty hitSlopThis defines how far a touch event can start away from the view. Typical interface guidelines recommend touch targets that are at least 30 - 40 points/density-independent pixels. If a Touchable view has a height of 20 the touchable height can be extended to 40 with hitSlop={{top: 10, bottom: 10, left: 0, right: 0}} NOTE The touch area never extends past the parent view bounds and the Z-index of sibling views always takes precedence if a touch hits two overlapping views.
imageMaxWidth
propertyproperty imageMaxWidthMaximum rendered width of image and video blocks, in logical pixels.
importantForAccessibility
propertyproperty importantForAccessibility[Android] Controlling if a view fires accessibility events and if it is reported to accessibility services.
isTVSelectable
propertyproperty isTVSelectable(Apple TV only) When set to true, this view will be focusable and navigable using the Apple TV remote.
needsOffscreenAlphaCompositing
propertyproperty needsOffscreenAlphaCompositingWhether this view needs to rendered offscreen and composited with an alpha in order to preserve 100% correct colors and blending behavior. The default (false) falls back to drawing the component and its children with an alpha applied to the paint used to draw each element instead of rendering the full component offscreen and compositing it back with an alpha value. This default may be noticeable and undesired in the case where the View you are setting an opacity on has multiple overlapping elements (e.g. multiple overlapping Views, or text and a background).
Rendering offscreen to preserve correct alpha behavior is extremely expensive and hard to debug for non-native developers, which is why it is not turned on by default. If you do need to enable this property for an animation, consider combining it with renderToHardwareTextureAndroid if the view contents are static (i.e. it doesn't need to be redrawn each frame). If that property is enabled, this View will be rendered off-screen once, saved in a hardware texture, and then composited onto the screen with an alpha each frame without having to switch rendering targets on the GPU.
onAccessibilityAction
propertyproperty onAccessibilityActionWhen accessible is true, the system will try to invoke this function when the user performs an accessibility custom action.
onAccessibilityEscape
propertyproperty onAccessibilityEscapeWhen accessible is true, the system will invoke this function when the user performs the escape gesture (scrub with two fingers).
onAccessibilityTap
propertyproperty onAccessibilityTapWhen accessible is true, the system will try to invoke this function when the user performs accessibility tap gesture.
onBlockActionsPress
propertyproperty onBlockActionsPressFired when a block that opens the actions sheet (e.g. a divider) is tapped.
onBlur
propertyproperty onBlurCallback that is called when the view is blurred.
Note: This will only be called if the view is focusable.
onContentSize
propertyproperty onContentSizeFired whenever the native text layout's own content height changes, in dp -- lets the RN side size this view to its true content (e.g. tall images) instead of clipping it.
onEdit
propertyproperty onEditonFocus
propertyproperty onFocusCallback that is called when the view is focused.
Note: This will only be called if the view is focusable.
onLayout
propertyproperty onLayoutInvoked on mount and layout changes with
{nativeEvent: { layout: {x, y, width, height}}}.
onMagicTap
propertyproperty onMagicTapWhen accessible is true, the system will invoke this function when the user performs the magic tap gesture.
onMoveShouldSetResponder
propertyproperty onMoveShouldSetResponderCalled for every touch move on the View when it is not the responder: does this view want to "claim" touch responsiveness?
onMoveShouldSetResponderCapture
propertyproperty onMoveShouldSetResponderCaptureonStartShouldSetResponder and onMoveShouldSetResponder are called with a bubbling pattern, where the deepest node is called first. That means that the deepest component will become responder when multiple Views return true for *ShouldSetResponder handlers. This is desirable in most cases, because it makes sure all controls and buttons are usable.
However, sometimes a parent will want to make sure that it becomes responder. This can be handled by using the capture phase. Before the responder system bubbles up from the deepest component, it will do a capture phase, firing on*ShouldSetResponderCapture. So if a parent View wants to prevent the child from becoming responder on a touch start, it should have a onStartShouldSetResponderCapture handler which returns true.
onPageReferencePress
propertyproperty onPageReferencePressonPointerCancel
propertyproperty onPointerCancelonPointerCancelCapture
propertyproperty onPointerCancelCaptureonPointerDown
propertyproperty onPointerDownonPointerDownCapture
propertyproperty onPointerDownCaptureonPointerEnter
propertyproperty onPointerEnteronPointerEnterCapture
propertyproperty onPointerEnterCaptureonPointerLeave
propertyproperty onPointerLeaveonPointerLeaveCapture
propertyproperty onPointerLeaveCaptureonPointerMove
propertyproperty onPointerMoveonPointerMoveCapture
propertyproperty onPointerMoveCaptureonPointerUp
propertyproperty onPointerUponPointerUpCapture
propertyproperty onPointerUpCaptureonResponderEnd
propertyproperty onResponderEndIf the View returns true and attempts to become the responder, one of the following will happen:
onResponderGrant
propertyproperty onResponderGrantThe View is now responding for touch events. This is the time to highlight and show the user what is happening
onResponderReject
propertyproperty onResponderRejectSomething else is the responder right now and will not release it
onResponderStart
propertyproperty onResponderStartonResponderTerminate
propertyproperty onResponderTerminateThe responder has been taken from the View. Might be taken by other views after a call to onResponderTerminationRequest, or might be taken by the OS without asking (happens with control center/ notification center on iOS)
onResponderTerminationRequest
propertyproperty onResponderTerminationRequestSomething else wants to become responder. Should this view release the responder? Returning true allows release
onStartShouldSetResponder
propertyproperty onStartShouldSetResponderDoes this view want to become responder on the start of a touch?
onStartShouldSetResponderCapture
propertyproperty onStartShouldSetResponderCaptureonStartShouldSetResponder and onMoveShouldSetResponder are called with a bubbling pattern, where the deepest node is called first. That means that the deepest component will become responder when multiple Views return true for *ShouldSetResponder handlers. This is desirable in most cases, because it makes sure all controls and buttons are usable.
However, sometimes a parent will want to make sure that it becomes responder. This can be handled by using the capture phase. Before the responder system bubbles up from the deepest component, it will do a capture phase, firing on*ShouldSetResponderCapture. So if a parent View wants to prevent the child from becoming responder on a touch start, it should have a onStartShouldSetResponderCapture handler which returns true.
onTouchCancel
propertyproperty onTouchCancelonTouchEnd
propertyproperty onTouchEndonTouchEndCapture
propertyproperty onTouchEndCaptureonTouchMove
propertyproperty onTouchMoveonTouchStart
propertyproperty onTouchStartpageReferenceFallbackIcon
propertyproperty pageReferenceFallbackIconOptional glyph used by the native proof view when a page has no fetched icon.
pointerEvents
propertyproperty pointerEventsIn the absence of auto property, none is much like CSS's none value. box-none is as if you had applied the CSS class:
.box-none { pointer-events: none; } .box-none * { pointer-events: all; }
box-only is the equivalent of
.box-only { pointer-events: all; } .box-only * { pointer-events: none; }
But since pointerEvents does not affect layout/appearance, and we are already deviating from the spec by adding additional modes, we opt to not include pointerEvents on style. On some platforms, we would need to implement it as a className anyways. Using style or not is an implementation detail of the platform.
removeClippedSubviews
propertyproperty removeClippedSubviewsThis is a special performance property exposed by RCTView and is useful for scrolling content when there are many subviews, most of which are offscreen. For this property to be effective, it must be applied to a view that contains many subviews that extend outside its bound. The subviews must also have overflow: hidden, as should the containing view (or one of its superviews).
renderToHardwareTextureAndroid
propertyproperty renderToHardwareTextureAndroidWhether this view should render itself (and all of its children) into a single hardware texture on the GPU.
On Android, this is useful for animations and interactions that only modify opacity, rotation, translation, and/or scale: in those cases, the view doesn't have to be redrawn and display lists don't need to be re-executed. The texture can just be re-used and re-composited with different parameters. The downside is that this can use up limited video memory, so this prop should be set back to false at the end of the interaction/animation.
role
propertyproperty roleIndicates to accessibility services to treat UI component like a specific role.
screenReaderFocusable
propertyproperty screenReaderFocusableEnables the view to be screen reader focusable, not keyboard focusable.
shouldRasterizeIOS
propertyproperty shouldRasterizeIOSWhether this view should be rendered as a bitmap before compositing.
On iOS, this is useful for animations and interactions that do not modify this component's dimensions nor its children; for example, when translating the position of a static view, rasterization allows the renderer to reuse a cached bitmap of a static view and quickly composite it during each frame.
Rasterization incurs an off-screen drawing pass and the bitmap consumes memory. Test and measure when using this property.
snapshot
propertyproperty snapshotstyle
propertyproperty styletabIndex
propertyproperty tabIndexIndicates whether this View should be focusable with a non-touch input device, eg. receive focus with a hardware keyboard.
See https://developer.mozilla.org/en-US/docs/Web/HTML/Global_attributes/tabindex
for more details.
Supports the following values:
- 0 (View is focusable)
- -1 (View is not focusable)
tvParallaxMagnification
propertyproperty tvParallaxMagnification(Apple TV only) May be used to change the appearance of the Apple TV parallax effect when this view goes in or out of focus. Defaults to 1.0.
tvParallaxShiftDistanceX
propertyproperty tvParallaxShiftDistanceX(Apple TV only) May be used to change the appearance of the Apple TV parallax effect when this view goes in or out of focus. Defaults to 2.0.
tvParallaxShiftDistanceY
propertyproperty tvParallaxShiftDistanceY(Apple TV only) May be used to change the appearance of the Apple TV parallax effect when this view goes in or out of focus. Defaults to 2.0.
tvParallaxTiltAngle
propertyproperty tvParallaxTiltAngle(Apple TV only) May be used to change the appearance of the Apple TV parallax effect when this view goes in or out of focus. Defaults to 0.05.
ProofBlock
interfaceinterface ProofBlock A block in the milestone-one transport model. This is not the public Notion AST.
collapsed
propertyproperty collapsedWhether a toggle header's child content is collapsed in the editor.
color
propertyproperty colorfileName
propertyproperty fileNamefileSize
propertyproperty fileSizeid
propertyproperty idmimeType
propertyproperty mimeTypetext
propertyproperty texttype
propertyproperty typewaveform
propertyproperty waveformProofCommand
interfaceinterface ProofCommand A uniquely identified command sent to the native editor coordinator.
action
propertyproperty actionblockId
propertyproperty blockIdTarget block id for a "insertAbove", "insertBelow", "duplicateBlock",
"deleteBlock", or "replaceImage" action -- these act on the identified block directly
rather than on the current selection, since the block-actions sheet can be opened for a
block (e.g. a divider or an image) that never receives the text cursor.
columnCount
propertyproperty columnCountNumber of columns for a "columns" action. Defaults to 2 when omitted.
epoch
propertyproperty epochfileName
propertyproperty fileNamefileSize
propertyproperty fileSizeid
propertyproperty idmimeType
propertyproperty mimeTypewaveform
propertyproperty waveformProofEvent
interfaceinterface ProofEvent A native editor event containing the latest document and selection state.
anchor
propertyproperty anchorblocks
propertyproperty blockscomposingEnd
propertyproperty composingEndcomposingStart
propertyproperty composingStartepoch
propertyproperty epochfocus
propertyproperty focusrevision
propertyproperty revisionsource
propertyproperty sourceProofPoint
interfaceinterface ProofPoint A UTF-16 selection point within a proof block.
ProofSnapshot
interfaceinterface ProofSnapshot A revisioned document snapshot exchanged with the native editor.
ProofTextMark
interfaceinterface ProofTextMark A UTF-16 range carrying one inline formatting mark.
Types
Action
type aliastype Action = unknown Actions understood by the milestone-one native editor coordinator.
ProofColumnCount
type aliastype ProofColumnCount = unknown Supported column counts for a column_list block.
ProofTextMarkKind
type aliastype ProofTextMarkKind = unknown Boolean inline formatting marks supported by the proof editor's format sub-menu.
Variables
NotionSelectionOverlay
variableconst NotionSelectionOverlay: ComponentType A transparent overlay that draws and drags selection handles once the active selection
spans more than one NotionTextField. Selection confined to one field uses that field's
own native handles instead. Actual list scrolling stays with the host; this overlay only
requests it via onAutoScroll while a handle is dragged near its edge.
NotionTextField
variableconst NotionTextField: ComponentType One editable rich-text field -- a block's rich_text/caption/cell, not a whole document. The document store remains authoritative; this field only edits its own text and marks and reports revisioned edit and boundary transactions for the store to interpret.
acceptProofEvent
variableconst acceptProofEvent: __type createProofDocument
variableconst createProofDocument: __type NativeProofEditor
variableconst NativeProofEditor: ComponentType Android-only native coordinator. One shared buffer is intentional for this proof.
NotionMarkdown
variableconst NotionMarkdown: NotionMarkdownModule The loaded native Notion Markdown module.