ShadPagination class

A page navigator.

Mirrors shadcn/ui's Pagination: previous/next buttons around a windowed run of page numbers, with an ellipsis standing in for the pages that were skipped.

ShadPagination(
  page: page,
  pageCount: 20,
  onPageChanged: (p) => setState(() => page = p),
)

page is 1-based, matching how page numbers are shown to users.

Inheritance

Available extensions

Constructors

ShadPagination({Key? key, required int page, required int pageCount, ValueChanged<int>? onPageChanged, int? siblingCount, int? boundaryCount, bool? showEdges, double? gap, MainAxisAlignment? mainAxisAlignment, MainAxisSize mainAxisSize = MainAxisSize.min, Widget? previousLabel, Widget? nextLabel, TextStyle? ellipsisTextStyle, bool enabled = true}): A page navigator.
const

Properties

boundaryCount → int?: How many pages to always show at each end, defaults to 1.
final
ellipsisTextStyle → TextStyle?: The style of the ellipsis between page runs.
final
enabled → bool: Whether the pagination responds to input.
final
gap → double?: The gap between items.
final
hashCode → int: The hash code for this object.
no setterinherited
key → Key?: Controls how one widget replaces another widget in the tree.
finalinherited
mainAxisAlignment → MainAxisAlignment?: How the row of items is aligned.
final
mainAxisSize → MainAxisSize: final
nextLabel → Widget?: Overrides the localized "Next" label.
final
onPageChanged → ValueChanged<int>?: Called with the new page when the user navigates.
final
page → int: The current page, 1-based.
final
pageCount → int: The total number of pages.
final
previousLabel → Widget?: Overrides the localized "Previous" label.
final
runtimeType → Type: A representation of the runtime type of the object.
no setterinherited
showEdges → bool?: Whether to show the previous/next buttons, defaults to true.
final
siblingCount → int?: How many pages to show either side of the current one, defaults to 1.
final

Methods

animate({Key? key, List<Effect>? effects, AnimateCallback? onInit, AnimateCallback? onPlay, AnimateCallback? onComplete, bool? autoPlay, Duration? delay, AnimationController? controller, Adapter? adapter, double? target, double? value}) → Animate: Available on Widget, provided by the AnimateWidgetExtensions extension
Wraps the target Widget in an Animate instance, and returns the instance for chaining calls. Ex. myWidget.animate() is equivalent to Animate(child: myWidget).
build(BuildContext context) → Widget: Describes the part of the user interface represented by this widget.
override
createElement() → StatelessElement: Creates a StatelessElement to manage this widget's location in the tree.
inherited
debugDescribeChildren() → List<DiagnosticsNode>: Returns a list of DiagnosticsNode objects describing this node's children.
inherited
debugFillProperties(DiagnosticPropertiesBuilder properties) → void: Add additional properties associated with the node.
inherited
noSuchMethod(Invocation invocation) → dynamic: Invoked when a nonexistent method or property is accessed.
inherited
positionedWith(ShadPosition position) → Widget: Available on Widget, provided by the PositionedExt extension
toDiagnosticsNode({String? name, DiagnosticsTreeStyle? style}) → DiagnosticsNode: Returns a debug representation of the object that is used by debugging tools and by DiagnosticsNode.toStringDeep.
inherited
toString({DiagnosticLevel minLevel = DiagnosticLevel.info}) → String: A string representation of this object.
inherited
toStringDeep({String prefixLineOne = '', String? prefixOtherLines, DiagnosticLevel minLevel = DiagnosticLevel.debug, int wrapWidth = 65}) → String: Returns a string representation of this node and its descendants.
inherited
toStringShallow({String joiner = ', ', DiagnosticLevel minLevel = DiagnosticLevel.debug}) → String: Returns a one-line detailed description of the object.
inherited
toStringShort() → String: A short, textual description of this widget.
inherited

Operators

operator ==(Object other) → bool: The equality operator.
inherited

Static Methods

buildPageWindow({required int page, required int pageCount, int siblingCount = 1, int boundaryCount = 1}) → List<int?>: Computes which page numbers to render, inserting nulls where a run of pages was skipped.