Skip to content
react-native-notion-markdown

References / react-native-notion-markdown / native

native

Public API declarations exported by react-native-notion-markdown/native.

Functions

function AcceptProofEvent(current: ProofSnapshot, event: ProofEvent): ProofSnapshot

Acknowledgements never replace the native composing buffer. Replacement changes epoch.

function CreateProofDocument(epoch: number): ProofSnapshot

Create the default three-block proof document for the requested epoch.

proofPointAt

function
function proofPointAt(blocks: unknown, position: number): ProofPoint

Native buffer uses newline boundaries and U+2028 for within-block soft breaks.

Interfaces

interface NotionSelectionOverlayProps

Props accepted by the coordinator-owned cross-field selection overlay.

property accessibilityActions

Provides an array of custom actions available for accessibility.

property accessibilityElementsHidden

A Boolean value indicating whether the accessibility elements contained within this accessibility element are hidden to the screen reader.

property accessibilityHint

An 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.

property accessibilityLabel

Overrides 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.

property accessibilityLabelledBy

Identifies 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.

property accessibilityLanguage

By 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

property accessibilityLargeContentTitle

When accessibilityShowsLargeContentViewer is set, this string will be used as title for the large content viewer. https://reactnative.dev/docs/accessibility#accessibilitylargecontenttitle

property accessibilityLiveRegion

Indicates to accessibility services whether the user should be notified when this view changes. Works for Android API >= 19 only.

property accessibilityRespondsToUserInteraction

Blocks the user from interacting with the component through keyboard while still allowing screen reader to interact with it if this View is still accessible.

property accessibilityRole

Accessibility Role tells a person using either VoiceOver on iOS or TalkBack on Android the type of element that is focused on.

property accessibilityShowsLargeContentViewer

A 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

property accessibilityState

Accessibility State tells a person using either VoiceOver on iOS or TalkBack on Android the state of the element currently focused on.

property accessibilityValue

Represents 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).

property accessibilityViewIsModal

A Boolean value indicating whether VoiceOver should ignore the elements within views that are siblings of the receiver.

accessible

property
property accessible

When true, indicates that the view is an accessibility element. By default, all the touchable elements are accessible.

aria-busy

property
property aria-busy

aria-checked

property
property aria-checked
property aria-disabled
property aria-expanded

aria-hidden

property
property aria-hidden

A value indicating whether the accessibility elements contained within this accessibility element are hidden.

property aria-labelledby

Identifies 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

property
property aria-live

Indicates to accessibility services whether the user should be notified when this view changes. Works for Android API >= 19 only.

aria-modal

property
property aria-modal
property aria-selected
property aria-valuemax
property aria-valuemin
property aria-valuenow
property aria-valuetext

children

property
property children

collapsable

property
property collapsable

Views 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.

property collapsableChildren

Setting 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

property
property dark

focusable

property
property focusable

Whether this View should be focusable with a non-touch input device, eg. receive focus with a hardware keyboard.

property hasTVPreferredFocus

(Apple TV only) May be set to true to force the Apple TV focus engine to move focus to this view.

hitSlop

property
property hitSlop

This 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.

id

property
property id

Used to reference react managed views from native code.

property importantForAccessibility

[Android] Controlling if a view fires accessibility events and if it is reported to accessibility services.

property isTVSelectable

(Apple TV only) When set to true, this view will be focusable and navigable using the Apple TV remote.

nativeID

property
property nativeID

Used to reference react managed views from native code.

property needsOffscreenAlphaCompositing

Whether 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.

property onAccessibilityAction

When accessible is true, the system will try to invoke this function when the user performs an accessibility custom action.

property onAccessibilityEscape

When accessible is true, the system will invoke this function when the user performs the escape gesture (scrub with two fingers).

property onAccessibilityTap

When accessible is true, the system will try to invoke this function when the user performs accessibility tap gesture.

onAutoScroll

property
property onAutoScroll

onBlur

property
property onBlur

Callback that is called when the view is blurred.

Note: This will only be called if the view is focusable.

onFocus

property
property onFocus

Callback that is called when the view is focused.

Note: This will only be called if the view is focusable.

onLayout

property
property onLayout

Invoked on mount and layout changes with

{nativeEvent: { layout: {x, y, width, height}}}.

onMagicTap

property
property onMagicTap

When accessible is true, the system will invoke this function when the user performs the magic tap gesture.

