Button
Button from the Native package.
Runtime classification
No web preview is provided. Requires the React Native runtime and native primitives, which cannot execute inside the DOM documentation canvas.
Import
1•import { Button } from "@dotnaos/ui/native";
Properties
Public properties derived from the component’s TypeScript signature.
| Property | Type | Default |
|---|---|---|
disabledOptionalWhether the press behavior is disabled. | boolean | false |
labelRequired | string | — |
sizeOptional | "sm" | "md" | "lg" | "md" |
styleOptional | StyleProp<ViewStyle> | — |
variantOptional | "danger" | "primary" | "secondary" | "ghost" | "outline" | "primary" |
idOptionalUsed to reference react managed views from native code. | string | — |
tabIndexOptionalIndicates 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) | 0 | -1 | — |
roleOptionalIndicates to accessibility services to treat UI component like a specific role. | Role | — |
aria-busyOptionalalias for accessibilityState
see https://reactnative.dev/docs/accessibility#accessibilitystate | boolean | — |
aria-checkedOptional | false | true | "mixed" | — |
aria-disabledOptional | boolean | — |
aria-expandedOptional | boolean | — |
aria-hiddenOptionalA value indicating whether the accessibility elements contained within
this accessibility element are hidden. | boolean | — |
aria-labelOptionalAlias for accessibilityLabel https://reactnative.dev/docs/view#accessibilitylabel
https://github.com/facebook/react-native/issues/34424 | string | — |
aria-labelledbyOptionalIdentifies 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. | string | — |
aria-liveOptionalIndicates to accessibility services whether the user should be notified
when this view changes. Works for Android API >= 19 only. | "off" | "assertive" | "polite" | — |
aria-modalOptional | boolean | — |
aria-selectedOptional | boolean | — |
aria-valuemaxOptional | number | — |
aria-valueminOptional | number | — |
aria-valuenowOptional | number | — |
aria-valuetextOptional | string | — |
onFocusOptionalCalled after the element is focused. | ((event: NativeSyntheticEvent<TargetedEvent>) => void) | null | — |
onBlurOptionalCalled after the element loses focus. | ((event: NativeSyntheticEvent<TargetedEvent>) => void) | null | — |
onTouchCancelOptional | ((event: GestureResponderEvent) => void) | — |
onTouchEndOptional | ((event: GestureResponderEvent) => void) | — |
onTouchEndCaptureOptional | ((event: GestureResponderEvent) => void) | — |
onTouchMoveOptional | ((event: GestureResponderEvent) => void) | — |
onTouchStartOptional | ((event: GestureResponderEvent) => void) | — |
onPointerDownOptional | ((event: PointerEvent) => void) | — |
onPointerDownCaptureOptional | ((event: PointerEvent) => void) | — |
onPointerMoveOptional | ((event: PointerEvent) => void) | — |
onPointerMoveCaptureOptional | ((event: PointerEvent) => void) | — |
onPointerUpOptional | ((event: PointerEvent) => void) | — |
onPointerUpCaptureOptional | ((event: PointerEvent) => void) | — |
onPointerCancelOptional | ((event: PointerEvent) => void) | — |
onPointerCancelCaptureOptional | ((event: PointerEvent) => void) | — |
onPointerEnterOptional | ((event: PointerEvent) => void) | — |
onPointerLeaveOptional | ((event: PointerEvent) => void) | — |
accessibilityLabelOptionalOverrides 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. | string | — |
focusableOptionalWhether this `View` should be focusable with a non-touch input device, eg. receive focus with a hardware keyboard. | boolean | — |
pointerEventsOptionalIn 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. | "auto" | "none" | "box-none" | "box-only" | — |
onPressOptionalCalled when a single tap gesture is detected. | ((event: GestureResponderEvent) => void) | null | — |
hitSlopOptionalAdditional distance outside of this view in which a press is detected. | number | Insets | null | — |
needsOffscreenAlphaCompositingOptionalWhether 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. | boolean | — |
onLayoutOptionalInvoked on mount and layout changes with
{nativeEvent: { layout: {x, y, width, height}}}. | ((event: LayoutChangeEvent) => void) | — |
removeClippedSubviewsOptionalThis 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). | boolean | — |
testIDOptionalUsed to locate this view in end-to-end tests. | string | — |
nativeIDOptionalUsed to reference react managed views from native code. | string | — |
collapsableOptionalViews 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. | boolean | — |
collapsableChildrenOptionalSetting 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. | boolean | — |
renderToHardwareTextureAndroidOptionalWhether 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. | boolean | — |
shouldRasterizeIOSOptionalWhether 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. | boolean | — |
isTVSelectableOptional*(Apple TV only)* When set to true, this view will be focusable
and navigable using the Apple TV remote. | boolean | — |
hasTVPreferredFocusOptional*(Apple TV only)* May be set to true to force the Apple TV focus engine to move focus to this view. | boolean | — |
tvParallaxShiftDistanceXOptional*(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. | number | — |
tvParallaxShiftDistanceYOptional*(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. | number | — |
tvParallaxTiltAngleOptional*(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. | number | — |
tvParallaxMagnificationOptional*(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. | number | — |
onStartShouldSetResponderOptionalDoes this view want to become responder on the start of a touch? | ((event: GestureResponderEvent) => boolean) | — |
onMoveShouldSetResponderOptionalCalled for every touch move on the View when it is not the responder: does this view want to "claim" touch responsiveness? | ((event: GestureResponderEvent) => boolean) | — |
onResponderEndOptionalIf the View returns true and attempts to become the responder, one of the following will happen: | ((event: GestureResponderEvent) => void) | — |
onResponderGrantOptionalThe View is now responding for touch events.
This is the time to highlight and show the user what is happening | ((event: GestureResponderEvent) => void) | — |
onResponderRejectOptionalSomething else is the responder right now and will not release it | ((event: GestureResponderEvent) => void) | — |
onResponderMoveOptionalThe user is moving their finger | ((event: GestureResponderEvent) => void) | — |
onResponderReleaseOptionalFired at the end of the touch, ie "touchUp" | ((event: GestureResponderEvent) => void) | — |
onResponderStartOptional | ((event: GestureResponderEvent) => void) | — |
onResponderTerminationRequestOptionalSomething else wants to become responder.
Should this view release the responder? Returning true allows release | ((event: GestureResponderEvent) => boolean) | — |
onResponderTerminateOptionalThe 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) | ((event: GestureResponderEvent) => void) | — |
onStartShouldSetResponderCaptureOptionalonStartShouldSetResponder 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. | ((event: GestureResponderEvent) => boolean) | — |
onMoveShouldSetResponderCaptureOptionalonStartShouldSetResponder 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. | ((event: GestureResponderEvent) => boolean) | — |
onPointerEnterCaptureOptional | ((event: PointerEvent) => void) | — |
onPointerLeaveCaptureOptional | ((event: PointerEvent) => void) | — |
accessibleOptionalWhen true, indicates that the view is an accessibility element.
By default, all the touchable elements are accessible. | boolean | — |
accessibilityActionsOptionalProvides an array of custom actions available for accessibility. | readonly Readonly<{ name: AccessibilityActionName | string; label?: string | undefined; }>[] | — |
accessibilityRoleOptionalAccessibility Role tells a person using either VoiceOver on iOS or TalkBack on Android the type of element that is focused on. | AccessibilityRole | — |
accessibilityStateOptionalAccessibility State tells a person using either VoiceOver on iOS or TalkBack on Android the state of the element currently focused on. | AccessibilityState | — |
accessibilityHintOptionalAn 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. | string | — |
accessibilityValueOptionalRepresents 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). | AccessibilityValue | — |
onAccessibilityActionOptionalWhen `accessible` is true, the system will try to invoke this function when the user performs an accessibility custom action. | ((event: AccessibilityActionEvent) => void) | — |
importantForAccessibilityOptional[Android] Controlling if a view fires accessibility events and if it is reported to accessibility services. | "auto" | "yes" | "no" | "no-hide-descendants" | — |
accessibilityLabelledByOptionalIdentifies 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. | string | string[] | — |
accessibilityLiveRegionOptionalIndicates to accessibility services whether the user should be notified
when this view changes. Works for Android API >= 19 only. | "none" | "assertive" | "polite" | — |
screenReaderFocusableOptionalEnables the view to be screen reader focusable, not keyboard focusable. | boolean | — |
accessibilityElementsHiddenOptionalA Boolean value indicating whether the accessibility elements contained within this accessibility element
are hidden to the screen reader. | boolean | — |
accessibilityViewIsModalOptionalA Boolean value indicating whether VoiceOver should ignore the elements within views that are siblings of the receiver. | boolean | — |
onAccessibilityEscapeOptionalWhen accessible is true, the system will invoke this function when the user performs the escape gesture (scrub with two fingers). | (() => void) | — |
onAccessibilityTapOptionalWhen `accessible` is true, the system will try to invoke this function when the user performs accessibility tap gesture. | (() => void) | — |
onMagicTapOptionalWhen accessible is true, the system will invoke this function when the user performs the magic tap gesture. | (() => void) | — |
accessibilityIgnoresInvertColorsOptionalhttps://reactnative.dev/docs/accessibility#accessibilityignoresinvertcolorsios | boolean | — |
accessibilityLanguageOptionalBy 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 | string | — |
accessibilityShowsLargeContentViewerOptionalA 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 | boolean | — |
accessibilityLargeContentTitleOptionalWhen `accessibilityShowsLargeContentViewer` is set, this string will be used as title for the large content viewer.
https://reactnative.dev/docs/accessibility#accessibilitylargecontenttitle | string | — |
accessibilityRespondsToUserInteractionOptionalBlocks the user from interacting with the component through keyboard while still allowing
screen reader to interact with it if this View is still accessible. | boolean | — |
onHoverInOptionalCalled when the hover is activated to provide visual feedback. | ((event: MouseEvent) => void) | null | — |
onHoverOutOptionalCalled when the hover is deactivated to undo visual feedback. | ((event: MouseEvent) => void) | null | — |
onPressInOptionalCalled when a touch is engaged before `onPress`. | ((event: GestureResponderEvent) => void) | null | — |
onPressMoveOptionalCalled when the press location moves. | ((event: GestureResponderEvent) => void) | null | — |
onPressOutOptionalCalled when a touch is released before `onPress`. | ((event: GestureResponderEvent) => void) | null | — |
onLongPressOptionalCalled when a long-tap gesture is detected. | ((event: GestureResponderEvent) => void) | null | — |
cancelableOptionalWhether a press gesture can be interrupted by a parent gesture such as a
scroll event. Defaults to true. | boolean | null | — |
delayHoverInOptionalDuration to wait after hover in before calling `onHoverIn`. | number | null | — |
delayHoverOutOptionalDuration to wait after hover out before calling `onHoverOut`. | number | null | — |
delayLongPressOptionalDuration (in milliseconds) from `onPressIn` before `onLongPress` is called. | number | null | — |
pressRetentionOffsetOptionalAdditional distance outside of this view in which a touch is considered a
press before `onPressOut` is triggered. | number | Insets | null | — |
android_disableSoundOptionalIf true, doesn't play system sound on touch. | boolean | null | — |
android_rippleOptionalEnables the Android ripple effect and configures its color. | PressableAndroidRippleConfig | null | — |
testOnly_pressedOptionalUsed only for documentation or testing (e.g. snapshot testing). | boolean | null | — |
unstable_pressDelayOptionalDuration (in milliseconds) to wait after press down before calling onPressIn. | number | — |