RTextButton#
A headless text button component.
This widget handles all button behavior (focus, keyboard, pointer input) but delegates visual rendering to a RButtonRenderer capability.
The renderer is obtained from HeadlessThemeProvider. If no renderer
is available, a MissingCapabilityException
is thrown with clear
instructions on how to fix it.
Controlled/Uncontrolled#
The button follows Flutter's standard patterns:
onPressed == nullordisabled == true→ button is disabled- Disabled state is reflected in semantics and prevents all interaction
Keyboard#
- Space: triggers onPressed on key up (standard button behavior)
- Enter: triggers onPressed immediately (activation)
Activation Source (v1 policy)#
The button has a single activation source: GestureDetector for pointer
and Focus.onKeyEvent for keyboard.
Accessibility activation is component-owned as well:
the widget exposes SemanticsAction.tap and maps it to onPressed.
Example#
RTextButton(
onPressed: () => print('Pressed!'),
child: Text('Click me'),
)
Constructors#
RTextButton() const#
Implementation
const RTextButton({
super.key,
required this.child,
this.onPressed,
this.disabled = false,
this.variant = RButtonVariant.outlined,
this.size = RButtonSize.medium,
this.style,
this.semanticLabel,
this.autofocus = false,
this.focusNode,
this.slots,
this.overrides,
});
Properties#
autofocus final#
Whether the button should be focused initially.
Implementation
final bool autofocus;
child final#
The button's content (typically a Text widget).
Implementation
final Widget child;
disabled final#
Whether the button is explicitly disabled.
When true, the button will not respond to input even if onPressed is provided.
Implementation
final bool disabled;
focusNode final#
Optional focus node for external focus management.
Implementation
final FocusNode? focusNode;
hashCode no setter inherited#
The hash code for this object.
A hash code is a single integer which represents the state of the object that affects operator == comparisons.
All objects have hash codes. The default hash code implemented by Object represents only the identity of the object, the same way as the default operator == implementation only considers objects equal if they are identical (see identityHashCode).
If operator == is overridden to use the object state instead, the hash code must also be changed to represent that state, otherwise the object cannot be used in hash based data structures like the default Set and Map implementations.
Hash codes must be the same for objects that are equal to each other according to operator ==. The hash code of an object should only change if the object changes in a way that affects equality. There are no further requirements for the hash codes. They need not be consistent between executions of the same program and there are no distribution guarantees.
Objects that are not equal are allowed to have the same hash code. It is even technically allowed that all instances have the same hash code, but if clashes happen too often, it may reduce the efficiency of hash-based data structures like HashSet or HashMap.
If a subclass overrides hashCode, it should override the operator == operator as well to maintain consistency.
Inherited from Object.
Implementation
external int get hashCode;
isDisabled no setter#
Whether the button is effectively disabled.
A button is disabled if disabled is true OR onPressed is null.
Implementation
bool get isDisabled => disabled || onPressed == null;
onPressed final#
Called when the button is activated.
If null, the button is considered disabled.
Implementation
final VoidCallback? onPressed;
overrides final#
Per-instance override bag for preset customization.
Allows "style on this specific button" without API pollution.
See docs/FLEXIBLE_PRESETS_AND_PER_INSTANCE_OVERRIDES.md.
Implementation
final RenderOverrides? overrides;
runtimeType no setter inherited#
A representation of the runtime type of the object.
Inherited from Object.
Implementation
external Type get runtimeType;
semanticLabel final#
Semantic label for accessibility.
If not provided, the button's child text content is used.
Implementation
final String? semanticLabel;
size final#
Size variant of the button.
Implementation
final RButtonSize size;
slots final#
Optional visual slots for partial customization.
Implementation
final RButtonSlots? slots;
style final#
Simple, Flutter-like styling sugar.
Internally converted to RenderOverrides.only(RButtonOverrides.tokens(...)).
If overrides
is provided, it takes precedence over this style.
Implementation
final RButtonStyle? style;
variant final#
Visual variant of the button.
Implementation
final RButtonVariant variant;
Methods#
createState()#
Implementation
@override
State<RTextButton> createState() => _RTextButtonState();
noSuchMethod() inherited#
Invoked when a nonexistent method or property is accessed.
A dynamic member invocation can attempt to call a member which doesn't exist on the receiving object. Example:
dynamic object = 1;
object.add(42); // Statically allowed, run-time error
This invalid code will invoke the noSuchMethod method
of the integer 1 with an Invocation
representing the
.add(42) call and arguments (which then throws).
Classes can override noSuchMethod to provide custom behavior for such invalid dynamic invocations.
A class with a non-default noSuchMethod invocation can also omit implementations for members of its interface. Example:
class MockList<T> implements List<T> {
noSuchMethod(Invocation invocation) {
log(invocation);
super.noSuchMethod(invocation); // Will throw.
}
}
void main() {
MockList().add(42);
}
This code has no compile-time warnings or errors even though
the MockList class has no concrete implementation of
any of the List interface methods.
Calls to List methods are forwarded to noSuchMethod,
so this code will log an invocation similar to
Invocation.method(#add, [42]) and then throw.
If a value is returned from noSuchMethod,
it becomes the result of the original invocation.
If the value is not of a type that can be returned by the original
invocation, a type error occurs at the invocation.
The default behavior is to throw a NoSuchMethodError.
Inherited from Object.
Implementation
@pragma("vm:entry-point")
@pragma("wasm:entry-point")
external dynamic noSuchMethod(Invocation invocation);
toString() inherited#
A string representation of this object.
Some classes have a default textual representation,
often paired with a static parse function (like int.parse).
These classes will provide the textual representation as
their string representation.
Other classes have no meaningful textual representation
that a program will care about.
Such classes will typically override toString to provide
useful information when inspecting the object,
mainly for debugging or logging.
Inherited from Object.
Implementation
external String toString();
Operators#
operator ==() inherited#
The equality operator.
The default behavior for all Objects is to return true if and
only if this object and other are the same object.
Override this method to specify a different equality relation on a class. The overriding method must still be an equivalence relation. That is, it must be:
Total: It must return a boolean for all arguments. It should never throw.
Reflexive: For all objects
o,o == omust be true.-
Symmetric: For all objects
o1ando2,o1 == o2ando2 == o1must either both be true, or both be false. -
Transitive: For all objects
o1,o2, ando3, ifo1 == o2ando2 == o3are true, theno1 == o3must be true.
The method should also be consistent over time, so whether two objects are equal should only change if at least one of the objects was modified.
If a subclass overrides the equality operator, it should override the hashCode method as well to maintain consistency.
Inherited from Object.
Implementation
external bool operator ==(Object other);