property onMoveShouldSetResponder

Called for every touch move on the View when it is not the responder: does this view want to "claim" touch responsiveness?

property onMoveShouldSetResponderCapture

onStartShouldSetResponder 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.

property onPointerCancel
property onPointerCancelCapture
property onPointerDown
property onPointerDownCapture
property onPointerEnter
property onPointerEnterCapture
property onPointerLeave
property onPointerLeaveCapture
property onPointerMove
property onPointerMoveCapture

onPointerUp

property
property onPointerUp
property onPointerUpCapture
property onResponderEnd

If the View returns true and attempts to become the responder, one of the following will happen:

property onResponderGrant

The View is now responding for touch events. This is the time to highlight and show the user what is happening

property onResponderMove

The user is moving their finger

property onResponderReject

Something else is the responder right now and will not release it

property onResponderRelease

Fired at the end of the touch, ie "touchUp"

property onResponderStart
property onResponderTerminate

The 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)

property onResponderTerminationRequest

Something else wants to become responder. Should this view release the responder? Returning true allows release

property onSelectionChange
property onStartShouldSetResponder

Does this view want to become responder on the start of a touch?

property onStartShouldSetResponderCapture

onStartShouldSetResponder 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.

property onTouchCancel

onTouchEnd

property
property onTouchEnd
property onTouchEndCapture

onTouchMove

property
property onTouchMove

onTouchStart

property
property onTouchStart
property pointerEvents

In 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.

property removeClippedSubviews

This 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).

property renderToHardwareTextureAndroid

Whether 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

property
property role

Indicates to accessibility services to treat UI component like a specific role.

property screenReaderFocusable

Enables the view to be screen reader focusable, not keyboard focusable.

selection

property
property selection

sessionId

property
property sessionId
property shouldRasterizeIOS

Whether 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

property
property style

tabIndex

property
property tabIndex

Indicates 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)

testID

property
property testID

Used to locate this view in end-to-end tests.

property 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.

property 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.

property 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.

property 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.

interface NotionTextFieldProps

Props accepted by one native editable field.

property accessibilityActions

Provides an array of custom actions available for accessibility.

property accessibilityElementsHidden

A Boolean value indicating whether the accessibility elements contained within this accessibility element are hidden to the screen reader.

property accessibilityHint

An 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.

property accessibilityLabel

Overrides 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.

property accessibilityLabelledBy

Identifies 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.

property accessibilityLanguage

By 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

property accessibilityLargeContentTitle

When accessibilityShowsLargeContentViewer is set, this string will be used as title for the large content viewer. https://reactnative.dev/docs/accessibility#accessibilitylargecontenttitle

property accessibilityLiveRegion

Indicates to accessibility services whether the user should be notified when this view changes. Works for Android API >= 19 only.

property accessibilityRespondsToUserInteraction

Blocks the user from interacting with the component through keyboard while still allowing screen reader to interact with it if this View is still accessible.

property accessibilityRole

Accessibility Role tells a person using either VoiceOver on iOS or TalkBack on Android the type of element that is focused on.

property accessibilityShowsLargeContentViewer

A 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

property accessibilityState

Accessibility State tells a person using either VoiceOver on iOS or TalkBack on Android the state of the element currently focused on.

property accessibilityValue

Represents 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).

property accessibilityViewIsModal

A Boolean value indicating whether VoiceOver should ignore the elements within views that are siblings of the receiver.

accessible

property
property accessible

When true, indicates that the view is an accessibility element. By default, all the touchable elements are accessible.

aria-busy

property
property aria-busy

aria-checked

property
property aria-checked
property aria-disabled
property aria-expanded

aria-hidden

property
property aria-hidden

A value indicating whether the accessibility elements contained within this accessibility element are hidden.

property aria-labelledby

Identifies 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

property
property aria-live

Indicates to accessibility services whether the user should be notified when this view changes. Works for Android API >= 19 only.

aria-modal

property
property aria-modal
property aria-selected
property aria-valuemax
property aria-valuemin
property aria-valuenow
property aria-valuetext

children

property
property children

collapsable

property
property collapsable

Views 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.

property collapsableChildren

Setting 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

property
property command

dark

property
property dark

field

property
property field

focusable

property
property focusable

Whether this View should be focusable with a non-touch input device, eg. receive focus with a hardware keyboard.

property hasTVPreferredFocus

(Apple TV only) May be set to true to force the Apple TV focus engine to move focus to this view.

hitSlop

property
property hitSlop

This 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.

id

property
property id

Used to reference react managed views from native code.

property importantForAccessibility

[Android] Controlling if a view fires accessibility events and if it is reported to accessibility services.

property isTVSelectable

(Apple TV only) When set to true, this view will be focusable and navigable using the Apple TV remote.

nativeID

property
property nativeID

Used to reference react managed views from native code.

property needsOffscreenAlphaCompositing

Whether 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.

property onAccessibilityAction

When accessible is true, the system will try to invoke this function when the user performs an accessibility custom action.

property onAccessibilityEscape

When accessible is true, the system will invoke this function when the user performs the escape gesture (scrub with two fingers).

property onAccessibilityTap

When accessible is true, the system will try to invoke this function when the user performs accessibility tap gesture.

onBlur

property
property onBlur

Callback that is called when the view is blurred.

Note: This will only be called if the view is focusable.

onBoundary

property
property onBoundary

onEdit

property
property onEdit

onFieldBlur

property
property onFieldBlur

onFieldFocus

property
property onFieldFocus

onFocus

property
property onFocus

Callback that is called when the view is focused.

Note: This will only be called if the view is focusable.

onLayout

property
property onLayout

Invoked on mount and layout changes with

{nativeEvent: { layout: {x, y, width, height}}}.

onMagicTap

property
property onMagicTap

When accessible is true, the system will invoke this function when the user performs the magic tap gesture.

property onMoveShouldSetResponder

Called for every touch move on the View when it is not the responder: does this view want to "claim" touch responsiveness?

property onMoveShouldSetResponderCapture

onStartShouldSetResponder 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.

property onPointerCancel
property onPointerCancelCapture
property onPointerDown
property onPointerDownCapture
property onPointerEnter
property onPointerEnterCapture
property onPointerLeave
property onPointerLeaveCapture
property onPointerMove
property onPointerMoveCapture

onPointerUp

property
property onPointerUp
property onPointerUpCapture
property onResponderEnd

If the View returns true and attempts to become the responder, one of the following will happen:

property onResponderGrant

The View is now responding for touch events. This is the time to highlight and show the user what is happening

property onResponderMove

The user is moving their finger

property onResponderReject

Something else is the responder right now and will not release it

property onResponderRelease

Fired at the end of the touch, ie "touchUp"

property onResponderStart
property onResponderTerminate

The 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)

property onResponderTerminationRequest

Something else wants to become responder. Should this view release the responder? Returning true allows release

property onStartShouldSetResponder

Does this view want to become responder on the start of a touch?

property onStartShouldSetResponderCapture

onStartShouldSetResponder 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.

property onTouchCancel

onTouchEnd

property
property onTouchEnd
property onTouchEndCapture

onTouchMove

property
property onTouchMove

onTouchStart

property
property onTouchStart
property pointerEvents

In 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.

property removeClippedSubviews

This 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).

property renderToHardwareTextureAndroid

Whether 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

property
property role

Indicates to accessibility services to treat UI component like a specific role.

property screenReaderFocusable

Enables the view to be screen reader focusable, not keyboard focusable.

property shouldRasterizeIOS

Whether 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

property
property style

tabIndex

property
property tabIndex

Indicates 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)

testID

property
property testID

Used to locate this view in end-to-end tests.

property 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.

property 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.

property 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.

property 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.

interface NativePageReferencePressEvent

Data emitted when a page reference is pressed in the native proof editor.

icon

property
property icon

id

property
property id

text

property
property text

url

property
property url
interface NativeProofEditorProps

Native epoch/revision transport and proof editing events.

property accessibilityActions

Provides an array of custom actions available for accessibility.

property accessibilityElementsHidden

A Boolean value indicating whether the accessibility elements contained within this accessibility element are hidden to the screen reader.

property accessibilityHint

An 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.

property accessibilityLabel

Overrides 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.

property accessibilityLabelledBy

Identifies 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.

property accessibilityLanguage

By 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

property accessibilityLargeContentTitle

When accessibilityShowsLargeContentViewer is set, this string will be used as title for the large content viewer. https://reactnative.dev/docs/accessibility#accessibilitylargecontenttitle

property accessibilityLiveRegion

Indicates to accessibility services whether the user should be notified when this view changes. Works for Android API >= 19 only.

property accessibilityRespondsToUserInteraction

Blocks the user from interacting with the component through keyboard while still allowing screen reader to interact with it if this View is still accessible.

property accessibilityRole

Accessibility Role tells a person using either VoiceOver on iOS or TalkBack on Android the type of element that is focused on.

property accessibilityShowsLargeContentViewer

A 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

property accessibilityState

Accessibility State tells a person using either VoiceOver on iOS or TalkBack on Android the state of the element currently focused on.

property accessibilityValue

Represents 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).

property accessibilityViewIsModal

A Boolean value indicating whether VoiceOver should ignore the elements within views that are siblings of the receiver.

accessible

property
property accessible

When true, indicates that the view is an accessibility element. By default, all the touchable elements are accessible.

aria-busy

property
property aria-busy

aria-checked

property
property aria-checked
property aria-disabled
property aria-expanded

aria-hidden

property
property aria-hidden

A value indicating whether the accessibility elements contained within this accessibility element are hidden.

property aria-labelledby

Identifies 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

property
property aria-live

Indicates to accessibility services whether the user should be notified when this view changes. Works for Android API >= 19 only.

aria-modal

property
property aria-modal
property aria-selected
property aria-valuemax
property aria-valuemin
property aria-valuenow
property aria-valuetext

children

property
property children

collapsable

property
property collapsable

Views 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.

property collapsableChildren

Setting 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

property
property command

dark

property
property dark
property emptyTogglePlaceholder

Hint shown inside the empty child created for a toggle heading.

focusable

property
property focusable

Whether this View should be focusable with a non-touch input device, eg. receive focus with a hardware keyboard.

property hasTVPreferredFocus

(Apple TV only) May be set to true to force the Apple TV focus engine to move focus to this view.

hitSlop

property
property hitSlop

This 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.

id

property
property id

Used to reference react managed views from native code.

property imageMaxWidth

Maximum rendered width of image and video blocks, in logical pixels.

property importantForAccessibility

[Android] Controlling if a view fires accessibility events and if it is reported to accessibility services.

property isTVSelectable

(Apple TV only) When set to true, this view will be focusable and navigable using the Apple TV remote.

nativeID

property
property nativeID

Used to reference react managed views from native code.

property needsOffscreenAlphaCompositing

Whether 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.

property onAccessibilityAction

When accessible is true, the system will try to invoke this function when the user performs an accessibility custom action.

property onAccessibilityEscape

When accessible is true, the system will invoke this function when the user performs the escape gesture (scrub with two fingers).

property onAccessibilityTap

When accessible is true, the system will try to invoke this function when the user performs accessibility tap gesture.

property onBlockActionsPress

Fired when a block that opens the actions sheet (e.g. a divider) is tapped.

onBlur

property
property onBlur

Callback that is called when the view is blurred.

Note: This will only be called if the view is focusable.

property onContentSize

Fired 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

property
property onEdit

onFocus

property
property onFocus

Callback that is called when the view is focused.

Note: This will only be called if the view is focusable.

onLayout

property
property onLayout

Invoked on mount and layout changes with

{nativeEvent: { layout: {x, y, width, height}}}.

onMagicTap

property
property onMagicTap

When accessible is true, the system will invoke this function when the user performs the magic tap gesture.

property onMoveShouldSetResponder

Called for every touch move on the View when it is not the responder: does this view want to "claim" touch responsiveness?

property onMoveShouldSetResponderCapture

onStartShouldSetResponder 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.

property onPageReferencePress
property onPointerCancel
property onPointerCancelCapture
property onPointerDown
property onPointerDownCapture
property onPointerEnter
property onPointerEnterCapture
property onPointerLeave
property onPointerLeaveCapture
property onPointerMove
property onPointerMoveCapture

onPointerUp

property
property onPointerUp
property onPointerUpCapture
property onResponderEnd

If the View returns true and attempts to become the responder, one of the following will happen:

property onResponderGrant

The View is now responding for touch events. This is the time to highlight and show the user what is happening

property onResponderMove

The user is moving their finger

property onResponderReject

Something else is the responder right now and will not release it

property onResponderRelease

Fired at the end of the touch, ie "touchUp"

property onResponderStart
property onResponderTerminate

The 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)

property onResponderTerminationRequest

Something else wants to become responder. Should this view release the responder? Returning true allows release

property onStartShouldSetResponder

Does this view want to become responder on the start of a touch?

property onStartShouldSetResponderCapture

onStartShouldSetResponder 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.

property onTouchCancel

onTouchEnd

property
property onTouchEnd
property onTouchEndCapture

onTouchMove

property
property onTouchMove

onTouchStart

property
property onTouchStart
property pageReferenceFallbackIcon

Optional glyph used by the native proof view when a page has no fetched icon.

property pointerEvents

In 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.

property removeClippedSubviews

This 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).

property renderToHardwareTextureAndroid

Whether 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

property
property role

Indicates to accessibility services to treat UI component like a specific role.

property screenReaderFocusable

Enables the view to be screen reader focusable, not keyboard focusable.

property shouldRasterizeIOS

Whether 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

property
property snapshot

style

property
property style

tabIndex

property
property tabIndex

Indicates 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)

testID

property
property testID

Used to locate this view in end-to-end tests.

property 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.

property 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.

property 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.

property 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

interface
interface ProofBlock

A block in the milestone-one transport model. This is not the public Notion AST.

checked

property
property checked

Whether a to-do block is checked.

collapsed

property
property collapsed

Whether a toggle header's child content is collapsed in the editor.

color

property
property color

columnCount

property
property columnCount

Number of columns in a column_list block.

depth

property
property depth

Zero-based nesting depth used by the proof editor's structural actions.

duration

property
property duration

Optional media metadata retained for audio blocks.

fileName

property
property fileName

fileSize

property
property fileSize

icon

property
property icon

Optional icon: a page icon for link_to_page, or a callout's emoji.

id

property
property id

marks

property
property marks

Inline formatting ranges contained by this block's text.

mimeType

property
property mimeType

text

property
property text

toggle

property
property toggle

Whether a heading block is a collapsible toggle header.

type

property
property type

url

property
property url

URL opened when the page reference is tapped.

waveform

property
property waveform

ProofCommand

interface
interface ProofCommand

A uniquely identified command sent to the native editor coordinator.

action

property
property action

blockId

property
property blockId

Target 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.

color

property
property color

Block color for a "color" action. Omit (or clear) for the default color.

columnCount

property
property columnCount

Number of columns for a "columns" action. Defaults to 2 when omitted.

duration

property
property duration

Audio metadata for an insertAudio or replaceAudio action.

epoch

property
property epoch

fileName

property
property fileName

fileSize

property
property fileSize

id

property
property id

label

property
property label

Replacement label for a "link" action. Defaults to the selected text.

level

property
property level

Heading level for a "heading" action. Defaults to 1 when omitted.

mark

property
property mark

Inline formatting mark for a "format" action.

mimeType

property
property mimeType

toggle

property
property toggle

Whether a "heading" action inserts a toggle header.

type

property
property type

Block type for a "turnInto" action.

url

property
property url

URL for a "link" action.

waveform

property
property waveform

ProofEvent

interface
interface ProofEvent

A native editor event containing the latest document and selection state.

anchor

property
property anchor

blocks

property
property blocks

composingEnd

property
property composingEnd
property composingStart

epoch

property
property epoch

focus

property
property focus

revision

property
property revision

source

property
property source

ProofPoint

interface
interface ProofPoint

A UTF-16 selection point within a proof block.

blockId

property
property blockId

field

property
property field

offset

property
property offset

ProofSnapshot

interface
interface ProofSnapshot

A revisioned document snapshot exchanged with the native editor.

blocks

property
property blocks

epoch

property
property epoch

revision

property
property revision

ProofTextMark

interface
interface ProofTextMark

A UTF-16 range carrying one inline formatting mark.

end

property
property end

kind

property
property kind

start

property
property start

url

property
property url

Types

Action

type alias
type Action = unknown

Actions understood by the milestone-one native editor coordinator.

type ProofColumnCount = unknown

Supported column counts for a column_list block.

type ProofTextMarkKind = unknown

Boolean inline formatting marks supported by the proof editor's format sub-menu.

Variables

const 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.

const 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.

const acceptProofEvent: __type
const createProofDocument: __type
const NativeProofEditor: ComponentType

Android-only native coordinator. One shared buffer is intentional for this proof.

const NotionMarkdown: NotionMarkdownModule

The loaded native Notion Markdown module.